CLI#

roboto#

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

usage: roboto [--help] [--log-level {ERROR,WARNING,INFO,DEBUG}] [--verbose]
              [--version] [--profile PROFILE] [--cache-dir CACHE_DIR]
              [--config-file CONFIG_FILE] [--suppress-upgrade-check]
              {actions,cache,chat,collections,datasets,devices,images,invocations,orgs,secrets,tokens,triggers,users,setup,upgrade} ...

options#

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

--log-level {ERROR,WARNING,INFO,DEBUG}#: Set the log level for the CLI. Choices (case-insensitive): ERROR, WARNING, INFO, DEBUG. If not specified, defaults to error.

--verbose, -v#: DEPRECATED: Use –log-level instead. 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.

--cache-dir <cache_dir>#: Override default location of the cache directory used by Roboto internally. Default is platform-dependent. Run roboto cache where to see the current cache directory.

--config-file <config_file>#: Location of the Roboto config file. Defaults to ROBOTO_CONFIG_FILE, then ~/.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,invoke-local,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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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] [--file-query FILE_QUERY]
                             [--session-id SESSION_IDS]
                             [--session-query SESSION_QUERY]
                             [--topic-query TOPIC_QUERY]
                             [--dataset DATASET_ID] [--file-path FILE_PATHS]
                             [--org ORG]
                             [-p <PARAMETER_NAME>=<PARAMETER_VALUE>]
                             [--timeout TIMEOUT]
                             [--idempotency_id IDEMPOTENCY_ID]
                             [--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

--file-query <file_query>#: RoboQL query to select input files.

--session-id <session_ids>#: Unique identifier for a session to use as input. Can be specified multiple times for multiple sessions.

--session-query <session_query>#: RoboQL query to select input sessions.

--topic-query <topic_query>#: RoboQL query to select input topics.

--dataset <dataset_id>#: Unique identifier for a dataset to use as the data source for this invocation. Required if –file-path is provided.

--file-path <file_paths>#: Specific file path from the dataset. Can be specified multiple times for multiple file paths. Requires –dataset to be specified.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

-p, --parameter#: Parameter in <parameter_name>=<parameter_value> format. parameter_value is parsed as a string. Can be specified multiple times for multiple parameters.

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

--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 invoke-local#

usage: roboto actions invoke-local [-h] [--org ORG] [--file-query FILE_QUERY]
                                   [--session-id SESSION_IDS]
                                   [--session-query SESSION_QUERY]
                                   [--topic-query TOPIC_QUERY]
                                   [--dataset DATASET_ID]
                                   [--file-path FILE_PATHS]
                                   [-p <PARAMETER_NAME>=<PARAMETER_VALUE>]
                                   [--workspace-dir WORKSPACE_DIR] [--dry-run]
                                   [action_or_path]

action_or_path#: Action to invoke locally. Can be: - A path to local action directory (e.g., ‘.’, ‘./my-action’, ‘/abs/path’) - An action reference (e.g., ‘my-action’, ‘org/my-action’, ‘action@digest’) - Omitted to use current directory Examples: roboto actions invoke-local # Use current directory (implied) roboto actions invoke-local . # Use current directory (explicit) roboto actions invoke-local ./my-action # Use local action roboto actions invoke-local my-action # Fetch from platform roboto actions invoke-local org/my-action # Fetch from specific 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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--file-query <file_query>#: RoboQL query to select input files.

--session-id <session_ids>#: Unique identifier for a session to use as input. Can be specified multiple times for multiple sessions.

--session-query <session_query>#: RoboQL query to select input sessions.

--topic-query <topic_query>#: RoboQL query to select input topics.

--dataset <dataset_id>#: Unique identifier for a dataset to use as the data source for this invocation. Required if –file-path is provided.

--file-path <file_paths>#: Specific file path from the dataset. Can be specified multiple times for multiple file paths. Requires –dataset to be specified.

-p, --parameter#: Parameter in <parameter_name>=<parameter_value> format. parameter_value is parsed as a string. Can be specified multiple times for multiple parameters.

--workspace-dir <workspace_dir>#: Workspace directory for local execution. Only applicable when invoking a platform action (not an action defined in a local directory). If not specified, a temporary directory is created.

--dry-run#: Run in dry-run mode. Actions should use this flag to gate side effects such as uploading files, modifying metadata, or making non-idempotent API calls.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--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 cache#

usage: roboto cache [-h] {clear,size,where} ...

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

roboto cache clear#

usage: roboto cache clear [-h] [--dry-run]

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

--dry-run#: Print location of cache directory that would be deleted, without performing the delete.

roboto cache size#

usage: roboto cache size [-h]

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

roboto cache where#

usage: roboto cache where [-h]

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

roboto chat#

usage: roboto chat [-h] {start} ...

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

roboto chat start#

usage: roboto chat start [-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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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 [DATASET_ID ...]]
                                 [--event-id EVENT_ID [EVENT_ID ...]]
                                 [--file-id FILE_ID [FILE_ID ...]]
                                 [--session-id SESSION_ID [SESSION_ID ...]]
                                 [--resource-type {file,dataset,event,session}]
                                 [--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.

--event-id <event_id>#: Initial events to add to this collection.

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

--session-id <session_id>#: Initial sessions to add to this collection.

--resource-type {file,dataset,event,session}#: The type of resources this collection holds. Inferred from –file-id, –dataset-id, –event-id, or –session-id if not provided. Defaults to ‘file’ with a warning when neither is given.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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_DATASET_ID ...]]
                                 [--add-event-id ADD_EVENT_ID [ADD_EVENT_ID ...]]
                                 [--add-file-id ADD_FILE_ID [ADD_FILE_ID ...]]
                                 [--add-session-id ADD_SESSION_ID [ADD_SESSION_ID ...]]
                                 [--remove-dataset-id REMOVE_DATASET_ID [REMOVE_DATASET_ID ...]]
                                 [--remove-event-id REMOVE_EVENT_ID [REMOVE_EVENT_ID ...]]
                                 [--remove-file-id REMOVE_FILE_ID [REMOVE_FILE_ID ...]]
                                 [--remove-session-id REMOVE_SESSION_ID [REMOVE_SESSION_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-event-id <add_event_id>#: Events to add to this collection.

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

--add-session-id <add_session_id>#: Sessions to add to this collection.

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

--remove-event-id <remove_event_id>#: Events to remove from this collection.

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

--remove-session-id <remove_session_id>#: Sessions 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,rename-directory,rename-file,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]
                              [--device-id DEVICE_ID] [--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.

--device-id <device_id>#: The device ID to associate with this dataset. The device must already exist in the organization.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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 rename-directory#

usage: roboto datasets rename-directory [-h] -d DATASET_ID -o OLD_PATH
                                        -p NEW_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

-o <old_path>, --old-path <old_path>#: Current path of the directory, relative to the dataset root. Example: ‘logs/session1’.

-p <new_path>, --new-path <new_path>#: New path for the directory, relative to the dataset root. Use a path with fewer components to move the directory up the tree, a different name at the same depth to rename in place, or a path under a different parent to move sideways. Example: ‘session1’ to move ‘logs/session1’ up one level.

roboto datasets rename-file#

usage: roboto datasets rename-file [-h] -d DATASET_ID -f FILE_ID -p NEW_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

-f <file_id>, --file-id <file_id>#: ID of the file to rename or move.

-p <new_path>, --new-path <new_path>#: New path for the file, relative to the dataset root. Use a path with fewer components to move the file up the directory tree, a different name at the same depth to rename in place, or a path under a different directory to move sideways. Example: ‘logs/session1.bag’ or ‘session1.bag’.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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 ...]]
                              [--device-id DEVICE_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

--description <description>#: A new description to add to this dataset. Specify null to clear the description.

--name <name>#: A new name for this dataset. Specify null to clear the name.

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

--device-id <device_id>#: Set or update the device ID associated with this dataset. Specify null to clear the device association.

roboto datasets upload-files#

usage: roboto datasets upload-files [-h] -d DATASET_ID [--device-id DEVICE_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

--device-id <device_id>#: The device ID to associate with these files. The device must already exist in the organization.

-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] [--keep-files] 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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--keep-files#: Move the device’s files to the org root under devices/<universal_device_id>/ instead of deleting them. Links among the device’s files are deleted either way.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto devices generate-creds#

usage: roboto devices generate-creds [-h] [--org ORG] [-f OUTPUT_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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

-f <output_config_file>, --config-file <output_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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto devices register#

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

device_id#: The device ID of the target device.

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

-f <output_config_file>, --config-file <output_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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

-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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

--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 {admin,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 {admin,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 {admin,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 {admin,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 secrets#

usage: roboto secrets [-h] {delete,list,write} ...

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

roboto secrets delete#

usage: roboto secrets delete [-h] [--org ORG] secret_name

secret_name#: The name of the secret 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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto secrets list#

usage: roboto secrets 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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto secrets write#

usage: roboto secrets write [-h] [--org ORG] secret_name secret_value

secret_name#: The name of the secret to write.

secret_value#: The value to write to the secret.

-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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto setup#

Set up this machine to use Roboto from the command line, the Python SDK, and your AI tools. Checks your access token, or asks for one, and asks which organization to use by default if you belong to several. For the AI tools you choose among Claude Code, Codex, Cursor, and VS Code, installs Roboto’s agent skills and adds the Roboto MCP server, then signs Claude Code and Codex in to it. Checks for uv and Docker, which the skills use, and offers to install uv. Running it again updates the agent skills and changes nothing else that is already set up.

usage: roboto setup [-h] [--no-input] [--skip-skills] [--skip-mcp]
                    [--mcp-url MCP_URL]

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

--no-input#: Ask nothing: report a missing access token or default organization, connect every AI tool found, and skip each sign-in and the offer to install uv. Implied when standard input isn’t a terminal.

--skip-skills#: Don’t install Roboto’s agent skills or check for uv and Docker.

--skip-mcp#: Don’t add the Roboto MCP server to your AI tools.

--mcp-url <mcp_url>#: Address of the Roboto MCP server to add. Defaults to https://mcp.roboto.ai/mcp.

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,disable,dry-run,enable,get,list,sample,update} ...

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

roboto triggers create#

usage: roboto triggers create [-h] --name NAME
                              [--on {dataset.created,dataset.metadata_updated,dataset.tag_added,dataset.upload_completed,event.created,file.ingested,file.metadata_updated,file.uploaded,invocation.completed,invocation.failed,session.created,session.file_added,session.updated} [{dataset.created,dataset.metadata_updated,dataset.tag_added,dataset.upload_completed,event.created,file.ingested,file.metadata_updated,file.uploaded,invocation.completed,invocation.failed,session.created,session.file_added,session.updated} ...]]
                              [--once-per {occurrence,file,dataset,invocation,session,event}]
                              [--schedule SCHEDULE]
                              --targets-json TARGETS_JSON
                              [--condition-json CONDITION_JSON] [--disabled]
                              [--org ORG]

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

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

--on {dataset.created,dataset.metadata_updated,dataset.tag_added,dataset.upload_completed,event.created,file.ingested,file.metadata_updated,file.uploaded,invocation.completed,invocation.failed,session.created,session.file_added,session.updated}#: One or more platform event types the trigger subscribes to (with ‘–once-per’).

--once-per {occurrence,file,dataset,invocation,session,event}#: What the trigger fires at most once per: the occurrence, or an entity the event names.

--schedule <schedule>#: A five-field cron expression (UTC) to fire on instead of events, e.g. ‘0 9 * * 1’.

--targets-json <targets_json>#: Inline JSON or a path to a JSON file with the trigger’s target spec(s): one object or a list, each discriminated on “type” (invoke_action | start_agent | send_slack_message). Example: ‘[{“type”: “start_agent”, “target_id”: “analyze”, “agent_id”: “ag_123”}]’.

--condition-json <condition_json>#: Inline JSON or a path to a JSON file with a Condition/ConditionGroup over the event namespace.

--disabled#: Create the trigger disabled.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto triggers delete#

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

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto triggers disable#

usage: roboto triggers disable [-h] [--org ORG] name

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto triggers dry-run#

usage: roboto triggers dry-run [-h] [--dataset-id DATASET_ID |
                               --file-id FILE_ID |
                               --invocation-id INVOCATION_ID |
                               --session-id SESSION_ID | --event-id EVENT_ID |
                               --scheduled-for SCHEDULED_FOR]
                               [--on {file.uploaded,dataset.upload_completed,file.ingested,file.metadata_updated,dataset.metadata_updated,dataset.created,dataset.tag_added,invocation.completed,invocation.failed,session.created,session.file_added,session.updated,event.created,schedule.fired}]
                               [--org ORG]
                               name

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

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

--dataset-id <dataset_id>#: Synthesize an event about this dataset.

--file-id <file_id>#: Synthesize an event about this file.

--invocation-id <invocation_id>#: Synthesize an event about this invocation.

--session-id <session_id>#: Synthesize an event about this session.

--event-id <event_id>#: Synthesize a platform event about this event.

--scheduled-for <scheduled_for>#: For a schedule-fired trigger: the UTC minute to pretend the schedule fired at (ISO 8601, e.g. 2026-09-16T15:00:00Z). Defaults to the schedule’s next occurrence; a schedule-fired trigger takes no entity reference.

--on {file.uploaded,dataset.upload_completed,file.ingested,file.metadata_updated,dataset.metadata_updated,dataset.created,dataset.tag_added,invocation.completed,invocation.failed,session.created,session.file_added,session.updated,event.created,schedule.fired}#: Which subscribed platform event type to synthesize; defaults to the first compatible with the reference.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto triggers enable#

usage: roboto triggers enable [-h] [--org ORG] name

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto triggers get#

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

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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto triggers list#

usage: roboto triggers 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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto triggers sample#

usage: roboto triggers sample [-h] [--paths]
                              {file.uploaded,dataset.upload_completed,file.ingested,file.metadata_updated,dataset.metadata_updated,dataset.created,dataset.tag_added,invocation.completed,invocation.failed,session.created,session.file_added,session.updated,event.created,schedule.fired}

event_type#: The event type to show a sample of.

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

--paths#: Print only the {{root.path}} names a condition or template may reference, one per line.

roboto triggers update#

usage: roboto triggers update [-h]
                              [--on {dataset.created,dataset.metadata_updated,dataset.tag_added,dataset.upload_completed,event.created,file.ingested,file.metadata_updated,file.uploaded,invocation.completed,invocation.failed,session.created,session.file_added,session.updated} [{dataset.created,dataset.metadata_updated,dataset.tag_added,dataset.upload_completed,event.created,file.ingested,file.metadata_updated,file.uploaded,invocation.completed,invocation.failed,session.created,session.file_added,session.updated} ...]]
                              [--once-per {occurrence,file,dataset,invocation,session,event}]
                              [--schedule SCHEDULE]
                              [--targets-json TARGETS_JSON]
                              [--condition-json CONDITION_JSON |
                              --clear-condition] [--org ORG]
                              name

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

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

--on {dataset.created,dataset.metadata_updated,dataset.tag_added,dataset.upload_completed,event.created,file.ingested,file.metadata_updated,file.uploaded,invocation.completed,invocation.failed,session.created,session.file_added,session.updated}#: Replace the subscribed event types. Keeps the current ‘–once-per’ unless that is given too.

--once-per {occurrence,file,dataset,invocation,session,event}#: Replace what the trigger fires once per, keeping the current event subscription.

--schedule <schedule>#: Replace the firing source with this five-field UTC cron expression.

--targets-json <targets_json>#: Replace the target list. Same shape as ‘create’. A target whose id is referenced by existing dispatches must keep that id.

--condition-json <condition_json>#: Replace the condition. Inline JSON or a path to a JSON file.

--clear-condition#: Remove the condition entirely.

--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; without it, the default is the org_id of the config file profile in use, which roboto setup saves.

roboto upgrade#

Upgrade the Roboto CLI to the latest release, the way it was installed: a release binary is replaced in place after its download is checked, and a Homebrew install is upgraded with Homebrew. For a .deb package or the Python package, prints how to upgrade it. Then updates the agent skills roboto setup installed, and removes any Roboto no longer publishes. Set ROBOTO_DOWNLOAD_URL to download the CLI’s release files from a mirror. The latest version is looked up on GitHub, and a release binary is replaced only when the mirror has that release.

usage: roboto upgrade [-h]

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

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