Config editor

The config editor is the primary way to view and edit a device’s configuration files. To edit a device’s configurations, you must hold the role. Open the editor by clicking into a device from the Devices page and selecting the Editor tab at the top.

​

Layout

The editor has three resizable panels:

• Config panel: the device’s config files. Each file shows how many changes it has, or its errors in red.
• Code editor: the open files, as tabs. Hover over a tab and click the x (×) to close it.
• Draft and History: your pending changes and past deployments, described below.

---

​

Draft

When the Draft tab is selected, the editor enters edit mode. You can modify any configuration file directly in the editor. Changes are tracked locally until you deploy them. A draft is automatically created when you open the editor. If the device has existing deployments, the draft is based on the most recent one. If this is a new device with no deployments, the draft is initialized from the release’s default configuration.

​

Change list

The Draft panel lists your pending changes:

• Errors: syntax and schema errors, described in Validation. Click one to jump to it.
• Changes: each value you added, modified, or deleted, with its old and new values. Click a change to jump to it, or hover over it and click the undo icon to discard it.
• Removed: slots you removed from the draft.

The icons next to Changes hide the old and new values and discard every change.

​

Instance slots

A config type with several instance slots shows as a folder in the config panel, with one file per slot. A device’s first draft includes only its required slots. To add an optional slot, hover over the folder, click the plus (+), and pick the slot. To remove one, right-click its file and hit Remove file; hit Restore file to bring it back. Removed slots are listed under Removed and aren’t deployed.

​

Validation

As you type, Miru checks each file’s syntax and validates JSON and YAML files against their schema. Errors are underlined in the file and listed under Errors.

​

Deploying changes

Click the Deploy button to start the deployment process.

---

​

History

When the History tab is selected, the editor switches to read-only mode and displays past deployments.

​

Deployment list

The History tab lists all deployments grouped by release version. Within each group, deployments are listed from most recent to oldest with each entry showing:

• Description
• Deployment status and ID
• Who created it and when

Click a deployment to view it’s contents. The selected deployment is called the head deployment, and its configuration files are loaded into the editor. The head deployment is highlighted with a solid left border and a subtle background. When a base deployment is selected for diffing, it is indicated with a dashed left border. Right-click a deployment to open a context menu with options to:

• Redeploy — Restore an archived deployment (see Redeploy).
• Set as diff base — Use this deployment as the comparison baseline.
• Copy short ID, Copy full ID, or Copy description.

​

Diff and read-only modes

In the History tab, the editor supports two view modes:

• Read-only — Displays the head deployment’s files without any diff highlighting.
• Diff — Highlights the differences between the head and base deployments using color-coded decorations:
  • Green — Added lines.
  • Yellow — Modified lines, showing the old and new values.
  • Red — Deleted lines, showing the removed content. content.

​

Diff navigation

When viewing a diff, navigation controls appear as a floating overlay above the footer:

• Change navigation — Step through individual changes within the current file using the previous/next buttons. A position label (e.g., “1 of 3”) tracks your place. Open the changes dropdown to see all changes listed by type and JSON path, and jump to any one directly.
• File navigation — When multiple files contain changes, use the file navigation controls to jump between them. A label (e.g., “1 of 3 files”) shows your position.

The currently focused change is highlighted with a flash animation.

​

Base vs. Head

The diff view compares two deployments:

• Base — The older deployment used as the comparison starting point. Defaults to the deployment immediately before the head. You can change it using the diff selector in the toolbar or by right-clicking a deployment and selecting “Set as diff base.” Only deployments older than the head are available as a base.
• Head — The currently selected deployment. Shown as a read-only label in the diff selector.

​

Redeploy

You can redeploy the configurations from any archived deployment. Right-click the deployment in the history list and select Redeploy to open the redeploy dialog. The redeploy dialog shows:

• A card with the original deployment’s details (description, status, ID, creator, and date).
• A description field (pre-filled with a reference to the original deployment).

---

​

Deployment alert

If another user (or system) deploys to the same device while you have the editor open, a New deployment detected alert appears with the new deployment’s details. The only option is Acknowledge, which loads the new deployment into the editor. If you have unsaved edits, acknowledging discards them.

---

​

Editor settings

Three admin-only workspace settings control how the editor behaves.

• Allow offline deployments (off by default) — Allow deployments to devices that are currently offline. When off, the Deploy button is disabled on offline devices.
• Skip deploy confirmation (off by default) — Remove the device-name confirmation step from the deploy dialog. When off, you must type the device name to confirm each deployment.
• Format files on deploy (on by default) — Automatically format config files before each deployment.

Formatting fires when the deploy dialog opens. With this setting off, you can still format any open file manually from the editor’s overflow menu (⋯) — click Format file or press ⌘⇧F (Mac) / Ctrl+Shift+F (Windows/Linux).