Skip to main content

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:

  • 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
  • tui: Explore remotive-cli and generate commands...

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]
  • --help: Show this message and exit.

Commands:

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

remotive broker discover​

Discover brokers on this network

Usage:

$ remotive broker discover [OPTIONS]

Options:

  • --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; required]
  • --api-key TEXT: Cloud Broker API-KEY [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 files​

Upload/Download configurations and recordings

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

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

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; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --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; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --help: Show this message and exit.

remotive broker files reload-configuration​

Usage:

$ remotive broker files reload-configuration [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --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; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --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 broker playback​

Manage playing recordings

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • pause: Pause recordings that are beeing played on...
  • play: Play recording files on broker.
  • seek: Seeks to a position in seconds into the...
  • stop: Stop recordings that are beeing played on...

remotive broker playback pause​

Pause recordings that are beeing played on brokers are done with the same syntax as when you start them.

Separate recording file and namespace with ::

remotive broker playback pause --recording myrecording_can0::can0 --recording myrecording_can1::can1

Usage:

$ remotive broker playback pause [OPTIONS]

Options:

  • --recording TEXT: Which recording and which namespace to stop [required]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --help: Show this message and exit.

remotive broker playback play​

Play recording files on broker.

Separate recording file and namespace with ::

remotive broker playback play --recording myrecording_can0::can0 --recording myrecording_can1::can1

Usage:

$ remotive broker playback play [OPTIONS]

Options:

  • --recording TEXT: Which recording and which namespace to play [required]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --help: Show this message and exit.

remotive broker playback seek​

Seeks to a position in seconds into the recording

Separate recording file and namespace with ::

remotive broker playback seek --recording myrecording_can0::can0 --recording myrecording_can1::can1 --seconds 23

Usage:

$ remotive broker playback seek [OPTIONS]

Options:

  • --recording TEXT: Which recording and which namespace to stop [required]
  • --seconds FLOAT: Target offset in seconds [required]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --help: Show this message and exit.

remotive broker playback stop​

Stop recordings that are beeing played on brokers are done with the same syntax as when you start them.

Separate recording file and namespace with ::

remotive broker playback stop --recording myrecording_can0::can0 --recording myrecording_can1::can1

Usage:

$ remotive broker playback stop [OPTIONS]

Options:

  • --recording TEXT: Which recording and which namespace to stop [required]
  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --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; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --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; required]
  • --api-key TEXT: Cloud Broker API-KEY or access token [env var: REMOTIVE_BROKER_API_KEY; default: offline]
  • --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 signals​

Find and subscribe to signals

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • list: List frame and signal metadata on broker
  • namespaces: List namespaces on broker
  • signal-names: (Deprecated) List signals names on broker
  • subscribe: Subscribe to a selection of signals

remotive broker signals list​

List frame and signal metadata on broker

Usage:

$ remotive broker signals list [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --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 namespaces​

List namespaces on broker

Usage:

$ remotive broker signals namespaces [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --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 signal-names​

List signals names on broker

Usage:

$ remotive broker signals signal-names [OPTIONS]

Options:

  • --url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --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 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; required]
  • --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 cloud​

Manage resources in RemotiveCloud

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

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

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
  • logout: Clear access token
  • print-access-token: Print current active access token
  • tokens: Manage users personal access tokens
  • whoami: Validates authentication and fetches your...

remotive cloud auth login​

Login to the cli using browser

This will be used as the current access token in all subsequent requests. This would be the same as activating a personal access key or service-account access key.

Usage:

$ remotive cloud auth login [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive cloud auth logout​

Clear access token

Usage:

$ remotive cloud auth logout [OPTIONS]

Options:

  • --help: Show this message and exit.

remotive cloud auth print-access-token​

Print current active access token

Usage:

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

Options:

  • --help: Show this message and exit.

remotive cloud auth tokens​

Manage users personal access tokens

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • activate: Activate a access token file to be used...
  • create: Create and download a new personal access...
  • describe: Show contents of specified access token file
  • list: List personal access tokens
  • list-files: List personal access token files in...
  • revoke: Revoke an access token by token name or...
remotive cloud auth tokens activate​

Activate a access token file to be used for authentication.

--file

This will be used as the current access token in all subsequent requests. This would be the same as login with a browser.

Usage:

$ remotive cloud auth tokens activate [OPTIONS] FILE

Arguments:

  • FILE: File name [required]

Options:

  • --help: Show this message and exit.
remotive cloud auth tokens create​

Create and download a new personal access token

Usage:

$ remotive cloud auth tokens create [OPTIONS]

Options:

  • --activate / --no-activate: Activate the token for use after download [default: no-activate]
  • --help: Show this message and exit.
remotive cloud auth tokens describe​

Show contents of specified access token file

Usage:

$ remotive cloud auth tokens describe [OPTIONS] FILE

Arguments:

  • FILE: File name [required]

Options:

  • --help: Show this message and exit.
remotive cloud auth tokens list​

List personal access tokens

Usage:

$ remotive cloud auth tokens list [OPTIONS]

Options:

  • --help: Show this message and exit.
remotive cloud auth tokens list-files​

List personal access token files in remotivelabs config directory

Usage:

$ remotive cloud auth tokens list-files [OPTIONS]

Options:

  • --help: Show this message and exit.
remotive cloud auth tokens revoke​

Revoke an access token by token name or path to a file containing that token

Name is found in the json file

{
    "expires": "2034-07-31",
    "token": "xxx",
    "created": "2024-07-31T09:18:50.406+02:00",
    "name": "token_name"
}

Usage:

$ remotive cloud auth tokens revoke [OPTIONS] NAME_OR_FILE

Arguments:

  • NAME_OR_FILE: Name or file path of the access token to revoke [required]

Options:

  • --help: Show this message and exit.

remotive cloud auth whoami​

Validates authentication and fetches your user information

Usage:

$ remotive cloud auth whoami [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:

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

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 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 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 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 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 licenses​

List licenses for an organisation

Usage:

$ remotive cloud licenses [OPTIONS]

Options:

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

remotive cloud organisations​

Manage organisations

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • list: List your available organisations

remotive cloud organisations list​

List your available organisations

Usage:

$ remotive cloud organisations 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:

  • create
  • delete
  • list: List your projects

remotive cloud projects create​

Usage:

$ remotive cloud projects create [OPTIONS] PROJECT_UID

Arguments:

  • PROJECT_UID: Project UID [required]

Options:

  • --organisation TEXT: Organisation ID [env var: REMOTIVE_CLOUD_ORGANISATION; 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 projects list​

List your projects

Usage:

$ remotive cloud projects list [OPTIONS]

Options:

  • --organisation TEXT: Organisation ID [env var: REMOTIVE_CLOUD_ORGANISATION; 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:

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

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 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-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 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 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 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 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 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 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 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 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 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:

  • pause: Pause a recording
  • play: Start playing 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 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 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 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 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 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 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 cloud service-accounts​

Manage project service account keys

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create service account
  • delete: Delete service account
  • list: List service-accounts
  • tokens: Manage project service account access tokens
  • update: Update service account

remotive cloud service-accounts create​

Create service account

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 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 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 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 new access token
  • list: List service-account access tokens
  • list-files: List personal access token files in...
  • revoke: Revoke service account access token
remotive cloud service-accounts tokens create​

Create new 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 list-files​

List personal access token files in remotivelabs config directory

Usage:

$ remotive cloud service-accounts tokens list-files [OPTIONS]

Options:

  • --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:

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

Update service account

Usage:

$ remotive cloud service-accounts update [OPTIONS]

Options:

  • --service-account TEXT: Service account name [required]
  • --role TEXT: Roles to apply [required]
  • --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:

  • delete: Deletes the specified signal database
  • download: Downloads the specified signal database to...
  • list: List available signal databases in project
  • upload: Uploads signal database to project

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 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 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 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 storage​

Manage files ([yellow]Beta feature not available for all customers[/yellow])

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:

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

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]
  • --help: Show this message and exit.

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] [PREFIX]

Arguments:

  • [PREFIX]: 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​

[red]Deletes[/red] a file from remote storage, this cannot be undone 🔥

[white]remotive cloud storage rm rcs://directory/filename[/white]

Usage:

$ remotive cloud storage rm [OPTIONS] PATH

Arguments:

  • PATH: Remote storage path to file to delete [required]

Options:

  • --project TEXT: Project ID [env var: REMOTIVE_CLOUD_PROJECT; required]
  • --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 python 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.

This will replace all occurrences of . (dot) with _ (underscore)

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

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] Python expression to rename signal names, i.e 'lower().replace(".","_")'
  • --broker-url TEXT: Broker URL [env var: REMOTIVE_BROKER_URL; required]
  • --api-key TEXT: Cloud Broker API-KEY [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.

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.