CLI#

roboto#

CLI for interacting with Roboto. Each command group provides specific subcommands and dedicated help pages for detailed usage.

usage: roboto [--help] [--verbose] [--version] [--profile PROFILE]
              [--config-file CONFIG_FILE] [--suppress-upgrade-check]
              {actions,collections,datasets,devices,images,invocations,orgs,tokens,triggers,users}
              ...

options#

--help, -h#: Show this help message and exit.

--verbose, -v#: Set increasing levels of verbosity. Only error logs are printed by default. Use -v (warn), -vv (info), -vvv (debug).

--version#: Show the version of ‘roboto’ currently running.

--profile <profile>#: Roboto profile to use; must match a section within the Roboto config.json.

--config-file <config_file>#: Overrides the location of the Roboto config.json file. Defaults to ~/.roboto/config.json.

--suppress-upgrade-check#: Suppresses the check for a newer ‘roboto’ package version.

roboto actions#

usage: roboto actions [-h]
                      {create,delete,init,invoke,list-invocations,search,show,update}
                      ...

-h, --help#: show this help message and exit

roboto actions create#

usage: roboto actions create [-h] [--from-file ACTION_CONFIG_FILE]
                             [--name NAME] [--description DESCRIPTION]
                             [--short_description SHORT_DESCRIPTION]
                             [--inherits_from <action_name> | <action_name>@<digest> | <org>/<action_name> | <org>/<action_name>@<digest>]
                             [--image IMAGE]
                             [--parameter ['name=<name>|required=<true|false>|default=<value>|description=<description>' ...]]
                             [--metadata [KEY=VALUE ...]] [--tag [TAG ...]]
                             [--timeout TIMEOUT] [--org ORG]
                             [--vcpu {256,512,1024,2048,4096,8192,16384}]
                             [--memory MEMORY] [--storage STORAGE] [--gpu]
                             [--entrypoint ENTRY_POINT] [--command COMMAND]
                             [--command-form {exec,shell}] [--workdir WORKDIR]
                             [--env [KEY=VALUE ...]]
                             [--requires-downloaded-inputs REQUIRES_DOWNLOADED_INPUTS]
                             [--yes]

-h, --help#: show this help message and exit

--from-file <action_config_file>#: Path to a file containing Action configuration. Other CLI arguments specified will override the values in the config file.

--name <name>#: Name of the action. Not modifiable after creation. An action is considered unique by its (name, docker_image_name, docker_image_tag) tuple.

--description <description>#: Optional description of action. Modifiable after creation.

--short_description <short_description>#: Optional description of action. Modifiable after creation.

--inherits_from#: Partially or fully qualified reference to action from which to inherit configuration. Inheriting from another action is mutually exclusive with specifying a container image (--image), entrypoint (--entrypoint), command (--command), working directory (--workdir), env vars (--env), or parameter(s) (--parameter).

--image <image>#: Associate a Docker image with this action. Modifiable after creation.

--parameter#: Zero or more parameters (space-separated) accepted by this action. name is the only required attribute. default values, if provided, are JSON parsed. This argument can be specified multiple times. Parameters can be modified after creation. Argument values must be wrapped in quotes. e.g. --put-parameter 'name=my_param|required=true|description=My description of my_param'

--metadata#: Zero or more <key>=<value> format key/value pairs which represent action metadata. value is parsed as JSON. Metadata can be modified after creation.

--tag <tag>#: One or more tags to annotate this action. Modifiable after creation.

--timeout#: Optional timeout for an action in minutes, defaults to 30 minutes or 12 hours depending on tier.

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--vcpu {256,512,1024,2048,4096,8192,16384}#: CPU units to dedicate to action invocation. Defaults to 512 (0.5vCPU).

--memory <memory>#: Memory (in MiB) to dedicate to action invocation. Defaults to 1024 (1 GiB). Supported values range from 512 (0.5 GiB) to 122880 (120 GiB). Supported values are tied to selected vCPU resources. See documentation for more information.

--storage <storage>#: Ephemeral storage (in GiB) to dedicate to action invocation. Defaults to 21 GiB. Supported values range from 21 to 200, inclusive.

--gpu#: This is a placeholder; it currently does nothing. In the future, setting this option will invoke the action in a GPU-enabled compute environment.

--entrypoint <entry_point>#: Container ENTRYPOINT override. Supports passing empty string (“”) as an override, which unsets the ENTRYPOINT specified in the docker image. If updating or invoking action which has existing ENTRYPOINT override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#entrypoint and https://docs.docker.com/engine/reference/run/#entrypoint-default-command-to-execute-at-runtime

--command <command>#: Container CMD override. If updating or invoking action which has existing CMD override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#cmd and https://docs.docker.com/engine/reference/run/#cmd-default-command-or-options

--command-form {exec,shell}#: In exec form, the provided --command str is split into a list of strings (e.g., --command "-c 'print(123)'" is parsed as ["-c", "print(123)"]). In shell form, the provided --command str is not split (e.g., --command "python -c 'print(123)'" is parsed as ["python -c 'print(123)'"]).

--workdir <workdir>#: If updating, specify null to clear existing workdir. Refer to docker documentation for more: https://docs.docker.com/engine/reference/run/#workdir

--env#: Zero or more <key>=<value> formatted pairs to set as container ENV vars. Do not use ENV vars for secrets (such as API keys). See documentation: https://docs.docker.com/engine/reference/run/#env-environment-variables

--requires-downloaded-inputs <requires_downloaded_inputs>#: Optional flag which indicates that invocations of this action require their inputs downloaded to the working directory before running. This is the default.

--yes#: If action with same name already exists, update the existing action without prompting for confirmation.

roboto actions delete#

usage: roboto actions delete [-h] [--org ORG] action_reference: <action_name>

action_reference: <action_name>#: Exact name of action to delete.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto actions init#

usage: roboto actions init [-h] [path]

path#: Existing directory under which an action package will be created.

-h, --help#: show this help message and exit

roboto actions invoke#

usage: roboto actions invoke [-h] [--org ORG] [--dataset-id DATASET_ID]
                             [--input-data INPUT_DATA [INPUT_DATA ...]]
                             [--timeout TIMEOUT]
                             [--idempotency_id IDEMPOTENCY_ID]
                             [--parameter-value [<PARAMETER_NAME>=<PARAMETER_VALUE> ...]]
                             [--output-dataset-id OUTPUT_DATASET_ID]
                             [--vcpu {256,512,1024,2048,4096,8192,16384}]
                             [--memory MEMORY] [--storage STORAGE] [--gpu]
                             [--entrypoint ENTRY_POINT] [--command COMMAND]
                             [--command-form {exec,shell}] [--workdir WORKDIR]
                             [--env [KEY=VALUE ...]]
                             <action_name> | <action_name>@<digest> |
                             <org>/<action_name> |
                             <org>/<action_name>@<digest>

<action_name> | <action_name>@<digest> | <org>/<action_name> | <org>/<action_name>@<digest>: Partially or fully qualified reference to Action on which to operate.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--dataset-id <dataset_id>#: Unique identifier for dataset to use as data source for this invocation. Required if –input-data is provided.

--input-data <input_data>#: One or many file patterns for data to download from the data source. Examples: front camera images, --input-data '**/cam_front/*.jpg'; front and rear camera images, --input-data '**/cam_front/*.jpg' --input-data '**/cam_rear/*.jpg'; all data, --input-data '**/*'. Required if –dataset-id is provided.

--timeout#: Optional timeout for an action in minutes, defaults to 30 minutes or 12 hours depending on tier.

--idempotency_id <idempotency_id>#: Optional unique ID which ensures that an invocation is run exactly once.

--parameter-value#: Zero or more <parameter_name>=<parameter_value> pairs. parameter_value is parsed as JSON.

--output-dataset-id <output_dataset_id>#: Unique identifier for a dataset to which any files written to the invocation’s output directory will be uploaded.

--vcpu {256,512,1024,2048,4096,8192,16384}#: CPU units to dedicate to action invocation. Defaults to 512 (0.5vCPU).

--memory <memory>#: Memory (in MiB) to dedicate to action invocation. Defaults to 1024 (1 GiB). Supported values range from 512 (0.5 GiB) to 122880 (120 GiB). Supported values are tied to selected vCPU resources. See documentation for more information.

--storage <storage>#: Ephemeral storage (in GiB) to dedicate to action invocation. Defaults to 21 GiB. Supported values range from 21 to 200, inclusive.

--gpu#: This is a placeholder; it currently does nothing. In the future, setting this option will invoke the action in a GPU-enabled compute environment.

--entrypoint <entry_point>#: Container ENTRYPOINT override. Supports passing empty string (“”) as an override, which unsets the ENTRYPOINT specified in the docker image. If updating or invoking action which has existing ENTRYPOINT override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#entrypoint and https://docs.docker.com/engine/reference/run/#entrypoint-default-command-to-execute-at-runtime

--command <command>#: Container CMD override. If updating or invoking action which has existing CMD override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#cmd and https://docs.docker.com/engine/reference/run/#cmd-default-command-or-options

--command-form {exec,shell}#: In exec form, the provided --command str is split into a list of strings (e.g., --command "-c 'print(123)'" is parsed as ["-c", "print(123)"]). In shell form, the provided --command str is not split (e.g., --command "python -c 'print(123)'" is parsed as ["python -c 'print(123)'"]).

--workdir <workdir>#: If updating, specify null to clear existing workdir. Refer to docker documentation for more: https://docs.docker.com/engine/reference/run/#workdir

--env#: Zero or more <key>=<value> formatted pairs to set as container ENV vars. Do not use ENV vars for secrets (such as API keys). See documentation: https://docs.docker.com/engine/reference/run/#env-environment-variables

roboto actions list-invocations#

usage: roboto actions list-invocations [-h] [--org ORG]
                                       <action_name> | <action_name>@<digest>
                                       | <org>/<action_name> |
                                       <org>/<action_name>@<digest>

<action_name> | <action_name>@<digest> | <org>/<action_name> | <org>/<action_name>@<digest>: Partially or fully qualified reference to Action on which to operate.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto actions search#

usage: roboto actions search [-h] [--name NAME] [--actionhub]
                             [--metadata [KEY=VALUE ...]] [--tag [TAG ...]]
                             [--org ORG]

-h, --help#: show this help message and exit

--name <name>#: If querying by action name, must provide an exact match; patterns are not accepted.

--actionhub#: Search Actions published to the Roboto Action Hub

--metadata#: Zero or more key=value pairs which represent action metadata. value is parsed as JSON. e.g. --metadata foo=bar --metadata baz.nested=200

--tag <tag>#: One or more tags associated with this action. e.g. --tag foo --tag bar

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto actions show#

usage: roboto actions show [-h] [--org ORG]
                           <action_name> | <action_name>@<digest> |
                           <org>/<action_name> | <org>/<action_name>@<digest>

<action_name> | <action_name>@<digest> | <org>/<action_name> | <org>/<action_name>@<digest>: Partially or fully qualified reference to Action on which to operate.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto actions update#

usage: roboto actions update [-h] [--description DESCRIPTION]
                             [--short-description SHORT_DESCRIPTION]
                             [--image IMAGE] [--timeout TIMEOUT]
                             [--put-parameter ['name=<name>|required=<true|false>|default=<value>|description=<description>' ...]]
                             [--remove-parameter [PARAMETER_NAME ...]]
                             [--put-tags [PUT_TAGS ...]]
                             [--remove-tags [REMOVE_TAGS ...]]
                             [--put-metadata [KEY_PATH=VALUE ...]]
                             [--remove-metadata [KEY_PATH ...]] [--org ORG]
                             [--vcpu {256,512,1024,2048,4096,8192,16384}]
                             [--memory MEMORY] [--storage STORAGE] [--gpu]
                             [--entrypoint ENTRY_POINT] [--command COMMAND]
                             [--command-form {exec,shell}] [--workdir WORKDIR]
                             [--env [KEY=VALUE ...]]
                             action_reference: <action_name>

action_reference: <action_name>#: Exact name of action to update.

-h, --help#: show this help message and exit

--description <description>#: Optional description of action. Specify null to unset existing description.

--short-description <short_description>#: Optional short description of an action. Specify null to unset existing description.

--image <image>#: Register a Docker image with this action. Can neither be unset nor set an empty string.

--timeout#: Optional timeout for an action in minutes, defaults to 30 minutes or 12 hours depending on tier.

--put-parameter#: Add parameter(s) or overwrite existing parameter(s) with the same name. Argument values must be wrapped in quotes. e.g. --put-parameter 'name=my_param|required=true|description=My description of my_param'

--remove-parameter <parameter_name>#: Remove parameter(s) with the given name(s).

--put-tags <put_tags>#: Add each tag in this sequence if it doesn’t exist

--remove-tags <remove_tags>#: Remove each tag in this sequence if it exists

--put-metadata#: Zero or more key_path=value formatted pairs. An attempt is made to parse value as JSON; if this fails, value is stored as a string. If key_path already exists, existing value will be overwritten. Dot notation is supported for nested keys. Examples: --put-metadata 'key1=value1' 'key2.subkey1=value2' 'key3.sublist1=["a","b","c"]'

--remove-metadata <key_path>#: Remove each key from dataset metadata if it exists. Dot notation is supported for nested keys. e.g. --remove-metadata key1 key2.subkey3

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--vcpu {256,512,1024,2048,4096,8192,16384}#: CPU units to dedicate to action invocation. Defaults to 512 (0.5vCPU).

--memory <memory>#: Memory (in MiB) to dedicate to action invocation. Defaults to 1024 (1 GiB). Supported values range from 512 (0.5 GiB) to 122880 (120 GiB). Supported values are tied to selected vCPU resources. See documentation for more information.

--storage <storage>#: Ephemeral storage (in GiB) to dedicate to action invocation. Defaults to 21 GiB. Supported values range from 21 to 200, inclusive.

--gpu#: This is a placeholder; it currently does nothing. In the future, setting this option will invoke the action in a GPU-enabled compute environment.

--entrypoint <entry_point>#: Container ENTRYPOINT override. Supports passing empty string (“”) as an override, which unsets the ENTRYPOINT specified in the docker image. If updating or invoking action which has existing ENTRYPOINT override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#entrypoint and https://docs.docker.com/engine/reference/run/#entrypoint-default-command-to-execute-at-runtime

--command <command>#: Container CMD override. If updating or invoking action which has existing CMD override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#cmd and https://docs.docker.com/engine/reference/run/#cmd-default-command-or-options

--command-form {exec,shell}#: In exec form, the provided --command str is split into a list of strings (e.g., --command "-c 'print(123)'" is parsed as ["-c", "print(123)"]). In shell form, the provided --command str is not split (e.g., --command "python -c 'print(123)'" is parsed as ["python -c 'print(123)'"]).

--workdir <workdir>#: If updating, specify null to clear existing workdir. Refer to docker documentation for more: https://docs.docker.com/engine/reference/run/#workdir

--env#: Zero or more <key>=<value> formatted pairs to set as container ENV vars. Do not use ENV vars for secrets (such as API keys). See documentation: https://docs.docker.com/engine/reference/run/#env-environment-variables

roboto collections#

usage: roboto collections [-h] {changelog,create,delete,list,show,update} ...

-h, --help#: show this help message and exit

roboto collections changelog#

usage: roboto collections changelog [-h] [--from-version FROM_VERSION]
                                    [--to-version TO_VERSION]
                                    collection_id

collection_id#: A unique ID used to reference a collection of Roboto resources.

-h, --help#: show this help message and exit

--from-version <from_version>#: A collection version to use as the starting point in change-set listing. Defaults to initial.

--to-version <to_version>#: A collection version to use as the end point in change-set listing. Defaults to latest.

roboto collections create#

usage: roboto collections create [-h] [--name NAME]
                                 [--description DESCRIPTION]
                                 [--dataset-id [DATASET_ID ...]]
                                 [--file-id [FILE_ID ...]] [--tag [TAG ...]]
                                 [--org ORG]

-h, --help#: show this help message and exit

--name <name>#: A human-readable name for this collection. Does not need to be unique.

--description <description>#: Information about what’s in this collection

--dataset-id <dataset_id>#: Initial datasets to add to this collection.

--file-id <file_id>#: Initial files to add to this collection.

--tag <tag>#: Tags that make it easier to discover this collection.

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto collections delete#

usage: roboto collections delete [-h] collection_id

collection_id#: A unique ID used to reference a collection of Roboto resources.

-h, --help#: show this help message and exit

roboto collections list#

usage: roboto collections list [-h] [--org ORG]

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto collections show#

usage: roboto collections show [-h] [-v COLLECTION_VERSION]
                               [--content-mode {summary_only,references,full}]
                               collection_id

collection_id#: A unique ID used to reference a collection of Roboto resources.

-h, --help#: show this help message and exit

-v <collection_version>, --collection-version <collection_version>#: An optional version for the provided collection ID. Allows caller to ensure that they’re referencing an immutable representation of a given collection.

--content-mode {summary_only,references,full}#: The type of content to return for a collection or set of collections. summary_only returns only metadata, references will return each id in the collection, and full will retrieve the full content of each resource in the collection.

roboto collections update#

usage: roboto collections update [-h] [--name NAME]
                                 [--description DESCRIPTION]
                                 [--add-dataset-id [ADD_DATASET_ID ...]]
                                 [--add-file-id [ADD_FILE_ID ...]]
                                 [--remove-dataset-id [REMOVE_DATASET_ID ...]]
                                 [--remove-file-id [REMOVE_FILE_ID ...]]
                                 [--add-tag [ADD_TAG ...]]
                                 [--remove-tag [REMOVE_TAG ...]]
                                 collection_id

collection_id#: A unique ID used to reference a collection of Roboto resources.

-h, --help#: show this help message and exit

--name <name>#: A human-readable name for this collection. Does not need to be unique.

--description <description>#: Information about what’s in this collection

--add-dataset-id <add_dataset_id>#: Datasets to add to this collection.

--add-file-id <add_file_id>#: Files to add to this collection.

--remove-dataset-id <remove_dataset_id>#: Datasets to remove from this collection.

--remove-file-id <remove_file_id>#: Files to remove from this collection.

--add-tag <add_tag>#: Tags to add to this collection.

--remove-tag <remove_tag>#: Tags to remove from this collection.

roboto datasets#

usage: roboto datasets [-h]
                       {create,delete,delete-files,download-files,import-external-file,list-files,search,show,update,upload-files}
                       ...

-h, --help#: show this help message and exit

roboto datasets create#

usage: roboto datasets create [-h] [-m [KEY=VALUE ...]] [-t [TAG ...]]
                              [-d DESCRIPTION] [-n NAME] [--org ORG]

-h, --help#: show this help message and exit

-m, --metadata#: Zero or more <key>=<value> pairs to add to this dataset’s metadata. Metadata can be modified after creation.

-t <tag>, --tag <tag>#: One or more tags to add to this dataset. Tags can be modified after creation.

-d <description>, --description <description>#: A human readable description of this dataset.

-n <name>, --name <name>#: A human readable name for this dataset.

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto datasets delete#

usage: roboto datasets delete [-h] -d DATASET_ID

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

roboto datasets delete-files#

usage: roboto datasets delete-files [-h] -d DATASET_ID [-i [INCLUDE ...]]
                                    [-x [EXCLUDE ...]]

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

-i <include>, --include <include>#: Zero or more include filters

-x <exclude>, --exclude <exclude>#: Zero or more exclude filters

roboto datasets download-files#

usage: roboto datasets download-files [-h] -d DATASET_ID -p PATH
                                      [-i [INCLUDE ...]] [-x [EXCLUDE ...]]

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

-p <path>, --path <path>#: The download destination for this operation.

-i <include>, --include <include>#: Zero or more include filters (if path points to a directory)

-x <exclude>, --exclude <exclude>#: Zero or more exclude filters (if path points to a directory)

roboto datasets import-external-file#

usage: roboto datasets import-external-file [-h] -d DATASET_ID [-p PATH]
                                            [-f FILE]

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

-p <path>, --path <path>#: Destination path within the dataset (relative to the root) where the file will be imported. Defaults to the filename at the dataset root if not specified.

-f <file>, --file <file>#: The URI of the file to import, e.g. s3://my-bucket/path/to/file.txt for S3 files.

roboto datasets list-files#

usage: roboto datasets list-files [-h] -d DATASET_ID [-i [INCLUDE ...]]
                                  [-x [EXCLUDE ...]]

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

-i <include>, --include <include>#: Zero or more include filters (if path points to a directory)

-x <exclude>, --exclude <exclude>#: Zero or more exclude filters (if path points to a directory)

roboto datasets search#

usage: roboto datasets search [-h] [--metadata [KEY=VALUE ...]]
                              [--tag [TAG ...]] [--org ORG]

-h, --help#: show this help message and exit

--metadata#: Zero or more <key>=<value> pairs which represent dataset metadata. value is parsed as JSON. e.g. –metadata foo=bar –metadata baz.nested=200

--tag <tag>#: One or more tags associated with this dataset. e.g. --tag foo --tag bar

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto datasets show#

usage: roboto datasets show [-h] -d DATASET_ID

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

roboto datasets update#

usage: roboto datasets update [-h] -d DATASET_ID [--description DESCRIPTION]
                              [--name NAME] [--put-tags [PUT_TAGS ...]]
                              [--remove-tags [REMOVE_TAGS ...]]
                              [--put-metadata [KEY_PATH=VALUE ...]]
                              [--remove-metadata [KEY_PATH ...]]

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

--description <description>#: A new description to add to this dataset

--name <name>#: A new name for this dataset

--put-tags <put_tags>#: Add each tag in this sequence if it doesn’t exist

--remove-tags <remove_tags>#: Remove each tag in this sequence if it exists

--put-metadata#: Zero or more <key>=<value> formatted pairs. An attempt is made to parse value as JSON; if this fails, value is stored as a string. If key already exists, existing value will be overwritten. Dot notation is supported for nested keys. Examples: --put-metadata 'key1=value1' 'key2.subkey1=value2' 'key3.sublist1=["a","b","c"]'

--remove-metadata <key_path>#: Remove each key from dataset metadata if it exists. Dot notation is supported for nested keys. e.g. --remove-metadata key1 key2.subkey3

roboto datasets upload-files#

usage: roboto datasets upload-files [-h] -d DATASET_ID -p PATH
                                    [-x [EXCLUDE ...]]

-h, --help#: show this help message and exit

-d <dataset_id>, --dataset-id <dataset_id>#: A unique ID used to reference a single dataset

-p <path>, --path <path>#: The path to a file or directory to upload.

-x <exclude>, --exclude <exclude>#: Zero or more exclude filters (if path points to a directory)

roboto devices#

usage: roboto devices [-h]
                      {delete,disable,enable,generate-creds,list,register,show}
                      ...

-h, --help#: show this help message and exit

roboto devices delete#

usage: roboto devices delete [-h] [--org ORG] device_id

device_id#: The device ID of the target device.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto devices disable#

usage: roboto devices disable [-h] [--org ORG] device_id

device_id#: The device ID of the target device.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto devices enable#

usage: roboto devices enable [-h] [--org ORG] device_id

device_id#: The device ID of the target device.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto devices generate-creds#

usage: roboto devices generate-creds [-h] [--org ORG] [-f CONFIG_FILE]
                                     device_id

device_id#: The device ID of the target device.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

-f <config_file>, --config-file <config_file>#: Where on local disk to save the config file containing the device’s generated Roboto credentials. Defaults to ‘config.json’ in the current directory.

roboto devices list#

usage: roboto devices list [-h] [--org ORG]

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto devices register#

usage: roboto devices register [-h] [-f CONFIG_FILE] [--org ORG] device_id

device_id#: The device ID of the target device.

-h, --help#: show this help message and exit

-f <config_file>, --config-file <config_file>#: Where on local disk to save the config file containing the newly registered device’s Roboto credentials. Defaults to ‘config.json’ in the current directory.

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto devices show#

usage: roboto devices show [-h] [--org ORG] device_id

device_id#: The device ID of the target device.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto images#

usage: roboto images [-h]
                     {delete-image,delete-repository,list,list-repos,login,pull,push}
                     ...

-h, --help#: show this help message and exit

roboto images delete-image#

usage: roboto images delete-image [-h] [--org ORG] remote_image

remote_image#: Specify the remote image to delete, in the format <repository>:<tag>.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto images delete-repository#

usage: roboto images delete-repository [-h] [--org ORG] [--force]
                                       repository_name

repository_name#: The name of the image repository to delete.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--force#: Force deletion of the repository, even if it is not empty.

roboto images list#

usage: roboto images list [-h] [--org ORG] [--repository-name REPOSITORY_NAME]

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--repository-name <repository_name>#: Filter list of images by repository name.

roboto images list-repos#

usage: roboto images list-repos [-h] [--org ORG]

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto images login#

usage: roboto images login [-h] [--org ORG] --repository-uri REPOSITORY_URI
                           [--permissions {ReadOnly,ReadWrite}]

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--repository-uri <repository_uri>#: Image repository within Roboto’s image registry. Login credentials will be scoped to this repository.

--permissions {ReadOnly,ReadWrite}#: Specify the access level for the temporary credentials.

roboto images pull#

usage: roboto images pull [-h] [--org ORG] remote_image

remote_image#: Specify the remote image to pull, in the format <repository>:<tag>.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto images push#

usage: roboto images push [-h] [--org ORG] [-q] local_image

local_image#: Specify the local image to push, in the format <repository>:<tag>. If no tag is specified, latest is assumed. Image must exist locally (i.e. docker images must list it).

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

-q, --quiet#: Only output the image URI, terminated by a newline, if successful.

roboto invocations#

usage: roboto invocations [-h] {cancel,cancel-all,logs,show,status} ...

-h, --help#: show this help message and exit

roboto invocations cancel#

usage: roboto invocations cancel [-h] invocation_id

invocation_id#

-h, --help#: show this help message and exit

roboto invocations cancel-all#

usage: roboto invocations cancel-all [-h] [--org ORG] [--timeout TIMEOUT]

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--timeout <timeout>#: Amount of time to wait before giving up attempting to cancel active invocations. Defaults to -1, which is interpretted as ‘try forever’.

roboto invocations logs#

usage: roboto invocations logs [-h] [--tail] invocation_id

invocation_id#

-h, --help#: show this help message and exit

--tail#

roboto invocations show#

usage: roboto invocations show [-h] invocation_id

invocation_id#

-h, --help#: show this help message and exit

roboto invocations status#

usage: roboto invocations status [-h] [--tail] invocation_id

invocation_id#

-h, --help#: show this help message and exit

--tail#

roboto orgs#

usage: roboto orgs [-h]
                   {add-role,bind-email-domain,delete,invite-user,list-email-domains,list-invites,members,register-bucket,remove-role,remove-user,show,unbind-email-domain}
                   ...

-h, --help#: show this help message and exit

roboto orgs add-role#

usage: roboto orgs add-role [-h] --user USER
                            [--role {OrgRoleName.admin,OrgRoleName.owner}]
                            [--org ORG]

-h, --help#: show this help message and exit

--user <user>#: The user_id of the user to add a role for.

--role {OrgRoleName.admin,OrgRoleName.owner}#: The role to grant to the specified user

--org <org>#: The org_id of the org for which to add permissions for the specified user. Required only if the caller is a member of more than one org.

roboto orgs bind-email-domain#

usage: roboto orgs bind-email-domain [-h] [--org ORG] --email-domain
                                     EMAIL_DOMAIN

-h, --help#: show this help message and exit

--org <org>#: The org_id of the org for which to bind an email domain. This parameter is only required if the caller is a member of more than one org, otherwise this action will be performed implicitly on their single org.

--email-domain <email_domain>#: The email domain to bind to an org.

roboto orgs delete#

usage: roboto orgs delete [-h] --org ORG [--ignore-prompt]

-h, --help#: show this help message and exit

--org <org>#: The org_id for the org you’re about to delete.

--ignore-prompt#: Ignore the prompt which asks you to confirm that you’d like to delete your org.

roboto orgs invite-user#

usage: roboto orgs invite-user [-h] --user USER [--org ORG]

-h, --help#: show this help message and exit

--user <user>#: The user_id of the user to invite.

--org <org>#: The org_id of the org to invite a user to. Required only if the caller is a member of more than one org.

roboto orgs list-email-domains#

usage: roboto orgs list-email-domains [-h] [--org ORG]

-h, --help#: show this help message and exit

--org <org>#: The org_id of the org for which to list bound email domains. This parameter is only required if the caller is a member of more than one org, otherwise this action will be performed implicitly on their single org.

roboto orgs list-invites#

usage: roboto orgs list-invites [-h] [--org ORG]

-h, --help#: show this help message and exit

--org <org>#: The org_id of the org to view invites for. Required only if the caller is a member of more than one org.

roboto orgs members#

usage: roboto orgs members [-h] [--org ORG]

-h, --help#: show this help message and exit

--org <org>#: The org_id for the org you want to see.

roboto orgs register-bucket#

usage: roboto orgs register-bucket [-h] [--org ORG] --bucket-name BUCKET_NAME
                                   --aws-account AWS_ACCOUNT

-h, --help#: show this help message and exit

--org <org>#: The org_id of the org for which to register an S3 bring-your-own-bucket. This parameter is only required if the caller is a member of more than one org, otherwise this action will be performed implicitly on their single org.

--bucket-name <bucket_name>#: The base name of the S3 bucket you want to register, e.g. ‘my-company-roboto-byob’

--aws-account <aws_account>#: The AWS account to register the bucket in. This command will only work if you also have the calling environment configured with AWS credentials for this account that the underlying boto3 client can use. For more information on configuring AWS credentials, see https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html.

roboto orgs remove-role#

usage: roboto orgs remove-role [-h] --user USER
                               [--role {OrgRoleName.admin,OrgRoleName.owner}]
                               [--org ORG]

-h, --help#: show this help message and exit

--user <user>#: The user_id of the user to add a role for. This can be your own user_id if you would like to step down as an admin or owner.

--role {OrgRoleName.admin,OrgRoleName.owner}#: The role to remove for the specified user

--org <org>#: The org_id of the org for which to remove permissions for the specified user. Required only if the caller is a member of more than one org.

roboto orgs remove-user#

usage: roboto orgs remove-user [-h] --user USER [--org ORG]

-h, --help#: show this help message and exit

--user <user>#: The user_id of the user to remove.

--org <org>#: The org_id of the org to remove a user from. Required only if the caller is a member of more than one org.

roboto orgs show#

usage: roboto orgs show [-h] [--org ORG]

-h, --help#: show this help message and exit

--org <org>#: The org_id for the org you want to see.

roboto orgs unbind-email-domain#

usage: roboto orgs unbind-email-domain [-h] [--org ORG] --email-domain
                                       EMAIL_DOMAIN

-h, --help#: show this help message and exit

--org <org>#: The org_id of the org for which to unbind an email domain. This parameter is only required if the caller is a member of more than one org, otherwise this action will be performed implicitly on their single org.

--email-domain <email_domain>#: The email domain to unbind from an org.

roboto tokens#

usage: roboto tokens [-h] {create,delete,list,show} ...

-h, --help#: show this help message and exit

roboto tokens create#

usage: roboto tokens create [-h] --name NAME [--description DESCRIPTION]
                            [--expiry-days {30,60,90}]

-h, --help#: show this help message and exit

--name <name>#: A human readable name for this token.

--description <description>#: An optional description for this token.

--expiry-days {30,60,90}#: The number of days this token will be valid for.

roboto tokens delete#

usage: roboto tokens delete [-h] --id ID

-h, --help#: show this help message and exit

--id <id>#: The token_id for a token to delete.

roboto tokens list#

usage: roboto tokens list [-h]

-h, --help#: show this help message and exit

roboto tokens show#

usage: roboto tokens show [-h] --id ID

-h, --help#: show this help message and exit

--id <id>#: The token_id for a token to look up.

roboto triggers#

usage: roboto triggers [-h] {create,delete,get,search,update} ...

-h, --help#: show this help message and exit

roboto triggers create#

usage: roboto triggers create [-h] --name NAME --action <action_name> |
                              <action_name>@<digest> | <org>/<action_name> |
                              <org>/<action_name>@<digest> --required-inputs
                              INPUT_DATA [INPUT_DATA ...]
                              [--additional-inputs ADDITIONAL_INPUTS [ADDITIONAL_INPUTS ...]]
                              [--parameter-value [<PARAMETER_NAME>=<PARAMETER_VALUE> ...]]
                              [--timeout TIMEOUT] [--org ORG]
                              [--vcpu {256,512,1024,2048,4096,8192,16384}]
                              [--memory MEMORY] [--storage STORAGE] [--gpu]
                              [--entrypoint ENTRY_POINT] [--command COMMAND]
                              [--command-form {exec,shell}]
                              [--workdir WORKDIR] [--env [KEY=VALUE ...]]
                              [--for-each {dataset,dataset_file}]
                              [--condition-json CONDITION_JSON]
                              [--required-tag [REQUIRED_TAG ...]]
                              [--required-metadata [REQUIRED_METADATA ...]]

-h, --help#: show this help message and exit

--name <name>#: The unique name used to reference a trigger.

--action#: Partially or fully qualified reference to the action to be triggered.

--required-inputs <input_data>#: One or many file patterns for data to download from the data source. Examples: front camera images, --required-inputs '**/cam_front/*.jpg'; front and rear camera images, --required-inputs'**/cam_front/*.jpg' --required-inputs '**/cam_rear/*.jpg'; all data, --required-inputs '**/*'.

--additional-inputs <additional_inputs>#: One or many file patterns for data to download from the data source which is NOT considered as part of trigger evaluation. Example: front camera images, --additional-inputs '**/cam_front/*.jpg'.

--parameter-value#: Zero or more <parameter_name>=<parameter_value> pairs to pass to the invocation. parameter_value is parsed as JSON.

--timeout#: Optional timeout for an action in minutes, defaults to 30 minutes or 12 hours depending on tier.

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--vcpu {256,512,1024,2048,4096,8192,16384}#: CPU units to dedicate to action invocation. Defaults to 512 (0.5vCPU).

--memory <memory>#: Memory (in MiB) to dedicate to action invocation. Defaults to 1024 (1 GiB). Supported values range from 512 (0.5 GiB) to 122880 (120 GiB). Supported values are tied to selected vCPU resources. See documentation for more information.

--storage <storage>#: Ephemeral storage (in GiB) to dedicate to action invocation. Defaults to 21 GiB. Supported values range from 21 to 200, inclusive.

--gpu#: This is a placeholder; it currently does nothing. In the future, setting this option will invoke the action in a GPU-enabled compute environment.

--entrypoint <entry_point>#: Container ENTRYPOINT override. Supports passing empty string (“”) as an override, which unsets the ENTRYPOINT specified in the docker image. If updating or invoking action which has existing ENTRYPOINT override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#entrypoint and https://docs.docker.com/engine/reference/run/#entrypoint-default-command-to-execute-at-runtime

--command <command>#: Container CMD override. If updating or invoking action which has existing CMD override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#cmd and https://docs.docker.com/engine/reference/run/#cmd-default-command-or-options

--command-form {exec,shell}#: In exec form, the provided --command str is split into a list of strings (e.g., --command "-c 'print(123)'" is parsed as ["-c", "print(123)"]). In shell form, the provided --command str is not split (e.g., --command "python -c 'print(123)'" is parsed as ["python -c 'print(123)'"]).

--workdir <workdir>#: If updating, specify null to clear existing workdir. Refer to docker documentation for more: https://docs.docker.com/engine/reference/run/#workdir

--env#: Zero or more <key>=<value> formatted pairs to set as container ENV vars. Do not use ENV vars for secrets (such as API keys). See documentation: https://docs.docker.com/engine/reference/run/#env-environment-variables

--for-each {dataset,dataset_file}#: Primitive against which this trigger will spawn invocations.

--condition-json <condition_json>#: Inline JSON or a reference to a JSON file which expresses a dataset metadata and tag condition which must be met for this trigger to run against a given dataset. If provided, ‘required-tag’ and ‘required-metadata’ cannot be provided.

--required-tag <required_tag>#: Dataset tags which must be present for this trigger to run against a given dataset. If provided, these are used to construct a trigger condition, and as such they cannot be used if ‘condition-json’ is specified.

--required-metadata#: Dataset metadata key=value conditions which all must be met for this trigger to run against a given dataset. If provided, these are used to construct a trigger condition, and as such they cannot be used if condition-json is specified.

roboto triggers delete#

usage: roboto triggers delete [-h] [--org ORG] trigger_name

trigger_name#: The unique name used to reference a trigger.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto triggers get#

usage: roboto triggers get [-h] [--org ORG] trigger_name

trigger_name#: The unique name used to reference a trigger.

-h, --help#: show this help message and exit

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto triggers search#

usage: roboto triggers search [-h] [--name NAME]
                              [--action <action_name> | <action_name>@<digest> | <org>/<action_name> | <org>/<action_name>@<digest>]
                              [--org ORG]

-h, --help#: show this help message and exit

--name <name>#: Query by trigger name. Must provide an exact match; patterns are not accepted.

--action#: Query by partially or fully qualified reference to the action to be triggered.

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

roboto triggers update#

usage: roboto triggers update [-h]
                              [--action <action_name> | <action_name>@<digest> | <org>/<action_name> | <org>/<action_name>@<digest>]
                              [--required-inputs REQUIRED_INPUTS [REQUIRED_INPUTS ...]]
                              [--additional-inputs ADDITIONAL_INPUTS [ADDITIONAL_INPUTS ...]]
                              [--timeout TIMEOUT] [--org ORG]
                              [--vcpu {256,512,1024,2048,4096,8192,16384}]
                              [--memory MEMORY] [--storage STORAGE] [--gpu]
                              [--entrypoint ENTRY_POINT] [--command COMMAND]
                              [--command-form {exec,shell}]
                              [--workdir WORKDIR] [--env [KEY=VALUE ...]]
                              [--condition-json CONDITION_JSON]
                              [--required-tag [REQUIRED_TAG ...]]
                              [--required-metadata [REQUIRED_METADATA ...]]
                              [--for-each {dataset,dataset_file}] [--enabled]
                              [--disabled] [--clear-condition]
                              [--parameter-value [<PARAMETER_NAME>=<PARAMETER_VALUE> ...]]
                              trigger_name

trigger_name#: The unique name used to reference a trigger.

-h, --help#: show this help message and exit

--action#: Partially or fully qualified reference to the action to be triggered.

--required-inputs <required_inputs>#: One or many file patterns for data to download from the data source. Examples: front camera images, --required-inputs '**/cam_front/*.jpg'; front and rear camera images, --required-inputs '**/cam_front/*.jpg' --required-inputs '**/cam_rear/*.jpg'; all data, --required-inputs '**/*'.

--additional-inputs <additional_inputs>#: One or many file patterns for data to download from the data source which is NOT considered as part of trigger evaluation. Example: front camera images, --additional-inputs '**/cam_front/*.jpg'.

--timeout#: Optional timeout for an action in minutes, defaults to 30 minutes or 12 hours depending on tier.

--org <org>#: The calling organization ID. Gets set implicitly if in a single org. The ROBOTO_ORG_ID environment variable can be set to control the default value.

--vcpu {256,512,1024,2048,4096,8192,16384}#: CPU units to dedicate to action invocation. Defaults to 512 (0.5vCPU).

--memory <memory>#: Memory (in MiB) to dedicate to action invocation. Defaults to 1024 (1 GiB). Supported values range from 512 (0.5 GiB) to 122880 (120 GiB). Supported values are tied to selected vCPU resources. See documentation for more information.

--storage <storage>#: Ephemeral storage (in GiB) to dedicate to action invocation. Defaults to 21 GiB. Supported values range from 21 to 200, inclusive.

--gpu#: This is a placeholder; it currently does nothing. In the future, setting this option will invoke the action in a GPU-enabled compute environment.

--entrypoint <entry_point>#: Container ENTRYPOINT override. Supports passing empty string (“”) as an override, which unsets the ENTRYPOINT specified in the docker image. If updating or invoking action which has existing ENTRYPOINT override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#entrypoint and https://docs.docker.com/engine/reference/run/#entrypoint-default-command-to-execute-at-runtime

--command <command>#: Container CMD override. If updating or invoking action which has existing CMD override, specify null to remove the override. Refer to docker documentation for more: https://docs.docker.com/engine/reference/builder/#cmd and https://docs.docker.com/engine/reference/run/#cmd-default-command-or-options

--command-form {exec,shell}#: In exec form, the provided --command str is split into a list of strings (e.g., --command "-c 'print(123)'" is parsed as ["-c", "print(123)"]). In shell form, the provided --command str is not split (e.g., --command "python -c 'print(123)'" is parsed as ["python -c 'print(123)'"]).

--workdir <workdir>#: If updating, specify null to clear existing workdir. Refer to docker documentation for more: https://docs.docker.com/engine/reference/run/#workdir

--env#: Zero or more <key>=<value> formatted pairs to set as container ENV vars. Do not use ENV vars for secrets (such as API keys). See documentation: https://docs.docker.com/engine/reference/run/#env-environment-variables

--condition-json <condition_json>#: Inline JSON or a reference to a JSON file which expresses a dataset metadata and tag condition which must be met for this trigger to run against a given dataset. If provided, ‘required-tag’ and ‘required-metadata’ cannot be provided.

--required-tag <required_tag>#: Dataset tags which must be present for this trigger to run against a given dataset. If provided, these are used to construct a trigger condition, and as such they cannot be used if ‘condition-json’ is specified.

--required-metadata#: Dataset metadata key=value conditions which all must be met for this trigger to run against a given dataset. If provided, these are used to construct a trigger condition, and as such they cannot be used if ‘condition-json’ is specified.

--for-each {dataset,dataset_file}#: Primitive against which this trigger will spawn invocations.

--enabled#: Enables this trigger

--disabled#: Disables this trigger

--clear-condition#: Sets the condition to None

--parameter-value#: Zero or more <parameter_name>=<parameter_value> pairs to pass to the invocation. parameter_value is parsed as JSON.

roboto users#

usage: roboto users [-h] {delete,orgs,show,whoami} ...

-h, --help#: show this help message and exit

roboto users delete#

usage: roboto users delete [-h] [--ignore-prompt]

-h, --help#: show this help message and exit

--ignore-prompt#: Ignore the prompt which asks you to confirm that you’d like to delete your user.

roboto users orgs#

usage: roboto users orgs [-h]

-h, --help#: show this help message and exit

roboto users show#

usage: roboto users show [-h]

-h, --help#: show this help message and exit

roboto users whoami#

usage: roboto users whoami [-h]

-h, --help#: show this help message and exit