RemotiveCLI - 0.27.x
remotive
Welcome to RemotiveLabs CLI - work with the RemotiveLabs platform from your terminal
For documentation - https://docs.remotivelabs.com
Usage:
$ remotive [OPTIONS] [COMMAND] [ARGS]...
Options:
--version: Print current version--verbose: Enable verbose logging to stderr for troubleshooting [env var: REMOTIVE_VERBOSE]--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
studio: Start a RemotiveStudio instancedoctor: [EXPERIMENTAL] Verify that host system is ok, required components are installed and that authentication is setup.topology: Interact and manage RemotiveTopology resourcesbroker: Manage a single broker - local or cloudcloud: Manage resources in RemotiveCloudconnect: Integrations with other systemstools: CLI tools unrelated to cloud or brokermcp-server: MCP server for topology designed to be used with cursor, vscode, intellij etc.
remotive studio
Start a RemotiveStudio instance
Usage:
$ remotive studio [OPTIONS] [WORKSPACE_PATH]
Arguments:
[WORKSPACE_PATH]: Workspace path
Options:
--topology-image TEXT: Optional docker image for RemotiveTopology [env var: REMOTIVE_TOPOLOGY_IMAGE]--container-engine [docker|podman]: Specify container engine [env var: REMOTIVE_CONTAINER_ENGINE; default: docker]--container-registry TEXT: Container registry prefix, e.g. my-mirror.example.com [env var: REMOTIVE_CONTAINER_REGISTRY]--force / --no-force: Override existing RemotiveTopology workspace if it exists [default: no-force]--broker-url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]--advertised-broker-url TEXT: Broker URL advertised to Studio clients (defaults to --broker-url). Use when clients reach the broker through a tunnel or forwarded port--host TEXT: Host to run RemotiveStudio [default: 127.0.0.1]--port TEXT: Port to run RemotiveStudio, or "auto" to use a free port assigned by the OS [default: 57123]--browser / --no-browser: Open RemotiveStudio in a web browser (ignored when --desktop is set) [default: browser]--desktop / --no-desktop: [Beta] Launch the RemotiveStudio desktop app instead of serving in a browser [default: no-desktop]--desktop-version TEXT: [Beta] Desktop version (e.g. 1.2.3) to install and launch (default: latest). Requires --desktop--log-level TEXT: Log level for RemotiveStudio server [default: warning]--help: Show this message and exit.
remotive doctor
[EXPERIMENTAL] Verify that host system is ok, required components are installed and that authentication is setup.
Usage:
$ remotive doctor [OPTIONS]
Options:
--help: Show this message and exit.
remotive topology
Interact and manage RemotiveTopology resources
Read more at https://docs.remotivelabs.com/docs/remotive-topology
Usage:
$ remotive topology [OPTIONS] [COMMAND] [ARGS]...
Options:
--topology-image TEXT: Optional docker image for RemotiveTopology [env var: REMOTIVE_TOPOLOGY_IMAGE]--topology-workspace TEXT: Optional override for workspace path [env var: REMOTIVE_TOPOLOGY_WORKSPACE]--container-engine [docker|podman]: Specify container engine [env var: REMOTIVE_CONTAINER_ENGINE; default: docker]--container-registry TEXT: Container registry prefix, e.g. my-mirror.example.com [env var: REMOTIVE_CONTAINER_REGISTRY]--help: Show this message and exit.
Commands:
build: Build a topology environment from instance descriptionsclean: Remove the build and mappings output for the current workspacecli: Run any RemotiveTopology CLI command.convert: [EXPERIMENTAL] Convert signal database to different format.gateway-mapping: [EXPERIMENTAL] List gateway mapping for ECUgenerate: [DEPRECATED] Use 'build' instead.prune: Remove cache and build output (workspace-scoped if inside one; --all for every workspace)recording-session: Work with recording sessionsshow: Show information from database filesplit: [DEPRECATED] Extract individual signal databases for each channel in a RemotiveTopology platform.start-trial: Allows you ta start a 30 day trial subscription for running RemotiveTopology.subscription: Manage RemotiveTopology subscriptions, you can start a trial subscription or check the status of your subscription.validate: [EXPERIMENTAL] Validate fileversion: Show RemotiveTopology CLI version.workspace: Manage RemotiveTopology workspaces
remotive topology build
Build a topology environment from instance descriptions
Usage:
$ remotive topology build [OPTIONS] [TOPOLOGY_OUTPUT_PATH]
Arguments:
[TOPOLOGY_OUTPUT_PATH]: Path to where generated files should be written. Optional in a workspace (defaults to <workspace>/.remotive/build, must be inside the workspace); required with --no-workspace.
Options:
--with-metrics: Enable Prometheus + Grafana metrics in the generated topology--no-workspace: Skip the REMOTIVE_TOPOLOGY_WORKSPACE check (disables caching for this run)-n, --name TEXT: Name of the generated topology-f, --file TEXT: RemotiveTopology .instance.yaml file(s), applied in the order they are provided [required]--help: Show this message and exit.
remotive topology clean
Remove the build and mappings output for the current workspace
Usage:
$ remotive topology clean [OPTIONS]
Options:
--help: Show this message and exit.
remotive topology cli
Run any RemotiveTopology CLI command.
Usage:
$ remotive topology cli [OPTIONS] [ARGS]...
Arguments:
[ARGS]...
Options:
--help: Show this message and exit.
remotive topology convert
[EXPERIMENTAL] Convert signal database to different format. Currently only CAN and LIN frames is supported.
Usage:
$ remotive topology convert [OPTIONS]
Options:
-f, --file TEXT: RemotiveTopology platform file [required]-o, --output TEXT: Optional path to a file where generated signal database should be written. If not provided, the result will be printed to stdout.--format TEXT: Format to convert to. Currently only 'remotive' is supported.-c, --channel TEXT: Optional channel(s) to convert. If not provided, all supported channels will be converted.--help: Show this message and exit.
remotive topology gateway-mapping
[EXPERIMENTAL] List gateway mapping for ECU
Usage:
$ remotive topology gateway-mapping [OPTIONS] [OUT_PATH]
Arguments:
[OUT_PATH]: Path to file where extracted gateway mapping should be written. Optional in a workspace (defaults to <workspace>/.remotive/mappings/<gateway-ecu>.mapping.yaml, must be inside the workspace); required with --no-workspace.
Options:
-o, --only-fully-resolved: Only show fully resolved mapping--no-workspace: Skip the REMOTIVE_TOPOLOGY_WORKSPACE check (paths may point anywhere)-g, --gateway-ecu TEXT: Gateway ECU name [required]-p, --platform TEXT: Topology platform [required]--format TEXT: Mapping format to emit: 'legacy' (default) or 'remotive-topology-mapping'--help: Show this message and exit.