Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt

Use this file to discover all available pages before exploring further.

A config instance, also known as a config or an instance, is a set of parameters used to modify the behavior of code. Config instances are stored as text files (JSON or YAML), which applications parse into a structured format for consumption.

​
Properties

​
content
object
The configuration values that are deployed to the device as a JSON or YAML file.
​
file path
string
The absolute file system path where the config instance is written on the device.Examples: /srv/miru/configs/v1/motion-control.json, /srv/miru/configs/safety.yaml
​
config schema
Config Schema
The config schema that the config instance must adhere to.Example: SCH-FmoDN

​
File formats

Currently, config instances support JSON and YAML. However, support for more formats, including XML, is coming soon! Config instances support JSON and YAML. The Miru Agent parses both formats at deploy time and exposes the resulting data to on-device applications in the same way, so you can pick whichever format fits your workflow.
YAML support requires Miru Agent v0.7.0 or newer
Last modified on April 30, 2026