Clone

Write the config files of a device’s current deployment onto the local file system.

API key scopes

If cloning from a CI pipeline, the following API key scopes are required:

devices:read
deployments:read
config_instances:read
releases:read

Usage

Current directory
Custom root
Device paths

By default, cloning a device writes the config files to the current directory.

miru device clone {device-name}

Use the --root flag to write the config files to a custom root directory.

miru device clone {device-name} --root ./robot-42-fs

Use --root / to write config files to the exact location they are written to on production devices.

miru device clone {device-name} --root /

Use sudo miru ... to write config files to restricted paths.

Arguments

string

required

Device name as the dashboard shows it. Names are unique within a workspace.The device must have a current deployment. To clone a deployment that is not the current one, use miru deployment clone.Examples: robot-42

Flags

string

Directory to write the cloned config files under. Defaults to the current directory.Each file is written at its device path relative to this directory, so /srv/miru/configs/mobility.json lands at {--root}/srv/miru/configs/mobility.json. Pass / to write at the computer’s root.Examples: ./robot-42-fs, /

boolean

Overwrite files that already exist at the destination. Without --force, an existing file throws an error and is left untouched.

Examples

$ miru device clone robot-42

◐ Cloning device robot-42

  /home/you
  └── srv/miru/configs
      ├── mobility.json  Mobility
      └── planning.json  Planning

✓ Clone successful
  Deployment  DPL-C64Ve · deployed
  Device      robot-42
  Release     v1.2.0
  Files       2

Authentication

Schemas

Releases

Devices

Deployments

Utilities

API key scopes

Usage

Examples

​API key scopes

​Usage

​Examples

API key scopes

Usage

Examples