Skip to main content

RemotiveCLI - 0.8.x

remotive

Welcome to RemotiveLabs CLI - Simplify and automate tasks for cloud resources and brokers

For documentation - https://docs.remotivelabs.com

Usage:

$ remotive [OPTIONS] COMMAND [ARGS]...

Options:

  • --version: Print current version
  • --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:

  • tui: Explore remotive-cli and generate commands...
  • topology: Interact and manage RemotiveTopology...
  • broker: Manage a single broker - local or cloud
  • cloud: Manage resources in RemotiveCloud
  • connect: Integrations with other systems
  • tools: CLI tools unrelated to cloud or broker

remotive tui​

Explore remotive-cli and generate commands with this textual user interface application

Usage:

$ remotive tui [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: CONTAINER_ENGINE; default: docker]
  • --help: Show this message and exit.

Commands:

  • start-trial: Allows you ta start a 30 day trial...
  • cli: Run any RemotiveTopology CLI command.
  • version: Show RemotiveTopology CLI version.
  • generate: Generate topology environment based on...
  • split: [DEPRECATED] Extract individual signal...
  • convert: [EXPERIMENTAL] Convert signal database to...
  • validate: [EXPERIMENTAL] Validate file
  • gateway-mapping: [EXPERIMENTAL] List gateway mapping for ECU
  • subscription: Manage RemotiveTopology subscriptions, you...
  • workspace: Manage RemotiveTopology workspaces
  • show: Show information from database file
  • recording-session: Work with recording sessions

remotive topology start-trial​

Allows you ta start a 30 day trial subscription for running RemotiveTopology.

You can read more at https://docs.remotivelabs.com/docs/remotive-topology.

Usage:

$ remotive topology start-trial [OPTIONS]

Options:

  • --organization TEXT: Organization to start trial for [env var: REMOTIVE_CLOUD_ORGANIZATION]
  • --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 version​

Show RemotiveTopology CLI version.

Usage:

$ remotive topology version [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive topology generate​

Generate topology environment based on instance descriptions

Usage:

$ remotive topology generate [OPTIONS] TOPOLOGY_OUTPUT_PATH

Arguments:

  • TOPOLOGY_OUTPUT_PATH: Path to where generated files should be written [required]

Options:

  • -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 split​

[DEPRECATED] Extract individual signal databases for each channel in a RemotiveTopology platform.

Usage:

$ remotive topology split [OPTIONS] TOPOLOGY_OUTPUT_PATH

Arguments:

  • TOPOLOGY_OUTPUT_PATH: Path to a folder where generated signal databases should be written [required]

Options:

  • -f, --file TEXT: RemotiveTopology platform file(s), applied in the order they are provided [required]
  • --help: Show this message and exit.

remotive topology convert​

[EXPERIMENTAL] Convert signal database to different format. Currently only CAN 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 CAN channels will be converted. [required]
  • --help: Show this message and exit.

remotive topology validate​

[EXPERIMENTAL] Validate file

Usage:

$ remotive topology validate [OPTIONS] PATH

Arguments:

  • PATH: Path to the Database file, supported extensions: extensions: '.arxml' [required]

Options:

  • --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 [required]

Options:

  • -o, --only-fully-resolved: Only show fully resolved mapping
  • -g, --gateway-ecu TEXT: Gateway ECU name [required]
  • -p, --platform TEXT: Topology platform [required]
  • --help: Show this message and exit.

remotive topology subscription​

Manage RemotiveTopology subscriptions, you can start a trial subscription or check the status of your subscription.

To extend a trial subscription, or purchase a subscription, please contact support@remotivelabs.com.

Usage:

$ remotive topology subscription [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • start-trial: Allows you to start a 30 day trial...
  • status: Show the current RemotiveTopology...

remotive topology subscription start-trial​

Allows you to start a 30 day trial subscription for running RemotiveTopology.

You can read more at https://docs.remotivelabs.com/docs/remotive-topology.

Usage:

$ remotive topology subscription start-trial [OPTIONS]

Options:

  • --organization TEXT: Organization to start trial for [env var: REMOTIVE_CLOUD_ORGANIZATION]
  • --help: Show this message and exit.

remotive topology subscription status​

Show the current RemotiveTopology subscription status for an organization.

Usage:

$ remotive topology subscription status [OPTIONS]

Options:

  • --organization TEXT: Organization to check subscription status for [env var: REMOTIVE_CLOUD_ORGANIZATION]
  • --help: Show this message and exit.

remotive topology workspace​

Manage RemotiveTopology workspaces

Usage:

$ remotive topology workspace [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • init: Initialize a RemotiveTopology workspace in...
  • current: Show the current RemotiveTopology workspace

remotive topology workspace init​

Initialize a RemotiveTopology workspace in the current directory

Usage:

$ remotive topology workspace init [OPTIONS]

Options:

  • --force / --no-force: Override existing RemotiveTopology workspace if it exists [default: no-force]
  • --help: Show this message and exit.

remotive topology workspace current​

Show the current RemotiveTopology workspace

Usage:

$ remotive topology workspace current [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive topology show​

Show information from database file

Usage:

$ remotive topology show [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • signals: [EXPERIMENTAL] Show signals in the...
  • constants: [EXPERIMENTAL] Extract constants from...
  • instance: Shows the resolved instance
  • platform: Shows the platform from database, platform...
  • ethernet: [EXPERIMENTAL] Shows Ethernet...
  • services: [EXPERIMENTAL] Show SOME/IP services from...

remotive topology show signals​

[EXPERIMENTAL] Show signals in the provided database file

Usage:

$ remotive topology show signals [OPTIONS] PATH [OUT_PATH]

Arguments:

  • PATH: Path to the Database file, supported extensions: extensions: '.arxml', '.dbc', '.xml', '.ldf', '.signaldb.yaml' [required]
  • [OUT_PATH]: Write content to provided file path

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • --jsonl: Output results in JSONL format
  • --bf: Output results in broker format
  • --help: Show this message and exit.

remotive topology show constants​

[EXPERIMENTAL] Extract constants from database file

Usage:

$ remotive topology show constants [OPTIONS] PATH

Arguments:

  • PATH: Path to the Database file, supported extensions: extensions: '.arxml' [required]

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • --help: Show this message and exit.

remotive topology show instance​

Shows the resolved instance

Usage:

$ remotive topology show instance [OPTIONS] PATH

Arguments:

  • PATH: Path to the Database file, supported extensions: extensions: '.instance.yaml' [required]

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • --check: Check topology
  • --full-platform: Show full platform, not just the instance-specific parts
  • --verbose: Show verbose output
  • -o, --out-path TEXT: Write content to provided file path
  • --help: Show this message and exit.

remotive topology show platform​

Shows the platform from database, platform or instance file

Usage:

$ remotive topology show platform [OPTIONS] PATH

Arguments:

  • PATH: Path to the Database file, supported extensions: extensions: '.arxml', '.xml', '.instance.yaml', '.platform.yaml', '.dbc', '.ldf', '.signaldb.yaml' [required]

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • --verbose: Show verbose output
  • -o, --out-path TEXT: Write content to provided file path
  • --help: Show this message and exit.

remotive topology show ethernet​

[EXPERIMENTAL] Shows Ethernet configuration from database file

Usage:

$ remotive topology show ethernet [OPTIONS] PATH

Arguments:

  • PATH: Path to the Database file, supported extensions: extensions: '.arxml' [required]

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • --help: Show this message and exit.

remotive topology show services​

[EXPERIMENTAL] Show SOME/IP services from database file

Usage:

$ remotive topology show services [OPTIONS] PATH

Arguments:

  • PATH: Path to the Database file, supported extensions: extensions: '.arxml' [required]

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • -s, --services TEXT: List of SOME/IP services to process [required]
  • --help: Show this message and exit.

remotive topology recording-session​

Work with recording sessions

Usage:

$ remotive topology recording-session [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a new recording session from...
  • instantiate: Create a topology instance ready to play a...
  • recalculate: Recalculate the recording session start...

remotive topology recording-session create​

Create a new recording session from recording files

Usage:

$ remotive topology recording-session create [OPTIONS] [OUT_PATH]

Arguments:

  • [OUT_PATH]: Write content to provided file path

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • -f, --file TEXT: Recording file(s), applied in the order they are provided, e.g. candump.log, .csv [required]
  • --help: Show this message and exit.

remotive topology recording-session instantiate​

Create a topology instance ready to play a recording session

Usage:

$ remotive topology recording-session instantiate [OPTIONS] RECORDING_SESSION [OUT_PATH]

Arguments:

  • RECORDING_SESSION: Path to the recording session file [required]
  • [OUT_PATH]: Write content to provided file path

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • --help: Show this message and exit.

remotive topology recording-session recalculate​

Recalculate the recording session start and end time based on the files and their offsets

Usage:

$ remotive topology recording-session recalculate [OPTIONS] RECORDING_SESSION [OUT_PATH]

Arguments:

  • RECORDING_SESSION: Path to the recording session file [required]
  • [OUT_PATH]: Write content to provided file path

Options:

  • --json: Output results in JSON format
  • --yaml: Output results in YAML format (default)
  • --help: Show this message and exit.

remotive broker​

Manage a single broker - local or cloud

Usage:

$ remotive broker [OPTIONS] COMMAND [ARGS]...

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --help: Show this message and exit.

Commands:

  • discover: Discover brokers on this network
  • playback: Manage playback of recording sessions
  • record: Record data on buses
  • files: Upload/Download configurations and recordings
  • signals: Find and subscribe to signals
  • export: Export to external formats
  • scripting: LUA scripting utilities
  • license: View and request license to broker

remotive broker discover​

Discover brokers on this network

Usage:

$ remotive broker discover [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive broker playback​

Manage playback of recording sessions

All offsets are in microseconds (μs)

Usage:

$ remotive broker playback [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list-files: List files on broker.
  • play: Starts playing the recording at current...
  • repeat: Repeat RecordingSession in specific...
  • pause: Pause the recording at current offset or...
  • seek: Seek to specified offset
  • open: Open a recording session.
  • close: Close a recording session.
  • status: Get the status of all opened Recording...

remotive broker playback list-files​

List files on broker.

Usage:

$ remotive broker playback list-files [OPTIONS] [PATH]

Arguments:

  • [PATH]: Optional subdirectory to list files in, defaults to / [default: /]

Options:

  • --recursive / --no-recursive: List subdirectories recursively [default: no-recursive]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker playback play​

Starts playing the recording at current offset or from specified offset

Offsets can be specified in minutes (1:15min), seconds(10s), millis(10000ms) or micros(10000000us), default without suffix is micros. Sample offsets --offset 1.15min, 10s, 10000ms, 10000000us, 10000000,

Usage:

$ remotive broker playback play [OPTIONS] PATH

Arguments:

  • PATH: Path to the recording session [env var: REMOTIVE_RECORDING_SESSION_PATH; required]

Options:

  • --offset TEXT: Offset to play from
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker playback repeat​

Repeat RecordingSession in specific interval or complete recording To remove existing repeat config, use --clear flag.

Offsets can be specified in minutes (1:15min), seconds(10s), millis(10000ms) or micros(10000000us), default without suffix is micros. Sample offsets --start-offset/--end-offset 1.15min, 10s, 10000ms, 10000000us, 10000000,

Usage:

$ remotive broker playback repeat [OPTIONS] PATH

Arguments:

  • PATH: Path to the recording session [env var: REMOTIVE_RECORDING_SESSION_PATH; required]

Options:

  • --start-offset TEXT: Repeat start offset, defaults to start [default: 0]
  • --end-offset TEXT: Repeat end offset, defaults to end
  • --clear / --no-clear: Clear repeat [default: no-clear]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker playback pause​

Pause the recording at current offset or specified offset

Offsets can be specified in minutes (1:15min), seconds(10s), millis(10000ms) or micros(10000000us), default without suffix is micros. Sample offsets --offset 1.15min, 10s, 10000ms, 10000000us, 10000000,

Usage:

$ remotive broker playback pause [OPTIONS] PATH

Arguments:

  • PATH: Path to the recording session [env var: REMOTIVE_RECORDING_SESSION_PATH; required]

Options:

  • --offset TEXT: Offset to play from
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker playback seek​

Seek to specified offset

Offsets can be specified in minutes (1:15min), seconds(10s), millis(10000ms) or micros(10000000us), default without suffix is micros. Sample offsets --offset 1.15min, 10s, 10000ms, 10000000us, 10000000,

Usage:

$ remotive broker playback seek [OPTIONS] PATH

Arguments:

  • PATH: Path to the recording session [env var: REMOTIVE_RECORDING_SESSION_PATH; required]

Options:

  • --offset TEXT: Offset to seek to [required]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker playback open​

Open a recording session.

Usage:

$ remotive broker playback open [OPTIONS] PATH

Arguments:

  • PATH: Path to the recording session [env var: REMOTIVE_RECORDING_SESSION_PATH; required]

Options:

  • --force / --no-force: Force close and re-open recording session if exists [default: no-force]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker playback close​

Close a recording session.

Usage:

$ remotive broker playback close [OPTIONS] PATH

Arguments:

  • PATH: Path to the recording session [env var: REMOTIVE_RECORDING_SESSION_PATH; required]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker playback status​

Get the status of all opened Recording sessions

Usage:

$ remotive broker playback status [OPTIONS]

Options:

  • --stream / --no-stream: Blocks and continuously streams statuses [default: no-stream]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker record​

Record data on buses

Usage:

$ remotive broker record [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • start
  • stop

remotive broker record start​

Usage:

$ remotive broker record start [OPTIONS] FILENAME

Arguments:

  • FILENAME: Path to local file to upload [required]

Options:

  • --namespace TEXT: Namespace to record [required]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker record stop​

Usage:

$ remotive broker record stop [OPTIONS] FILENAME

Arguments:

  • FILENAME: Path to local file to upload [required]

Options:

  • --namespace TEXT: Namespace to record [required]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker files​

Upload/Download configurations and recordings

Usage:

$ remotive broker files [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • reload-configuration
  • delete: Deletes the specified files from the broker
  • download: Downloads a file from a broker
  • upload: Uploads a file to a broker - physical or...

remotive broker files reload-configuration​

Usage:

$ remotive broker files reload-configuration [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker files delete​

Deletes the specified files from the broker

Usage:

$ remotive broker files delete [OPTIONS] PATH...

Arguments:

  • PATH...: Paths to files on broker to delete [required]

Options:

  • --exit-on-failure / --no-exit-on-failure: Exits if there was a problem deleting a file [default: no-exit-on-failure]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker files download​

Downloads a file from a broker

Usage:

$ remotive broker files download [OPTIONS] PATH

Arguments:

  • PATH: Path to file on broker to download [required]

Options:

  • --output TEXT: Optional output file name
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker files upload​

Uploads a file to a broker - physical or in cloud.

Usage:

$ remotive broker files upload [OPTIONS] PATH

Arguments:

  • PATH: Path to local file to upload [required]

Options:

  • --output TEXT: Optional output path on broker
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker signals​

Find and subscribe to signals

Usage:

$ remotive broker signals [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List signal metadata on a broker
  • subscribe: Subscribe to a selection of signals
  • namespaces: List namespaces on broker
  • frame-distribution: Use this command to get frames currently...

remotive broker signals list​

List signal metadata on a broker

Filter are inclusive so --name-starts-with and --name-ends-with will include name that matches both

Usage:

$ remotive broker signals list [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --name-starts-with TEXT: Signal name prefix to include
  • --name-ends-with TEXT: Signal name suffix to include
  • --help: Show this message and exit.

remotive broker signals subscribe​

Subscribe to a selection of signals

Subscribe to two signals and have it printed to terminal

remotive broker signals subscribe  --url http://localhost:50051 --signal can1:signal1 --signal can0:signal2

Subscribe using a LUA script with signal transformations, read more about scripted signals at https://docs.remotivelabs.com/docs/remotive-broker

remotive broker signals subscribe  --url http://localhost:50051 --script myvss_script.lua

Usage:

$ remotive broker signals subscribe [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --signal TEXT: Signal names to subscribe to, mandatory when not using script
  • --script FILE: Supply a path to Lua script that to use for signal transformation
  • --on-change-only / --no-on-change-only: Only get signal if value is changed [default: no-on-change-only]
  • --x-plot / --no-x-plot: Experimental: Plot the signal in terminal. Note graphs are not aligned by time [default: no-x-plot]
  • --x-plot-size INTEGER: Experimental: how many points show for each plot [default: 100]
  • --help: Show this message and exit.

remotive broker signals namespaces​

List namespaces on broker

Usage:

$ remotive broker signals namespaces [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --help: Show this message and exit.

remotive broker signals frame-distribution​

Use this command to get frames currently available on the specified namespace.

Usage:

$ remotive broker signals frame-distribution [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --namespace TEXT: Namespace [required]
  • --help: Show this message and exit.

remotive broker export​

Export to external formats

Usage:

$ remotive broker export [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • influxdb: Exports subscribed signals to InfluxDB...

remotive broker export influxdb​

Exports subscribed signals to InfluxDB line-protocol, really useful to dump some signals into influxdb for offline analysis and insights.

This is a sample for exporting and importing to InfluxDB using remotive-cli and influx-cli

Export: remotive broker export influxdb --url [URL] --output signals.influx
--signal vehiclebus:Control.SteeringWheel_Position --signal Control.Accelerator_PedalPosition
--signal vehiclebus:GpsPosition.GPS_Longitude --signal vehiclebus:GpsPosition.GPS_Latitude

Output: Control, namespace:vehiclebus SteeringWheel_Position=1.0,Accelerator_PedalPosition=0,Speed=0 1664787032944374000 GpsPosition, namespace:vehiclebus GPS_Longitude=12.982076,GPS_Latitude=55.618748 1664787032948256000

Import: influx write --org myorg -b my-bucket -p ns --format=lp -f signals.influx

Usage:

$ remotive broker export influxdb [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --signal TEXT: List of signal names to subscribe to in format namespace:signal_name [required]
  • --on-change-only / --no-on-change-only: Only get signal if value is changed [default: no-on-change-only]
  • --output TEXT: Write results to file, defaults to stdout
  • --help: Show this message and exit.

remotive broker scripting​

LUA scripting utilities

Usage:

$ remotive broker scripting [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • new-script

remotive broker scripting new-script​

Usage:

$ remotive broker scripting new-script [OPTIONS]

Options:

  • --input-signal TEXT: Required input signal names [required]
  • --output-signal TEXT: Name of output signal [required]
  • --save / --no-save: Save file to disk - Default stored as output_signal.lua [default: no-save]
  • --help: Show this message and exit.

remotive broker license​

View and request license to broker

Usage:

$ remotive broker license [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • describe: Show licence information
  • request: Requests and applies a new or existing...

remotive broker license describe​

Show licence information

More info on our docs page https://docs.remotivelabs.com/docs/remotive-broker/getting-started

--connect describes how the connection is made to the broker and helps us properly connect to broker

url = Connects to the broker with the specified url, this is hotspot = If you are using RemotiveBox (our reference hardware) you can connect to the broker over its wifi hotspot. Getting the license from a RemotiveBox over its wifi hotspot requires you switch wi-fi network to the RemotiveBox hotspot called 'remotivelabs-xxx' where 'xxx' is a random generated id.

--url is the broker url, this is mandatory when connect type is "url"

Usage:

$ remotive broker license describe [OPTIONS]

Options:

  • --connect [hotspot|url]: How to connect to broker [default: url]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --help: Show this message and exit.

remotive broker license request​

Requests and applies a new or existing License to a broker, Note that internet access is required on your computer

More info on our docs page https://docs.remotivelabs.com/docs/remotive-broker/getting-started

--connect describes how the connection is made to the broker and helps us properly connect to broker

url = Use url to connect to broker (use --url) hotspot = If you are using RemotiveBox (our reference hardware) you can connect to the broker over its wifi hotspot. Licensing a broker on a RemotiveBox over its wifi hotspot requires you switch wi-fi network to the RemotiveBox hotspot called 'remotivelabs-xxx' where 'xxx' is a random generated id. https://docs.remotivelabs.com/docs/remotive-broker/getting-started/remotive-box

--url is the broker url, this is mandatory when connect type is "url"

Usage:

$ remotive broker license request [OPTIONS]

Options:

  • --connect [hotspot|url]: How to connect to broker [default: url]
  • --url TEXT: Broker url, this is mandatory when connect type is 'url' [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --help: Show this message and exit.

remotive cloud​

Manage resources in RemotiveCloud

Usage:

$ remotive cloud [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • licenses: List licenses for an organization
  • organizations: Manage organizations
  • projects: Manage projects
  • auth: Manage how you authenticate with our cloud...
  • brokers: Manage cloud broker lifecycle
  • recordings: Manage recordings
  • signal-databases: Manage signal databases
  • storage: Manage files (Beta feature not...
  • service-accounts: Manage project service account keys
  • samples: Manage sample recordings

remotive cloud licenses​

List licenses for an organization

Usage:

$ remotive cloud licenses [OPTIONS]

Options:

  • --organization TEXT: Organization ID [env var: REMOTIVE_CLOUD_ORGANIZATION; required]
  • --filter-option TEXT: all, valid, expired [default: all]
  • --help: Show this message and exit.

remotive cloud organizations​

Manage organizations

Usage:

$ remotive cloud organizations [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • default
  • list: List your available organizations

remotive cloud organizations default​

Usage:

$ remotive cloud organizations default [OPTIONS] [ORGANIZATION_UID]

Arguments:

  • [ORGANIZATION_UID]: Organization uid or empty to select one

Options:

  • --get / --no-get: Print current default organization [default: no-get]
  • --help: Show this message and exit.

remotive cloud organizations list​

List your available organizations

Usage:

$ remotive cloud organizations list [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive cloud projects​

Manage projects

Usage:

$ remotive cloud projects [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List your projects
  • create
  • delete

remotive cloud projects list​

List your projects

Usage:

$ remotive cloud projects list [OPTIONS]

Options:

  • --organization TEXT: Organization ID [env var: REMOTIVE_CLOUD_ORGANIZATION; required]
  • --help: Show this message and exit.

remotive cloud projects create​

Usage:

$ remotive cloud projects create [OPTIONS] PROJECT_UID

Arguments:

  • PROJECT_UID: Project UID [required]

Options:

  • --organization TEXT: Organization ID [env var: REMOTIVE_CLOUD_ORGANIZATION; required]
  • --project-display-name TEXT: Project display name
  • --help: Show this message and exit.

remotive cloud projects delete​

Usage:

$ remotive cloud projects delete [OPTIONS] PROJECT

Arguments:

  • PROJECT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]

Options:

  • --help: Show this message and exit.

remotive cloud auth​

Manage how you authenticate with our cloud platform

Usage:

$ remotive cloud auth [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • login: Login to the cli using browser
  • whoami: Validates authentication and fetches your...
  • print-access-token: Print current active access token or the...
  • deactivate: Clears active account
  • activate: Set the active account
  • list: Lists available credential files on...

remotive cloud auth login​

Login to the cli using browser

If not able to open a browser it will show fallback to headless login and show a link that users can copy into any browser when this is unsupported where running the cli - such as in docker, virtual machine or ssh sessions.

Usage:

$ remotive cloud auth login [OPTIONS]

Options:

  • --browser / --no-browser: Does not automatically open browser, instead shows a link [default: browser]
  • --help: Show this message and exit.

remotive cloud auth whoami​

Validates authentication and fetches your account information

Usage:

$ remotive cloud auth whoami [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive cloud auth print-access-token​

Print current active access token or the token for the specified account

Usage:

$ remotive cloud auth print-access-token [OPTIONS]

Options:

  • --account TEXT: Email of the account you want to print access token for, defaults to active
  • --help: Show this message and exit.

remotive cloud auth deactivate​

Clears active account

Usage:

$ remotive cloud auth deactivate [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive cloud auth activate​

Set the active account

Usage:

$ remotive cloud auth activate [OPTIONS] [TOKEN_NAME]

Arguments:

  • [TOKEN_NAME]: Name, filename or path to a credentials file

Options:

  • --help: Show this message and exit.

remotive cloud auth list​

Lists available credential files on filesystem

TODO: Support output format

Usage:

$ remotive cloud auth list [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive cloud brokers​

Manage cloud broker lifecycle

Usage:

$ remotive cloud brokers [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: Lists brokers in project
  • describe: Shows details about a specific broker
  • delete: Stops and deletes a broker from project
  • delete-personal: Deletes your personal broker from project
  • create: Create a broker in project
  • logs: Exposes broker logs history or real-time...

remotive cloud brokers list​

Lists brokers in project

Usage:

$ remotive cloud brokers list [OPTIONS]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud brokers describe​

Shows details about a specific broker

Usage:

$ remotive cloud brokers describe [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud brokers delete​

Stops and deletes a broker from project

Usage:

$ remotive cloud brokers delete [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud brokers delete-personal​

Deletes your personal broker from project

Usage:

$ remotive cloud brokers delete-personal [OPTIONS]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud brokers create​

Create a broker in project

Usage:

$ remotive cloud brokers create [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --tag TEXT: Optional specific tag/version
  • --silent / --no-silent: Optional specific tag/version [default: no-silent]
  • --api-key TEXT: Start with your own api-key
  • --help: Show this message and exit.

remotive cloud brokers logs​

Exposes broker logs history or real-time tail of the broker.

When using --tail option, --history always skipped even if supplied

Usage:

$ remotive cloud brokers logs [OPTIONS] BROKER_NAME

Arguments:

  • BROKER_NAME: Broker name to see logs for [required]

Options:

  • --tail / --no-tail: Tail the broker log [default: no-tail]
  • --history-minutes TEXT: History in minutes minutes to fetch [default: 10]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings​

Manage recordings

Usage:

$ remotive cloud recordings [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List all recording sessions in a project.
  • describe: Shows details about a specific recording...
  • import: Imports a file from Storage as a recording.
  • mount: Prepares all recording files and...
  • download-recording-file: Downloads the specified recording file to...
  • delete: Deletes the specified recording session...
  • delete-recording-file: Deletes the specified recording file
  • upload: Uploads a recording to RemotiveCloud.
  • upload-broker-configuration: Uploads a broker configuration directory
  • download-broker-configuration: Downloads the specified broker...
  • delete-broker-configuration: Delete the specified broker configuration
  • copy: Copy recording to another project
  • play: (Deprecated) Plays a recording (Deprecated - Use...
  • pause: (Deprecated) Pause recording (Deprecated - Use...
  • seek: (Deprecated) Seek into recording (Deprecated - Use...
  • stop: (Deprecated) Stop recording (Deprecated - Use...
  • playback: Support for playback of a recording on a...

remotive cloud recordings list​

List all recording sessions in a project. You can choose to see all valid recordings (default) or use --is-processing and you will get those that are currently beeing processed or that failed to be validated.

Usage:

$ remotive cloud recordings list [OPTIONS]

Options:

  • --is-processing / --no-is-processing: Use this option to see only those that are beeing processed or are invalid [default: no-is-processing]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings describe​

Shows details about a specific recording in project

Usage:

$ remotive cloud recordings describe [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings import​

Imports a file from Storage as a recording.

NOTE that Storage is not yet available to all customers

Usage:

$ remotive cloud recordings import [OPTIONS] URI

Arguments:

  • URI: Remote storage path [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings mount​

Prepares all recording files and transformations to be available for playback

Usage:

$ remotive cloud recordings mount [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --ensure-broker-started / --no-ensure-broker-started: Ensure broker exists, start otherwise [default: no-ensure-broker-started]
  • --transformation-name TEXT: Specify a custom signal transformation to use [default: default]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings download-recording-file​

Downloads the specified recording file to disk

Usage:

$ remotive cloud recordings download-recording-file [OPTIONS] RECORDING_FILE_NAME

Arguments:

  • RECORDING_FILE_NAME: Recording file to download [required]

Options:

  • --recording-session TEXT: Recording session id that this file belongs to [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings delete​

Deletes the specified recording session including all media files and configurations.

Usage:

$ remotive cloud recordings delete [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings delete-recording-file​

Deletes the specified recording file

Usage:

$ remotive cloud recordings delete-recording-file [OPTIONS] RECORDING_FILE_NAME

Arguments:

  • RECORDING_FILE_NAME: Recording file to download [required]

Options:

  • --recording-session TEXT: Recording session id that this file belongs to [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings upload​

Uploads a recording to RemotiveCloud. Except for recordings from RemotiveBroker you can also upload Can ASC (.asc), Can BLF(.blf) and Can LOG (.log, .txt)

Usage:

$ remotive cloud recordings upload [OPTIONS] PATH

Arguments:

  • PATH: Path to recording file to upload [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --recording-session TEXT: Optional existing recording to upload file to
  • --help: Show this message and exit.

remotive cloud recordings upload-broker-configuration​

Uploads a broker configuration directory

Usage:

$ remotive cloud recordings upload-broker-configuration [OPTIONS] DIRECTORY

Arguments:

  • DIRECTORY: Directory to upload [required]

Options:

  • --recording-session TEXT: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --overwrite / --no-overwrite: Overwrite existing configuration if it exists [default: no-overwrite]
  • --help: Show this message and exit.

remotive cloud recordings download-broker-configuration​

Downloads the specified broker configuration directory as zip file

Usage:

$ remotive cloud recordings download-broker-configuration [OPTIONS] BROKER_CONFIG_NAME

Arguments:

  • BROKER_CONFIG_NAME: Broker config name [required]

Options:

  • --recording-session TEXT: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings delete-broker-configuration​

Delete the specified broker configuration

Usage:

$ remotive cloud recordings delete-broker-configuration [OPTIONS] BROKER_CONFIG_NAME

Arguments:

  • BROKER_CONFIG_NAME: Broker config name [required]

Options:

  • --recording-session TEXT: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings copy​

Copy recording to another project

Usage:

$ remotive cloud recordings copy [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [required]

Options:

  • --from-project TEXT: Source project [required]
  • --to-project TEXT: Destination project [required]
  • --help: Show this message and exit.

remotive cloud recordings play​

Plays a recording (Deprecated - Use recordings playback play)"

Usage:

$ remotive cloud recordings play [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings pause​

Pause recording (Deprecated - Use recordings playback pause")

Usage:

$ remotive cloud recordings pause [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings seek​

Seek into recording (Deprecated - Use recordings playback seek)

Usage:

$ remotive cloud recordings seek [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --seconds INTEGER RANGE: Target offset in seconds [x>=0; required]
  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings stop​

Stop recording (Deprecated - Use recordings playback stop)

Usage:

$ remotive cloud recordings stop [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud recordings playback​

Support for playback of a recording on a cloud broker, make sure to always mount a recording first

Usage:

$ remotive cloud recordings playback [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • play: Start playing a recording.
  • pause: Pause a recording
  • progress: Shows progress of the recording playing.
  • seek: Seek seconds into a recording
  • stop: Stop playing
  • subscribe: Allows you to subscribe to signals based...
remotive cloud recordings playback play​

Start playing a recording. There is no problem invoking play multiple times since if it is already playing the command will be ignored. Use --repeat to have the recording replayed when it reaches the end.

Usage:

$ remotive cloud recordings playback play [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --show-progress / --no-show-progress: Show progress after started playing [default: no-show-progress]
  • --repeat / --no-repeat: Repeat recording - must keep command running in terminal [default: no-repeat]
  • --help: Show this message and exit.
remotive cloud recordings playback pause​

Pause a recording

Usage:

$ remotive cloud recordings playback pause [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.
remotive cloud recordings playback progress​

Shows progress of the recording playing. Use --repeat to have the recording replayed when it reaches the end.

Usage:

$ remotive cloud recordings playback progress [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.
remotive cloud recordings playback seek​

Seek seconds into a recording

Usage:

$ remotive cloud recordings playback seek [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --seconds INTEGER RANGE: Target offset in seconds [x>=0; required]
  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.
remotive cloud recordings playback stop​

Stop playing

Usage:

$ remotive cloud recordings playback stop [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.
remotive cloud recordings playback subscribe​

Allows you to subscribe to signals based on a mounted recording without knowing the broker URL. This simplifies when playing recordings from the cloud.

Terminal plotting is not yet supported here so we refer to remotive broker signals subscribe --x-plot for this.

Usage:

$ remotive cloud recordings playback subscribe [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [env var: REMOTIVE_CLOUD_RECORDING_SESSION; required]

Options:

  • --broker TEXT: Broker to use
  • --signal TEXT: Signal names to subscribe to, mandatory when not using script
  • --script FILE: Supply a path to Lua script that to use for signal transformation
  • --on-change-only / --no-on-change-only: Only get signal if value is changed [default: no-on-change-only]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud signal-databases​

Manage signal databases

Usage:

$ remotive cloud signal-databases [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List available signal databases in project
  • delete: Deletes the specified signal database
  • upload: Uploads signal database to project
  • describe: Shows all metadata related to this signal...
  • download: Downloads the specified signal database to...

remotive cloud signal-databases list​

List available signal databases in project

Usage:

$ remotive cloud signal-databases list [OPTIONS]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud signal-databases delete​

Deletes the specified signal database

Usage:

$ remotive cloud signal-databases delete [OPTIONS] [SIGNAL_DB_FILE]

Arguments:

  • [SIGNAL_DB_FILE]: Signal database file

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud signal-databases upload​

Uploads signal database to project

Usage:

$ remotive cloud signal-databases upload [OPTIONS] PATH

Arguments:

  • PATH: Path to signal database file to upload [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud signal-databases describe​

Shows all metadata related to this signal database

Usage:

$ remotive cloud signal-databases describe [OPTIONS] [SIGNAL_DB_FILE]

Arguments:

  • [SIGNAL_DB_FILE]: Signal database file

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud signal-databases download​

Downloads the specified signal database to disk

Usage:

$ remotive cloud signal-databases download [OPTIONS] [SIGNAL_DB_FILE]

Arguments:

  • [SIGNAL_DB_FILE]: Signal database file

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud storage​

Manage files (Beta feature not available for all customers)

Copy file from local to remote storage and vice versa, list and delete files.

Usage:

$ remotive cloud storage [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ls: Listing remote files
  • rm: Deletes a file from remote...
  • cp: Copies a file to or from remote storage

remotive cloud storage ls​

Listing remote files

This will list files and directories in project top level directory remotive cloud storage ls rcs://

This will list all files and directories matching the path remotive cloud storage ls rcs://fileOrDirectoryPrefix

This will list all files and directories in the specified directory remotive cloud storage ls rcs://fileOrDirectory/

Usage:

$ remotive cloud storage ls [OPTIONS] [URI]

Arguments:

  • [URI]: Remote storage path [default: rcs://]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud storage rm​

Deletes a file from remote storage, this cannot be undone 🔥

remotive cloud storage rm rcs://directory/filename

Usage:

$ remotive cloud storage rm [OPTIONS] URI

Arguments:

  • URI: Remote storage path [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud storage cp​

Copies a file to or from remote storage

remotive cloud storage cp rcs://dir/filename . remotive cloud storage cp rcs://dir/filename filename

remotive cloud storage cp filename rcs://dir/ remotive cloud storage cp filename rcs://dir/filename

Usage:

$ remotive cloud storage cp [OPTIONS] SOURCE DEST

Arguments:

  • SOURCE: Remote or local path to source file [required]
  • DEST: Remote or local path to destination file [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --overwrite / --no-overwrite: Overwrite existing file on RCS [default: no-overwrite]
  • --help: Show this message and exit.

remotive cloud service-accounts​

Manage project service account keys

Usage:

$ remotive cloud service-accounts [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List service-accounts
  • create: Create a new service account with one or...
  • update: Update an existing service account with...
  • delete: Delete service account
  • tokens: Manage project service account access tokens

remotive cloud service-accounts list​

List service-accounts

Usage:

$ remotive cloud service-accounts list [OPTIONS]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud service-accounts create​

Create a new service account with one or more roles.

Must only use lowercase letters, digits, or dashes, and must not contain -- or end with a dash.

remotive cloud service-accounts create --role project/user --role project/storageCreator

Supported roles project/admin - Full project support, view, edit, delete and manage users project/user - View, edit, upload, delete but no admin project/viewer - View only project/storageCreator - Can upload to storage but not view, overwrite or delete org/topologyRunner - Can start RemotiveTopology

Usage:

$ remotive cloud service-accounts create [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --role TEXT: Roles to apply [required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud service-accounts update​

Update an existing service account with one or more roles.

remotive cloud service-accounts update --role project/user --role project/storageCreator

Supported roles project/admin - Full project support, view, edit, delete and manage users project/user - View, edit, upload, delete but no admin project/viewer - View only project/storageCreator - Can upload to storage but not view, overwrite or delete org/topologyRunner - Can start RemotiveTopology

Usage:

$ remotive cloud service-accounts update [OPTIONS] SERVICE_ACCOUNT

Arguments:

  • SERVICE_ACCOUNT: Service account name [required]

Options:

  • --role TEXT: Roles to apply [required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud service-accounts delete​

Delete service account

Usage:

$ remotive cloud service-accounts delete [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud service-accounts tokens​

Manage project service account access tokens

Usage:

$ remotive cloud service-accounts tokens [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create and download a new service account...
  • list: List service account access tokens
  • describe: Describe service account access token
  • revoke: Revoke service account access token
remotive cloud service-accounts tokens create​

Create and download a new service account access token

Usage:

$ remotive cloud service-accounts tokens create [OPTIONS]

Options:

  • --expire-in-days INTEGER: Number of this token is valid [default: 365]
  • --service-account TEXT: Service account name [required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.
remotive cloud service-accounts tokens list​

List service account access tokens

Usage:

$ remotive cloud service-accounts tokens list [OPTIONS]

Options:

  • --service-account TEXT: Service account name [required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.
remotive cloud service-accounts tokens describe​

Describe service account access token

Usage:

$ remotive cloud service-accounts tokens describe [OPTIONS] NAME

Arguments:

  • NAME: Access token name [required]

Options:

  • --service-account TEXT: Service account name [required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.
remotive cloud service-accounts tokens revoke​

Revoke service account access token

Usage:

$ remotive cloud service-accounts tokens revoke [OPTIONS] NAME

Arguments:

  • NAME: Access token name [required]

Options:

  • --delete / --no-delete: Also deletes the token after revocation [default: delete]
  • --service-account TEXT: Service account name [required]
  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud samples​

Manage sample recordings

Usage:

$ remotive cloud samples [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • import: Import sample recording into project
  • list: List available sample recordings

remotive cloud samples import​

Import sample recording into project

Usage:

$ remotive cloud samples import [OPTIONS] RECORDING_SESSION

Arguments:

  • RECORDING_SESSION: Recording session id [required]

Options:

  • --project TEXT: Project to import sample recording into [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --help: Show this message and exit.

remotive cloud samples list​

List available sample recordings

Usage:

$ remotive cloud samples list [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive connect​

Integrations with other systems

Usage:

$ remotive connect [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • protopie: ProtoPie Connect bridge-app to connect...

remotive connect protopie​

ProtoPie Connect bridge-app to connect signals with RemotiveBroker

Subscribe to signals and send signal values to your Pie in a simple way. You can subscribe to signals from command line using --signal or use --config to use a json configuration file.

$ remotive connect protopie --signal vss:Vehicle.Chassis.SteeringWheel.Angle --signal vss:Vehicle.Speed

You can use a configuration file for this if you have many signals, want to share the configuration or you want custom mapping of the signal name.

$ remotive connect protopie --config my-protopie-config.json

Sample my-protopie-config.json

{
  "subscription": {
    "Vehicle.CurrentLocation.Heading": {
      "namespace": "vss"
    },
    "Vehicle.Speed": {
      "namespace": "vss",
       "mapTo": ["Speed", "VehicleSpeed"]
    }
  }
}

For simple changes to signal names its possible to use a simple string expression that will be applied to all signal names before its published to ProtoPie connect, i.e replacing chars or substring to match variables in Pie. This is intended for simple use cases when you do not have a configuration file, otherwise we recommend using the mapTo field in the configuration.

Supported transformations: lower(), upper(), replace("old", "new")

This will replace all occurrences of . (dot) with _ (underscore) and lowercase the signal name

$ remotive connect protopie --signal vss:Vehicle.Chassis.SteeringWheel.Angle --signal-name-expression 'replace(".", "_").lower()'

Usage:

$ remotive connect protopie [OPTIONS]

Options:

  • --config FILE: Configuration file with signal subscriptions and mapping if needed
  • --signal TEXT: Signal names to subscribe to, mandatory when not using script
  • --signal-name-expression TEXT: [Experimental] String expression to rename signal names, i.e 'lower().replace(".","_")'
  • --changed-values-only / --no-changed-values-only: Only receive signal when its value is changed to minimize amount of data received [default: changed-values-only]
  • --broker-url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; default: http://localhost:50051]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY]
  • --pp-connect-host TEXT: ProtoPie Connect URL [default: http://localhost:9981]
  • --help: Show this message and exit.

remotive tools​

CLI tools unrelated to cloud or broker

Usage:

$ remotive tools [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • can: CAN tools

remotive tools can​

CAN tools

Usage:

$ remotive tools can [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • convert: Converts between ASC, BLF and LOG files.
  • validate: Validates that the input file is an ASC,...

remotive tools can convert​

Converts between ASC, BLF and LOG files. Files must end with .asc, .blf or .log.

remotive tools can convert [my_file.blf|.log|.asc] [my_file.blf|.log|.asc]

Usage:

$ remotive tools can convert [OPTIONS] IN_FILE OUT_FILE

Arguments:

  • IN_FILE: File to convert from (.blf .asc .log) [required]
  • OUT_FILE: File to convert to (.blf .asc .log) [required]

Options:

  • --help: Show this message and exit.

remotive tools can validate​

Validates that the input file is an ASC, BLF and LOG file

remotive tools can validate [my_file.blf|.log|.asc]

Usage:

$ remotive tools can validate [OPTIONS] IN_FILE

Arguments:

  • IN_FILE: File to validate (.blf .asc .log) [required]

Options:

  • --print-to-terminal / --no-print-to-terminal: Print file contents to terminal [default: no-print-to-terminal]
  • --help: Show this message and exit.