Skip to content

CLI Commands

Full command reference for the defined CLI, autogenerated from source.

defined

Defined Robotics platform — unified mission control.

Run with no subcommand to launch the interactive TUI.

Usage:

defined [OPTIONS] COMMAND [ARGS]...

Options:

  --version          Show the version and exit.
  --verbose          Show detailed error output.
  --target [sim|hw]  Backend target.
  --host TEXT        Rosbridge host.
  --port INTEGER     Rosbridge port.
  --rdf PATH         Robot RDF YAML.
  --manifest PATH    Path to defined.yaml.
  --help             Show this message and exit.

defined check

Check simulation readiness — verify expected topics are publishing.

Usage:

defined check [OPTIONS]

Options:

  --host TEXT      Rosbridge host.
  --port INTEGER   Rosbridge port.
  --rdf PATH       Robot RDF YAML.
  --task PATH      Task YAML (to derive expected topics).
  --timeout FLOAT  Per-topic timeout in seconds.
  --help           Show this message and exit.

defined compile

Compile a task YAML to BT XML without running it.

Usage:

defined compile [OPTIONS] TASK

Options:

  --rdf PATH         Robot RDF YAML.  [required]
  -o, --output PATH  Output XML path.
  --verbs-dir PATH   Verb templates dir.
  --help             Show this message and exit.

defined world

Manage the world model (Points of Interest, map data).

Usage:

defined world [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.
defined world add

Add or update a Point of Interest.

Usage:

defined world add [OPTIONS] NAME X Y

Options:

  --type [static|constant|dynamic]
                                  [default: static]
  --radius FLOAT                  [default: 0.5]
  --help                          Show this message and exit.
defined world list

List all defined Points of Interest.

Usage:

defined world list [OPTIONS]

Options:

  --help  Show this message and exit.
defined world mark

Mark the robot's current position as a named POI.

Usage:

defined world mark [OPTIONS] NAME

Options:

  --type [static|constant]  [default: static]
  --radius FLOAT            [default: 0.5]
  --host TEXT
  --port INTEGER
  --help                    Show this message and exit.
defined world watch

Watch for map clicks and save as POIs.

Usage:

defined world watch [OPTIONS]

Options:

  --type [static|constant]  [default: static]
  --radius FLOAT            [default: 0.5]
  --host TEXT
  --port INTEGER
  --help                    Show this message and exit.