Validate

Validate a local config instance file against a persisted config schema.

API key scopes

If validating from a CI pipeline, the following API key scope is required when selecting a schema by ID:

config_schemas:read

When selecting a schema with --release and --config-type, the following API key scopes are required:

config_schemas:read
releases:read

Usage

Schema ID
Release and config type

miru config validate {file} \
  --schema-id {config-schema-id}

miru config validate {file} \
  --release {release-version} \
  --config-type {config-type}

Use sudo miru ... to read config files from restricted paths.

Arguments

string

required

Local config instance file to validate.Examples: ./robot.json, ./configs/mobility.json

Flags

string

Full config schema ID to validate against. Dashboard short IDs are not accepted.Mutually exclusive with --release and --config-type.Examples: cfg_sch_7xKqW1mZ3nBvTgL5cRs9dYuP

string

Release version used to find the config schema for --config-type.Required when --config-type is provided. Mutually exclusive with --schema-id.Examples: v1.2.0

string

Config type slug or name within the selected release.Required when --release is provided. Mutually exclusive with --schema-id.Examples: motion-control, Motion Control

Examples

$ miru config validate ./robot.json \
  --schema-id cfg_sch_7xKqW1mZ3nBvTgL5cRs9dYuP

✓ Config Valid

$ miru config validate ./robot.json \
  --release v1.2.0 \
  --config-type motion-control

✓ Config Valid

Authentication

Schemas

Configs

Releases

Devices

Deployments

Utilities

API key scopes

Usage

Examples

​API key scopes

​Usage

​Examples

API key scopes

Usage

Examples