---
sidebar:
  label: Overview
  order: 0
title: CLI
---
## Usage

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

```bash
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} ...
```

**Arguments**

| Argument | Description |
| --- | --- |
| `--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. Default: `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). Default: `0`. |
| `--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. |

## Commands

### roboto actions

Create, edit and invoke reusable actions that run containerized code on your datasets.

- [`create`](/docs/reference/cli/actions#roboto-actions-create). Create a new action.
- [`delete`](/docs/reference/cli/actions#roboto-actions-delete). Delete action and all of its related subresources.
- [`init`](/docs/reference/cli/actions#roboto-actions-init). Initialize a new action package.
- [`invoke`](/docs/reference/cli/actions#roboto-actions-invoke). Invoke an action on the hosted platform.
- [`invoke-local`](/docs/reference/cli/actions#roboto-actions-invoke-local). Invoke an action locally using Docker.
- [`list-invocations`](/docs/reference/cli/actions#roboto-actions-list-invocations). List invocations for action.
- [`search`](/docs/reference/cli/actions#roboto-actions-search). Search for existing actions.
- [`show`](/docs/reference/cli/actions#roboto-actions-show). Show details for an action.
- [`update`](/docs/reference/cli/actions#roboto-actions-update). Update an existing action.

### roboto cache

Manage the local Roboto cache.

- [`clear`](/docs/reference/cli/cache#roboto-cache-clear). Clears the local Roboto cache directory.
- [`size`](/docs/reference/cli/cache#roboto-cache-size). Returns the total size in bytes of the Roboto cache directory.
- [`where`](/docs/reference/cli/cache#roboto-cache-where). Prints the path to the Roboto cache directory.

### roboto chat

Talk with your data, using natural language.

- [`start`](/docs/reference/cli/chat#roboto-chat-start). Start an interactive chat session.

### roboto collections

Curate collections of datasets and other data types.

- [`changelog`](/docs/reference/cli/collections#roboto-collections-changelog). Get a changelog for the revisions of a collection.
- [`create`](/docs/reference/cli/collections#roboto-collections-create). Create a new collection.
- [`delete`](/docs/reference/cli/collections#roboto-collections-delete). Delete a collection.
- [`list`](/docs/reference/cli/collections#roboto-collections-list). List existing collections.
- [`show`](/docs/reference/cli/collections#roboto-collections-show). Show information about a collection.
- [`update`](/docs/reference/cli/collections#roboto-collections-update). Update the resources and metadata of a collection.

### roboto datasets

Manage datasets, used to store files from a robot run or drone flight. Includes file upload and download.

- [`create`](/docs/reference/cli/datasets#roboto-datasets-create). Create a new dataset.
- [`delete`](/docs/reference/cli/datasets#roboto-datasets-delete). Delete a dataset and all contained resources.
- [`delete-files`](/docs/reference/cli/datasets#roboto-datasets-delete-files). Delete files from a dataset.
- [`download-files`](/docs/reference/cli/datasets#roboto-datasets-download-files). Download a file or directory from a dataset.
- [`import-external-file`](/docs/reference/cli/datasets#roboto-datasets-import-external-file). Import a file from an external storage location (e.g. a pre-registered S3 bucket) into a dataset.
- [`list-files`](/docs/reference/cli/datasets#roboto-datasets-list-files). List files in a dataset.
- [`rename-directory`](/docs/reference/cli/datasets#roboto-datasets-rename-directory). Rename or move a directory within a dataset.
- [`rename-file`](/docs/reference/cli/datasets#roboto-datasets-rename-file). Rename or move a file within a dataset.
- [`search`](/docs/reference/cli/datasets#roboto-datasets-search). Search for datasets matching filter criteria.
- [`show`](/docs/reference/cli/datasets#roboto-datasets-show). Display detailed information about a dataset.
- [`update`](/docs/reference/cli/datasets#roboto-datasets-update). Update metadata or properties of an existing dataset.
- [`upload-files`](/docs/reference/cli/datasets#roboto-datasets-upload-files). Upload a file or directory to a dataset.

### roboto devices

Manage the robots and other devices which have Roboto access within your org.

- [`delete`](/docs/reference/cli/devices#roboto-devices-delete). Deletes a device
- [`disable`](/docs/reference/cli/devices#roboto-devices-disable). Disables a device's access tokens without deleting them. This is useful if a device is acting odd, and you want to temporarily cut it off from uploading datasets, but you don't want to have to re-provision its Roboto access.
- [`enable`](/docs/reference/cli/devices#roboto-devices-enable). Re-enables all of a device's access tokens. They start enabled, so this is only needed if they've been explicitly disabled.
- [`generate-creds`](/docs/reference/cli/devices#roboto-devices-generate-creds). Generates a new access credentials file for an existing device.
- [`list`](/docs/reference/cli/devices#roboto-devices-list). Lists devices which have been registered for a given org.
- [`register`](/docs/reference/cli/devices#roboto-devices-register). Registers a device with Roboto.
- [`show`](/docs/reference/cli/devices#roboto-devices-show). Gets info about an individual device.

### roboto images

Push and pull images from Roboto's private container registry.

- [`delete-image`](/docs/reference/cli/images#roboto-images-delete-image). Delete a container image hosted in Roboto's image registry. Requires Docker CLI.
- [`delete-repository`](/docs/reference/cli/images#roboto-images-delete-repository). Delete an image repository hosted in Roboto's image registry. Requires Docker CLI.
- [`list`](/docs/reference/cli/images#roboto-images-list). List container images hosted in Roboto's image registry.
- [`list-repos`](/docs/reference/cli/images#roboto-images-list-repos). List image repositories hosted in Roboto's image registry.
- [`login`](/docs/reference/cli/images#roboto-images-login). Temporarily login to Roboto's image registry. Requires Docker CLI. Login is valid for 12 hours and is scoped to a particular repository.
- [`pull`](/docs/reference/cli/images#roboto-images-pull). Pull a container image hosted in Roboto's image registry. Requires Docker CLI.
- [`push`](/docs/reference/cli/images#roboto-images-push). Push a local container image into Roboto's image registry. Requires Docker CLI.

### roboto invocations

Get logs and status history from invoked actions, including the option to cancel them.

- [`cancel`](/docs/reference/cli/invocations#roboto-invocations-cancel). Cancel invocation.
- [`cancel-all`](/docs/reference/cli/invocations#roboto-invocations-cancel-all). Cancel all queued and running invocations in your organization
- [`logs`](/docs/reference/cli/invocations#roboto-invocations-logs). Get invocation logs.
- [`show`](/docs/reference/cli/invocations#roboto-invocations-show). Show invocation details.
- [`status`](/docs/reference/cli/invocations#roboto-invocations-status). Get invocation status.

### roboto orgs

View details of organizations that you are in, including administration options if applicable.

- [`add-role`](/docs/reference/cli/orgs#roboto-orgs-add-role). Promotes a user to a more permissive org access level.
- [`bind-email-domain`](/docs/reference/cli/orgs#roboto-orgs-bind-email-domain). Binds an email domain to this org, so all new users whose emails are part of that domain will automatically be added.
- [`delete`](/docs/reference/cli/orgs#roboto-orgs-delete). Deletes an existing organization
- [`invite-user`](/docs/reference/cli/orgs#roboto-orgs-invite-user). Invites a user to join an org.
- [`list-email-domains`](/docs/reference/cli/orgs#roboto-orgs-list-email-domains). Lists the email domains associated with a particular org.
- [`list-invites`](/docs/reference/cli/orgs#roboto-orgs-list-invites). Lists the current pending invites for a specified org
- [`members`](/docs/reference/cli/orgs#roboto-orgs-members). Lists the members of an organization
- [`register-bucket`](/docs/reference/cli/orgs#roboto-orgs-register-bucket). Registers an S3 bring-your-own-bucket with Roboto. Only available to premium tier orgs.
- [`remove-role`](/docs/reference/cli/orgs#roboto-orgs-remove-role). Demotes a user to a less permissive org access level.
- [`remove-user`](/docs/reference/cli/orgs#roboto-orgs-remove-user). Removes a user from an organization
- [`show`](/docs/reference/cli/orgs#roboto-orgs-show). Gets metadata for a single organization
- [`unbind-email-domain`](/docs/reference/cli/orgs#roboto-orgs-unbind-email-domain). Unbinds an email domain from this org, so all new users whose emails are part of that domain will no longer be automatically added.

### roboto secrets

Manage secure secrets registered with Roboto. These are typically 3rd party API keys to power integrations.

- [`delete`](/docs/reference/cli/secrets#roboto-secrets-delete). Deletes a secret from the Roboto platform. This operation cannot be undone.
- [`list`](/docs/reference/cli/secrets#roboto-secrets-list). List all secrets in an organization. This does not reveal the secret values, only the secret names and metadata.
- [`write`](/docs/reference/cli/secrets#roboto-secrets-write). Write a new value to a new or existing secret.

### roboto tokens

Generate and review your platform access tokens.

- [`create`](/docs/reference/cli/tokens#roboto-tokens-create). Creates a temporary access token.
- [`delete`](/docs/reference/cli/tokens#roboto-tokens-delete). Deletes a token by unique token_id.
- [`list`](/docs/reference/cli/tokens#roboto-tokens-list). Creates a temporary access token.
- [`show`](/docs/reference/cli/tokens#roboto-tokens-show). Gets a token by unique token_id.

### roboto triggers

Create and manage event-driven triggers (platform events, conditions, multi-target).

- [`create`](/docs/reference/cli/triggers#roboto-triggers-create). Creates a trigger subscribing to platform events with one or more targets.
- [`delete`](/docs/reference/cli/triggers#roboto-triggers-delete). Deletes a trigger.
- [`disable`](/docs/reference/cli/triggers#roboto-triggers-disable). Disables a trigger.
- [`dry-run`](/docs/reference/cli/triggers#roboto-triggers-dry-run). Explains whether a trigger would fire for an entity, gate by gate.
- [`enable`](/docs/reference/cli/triggers#roboto-triggers-enable). Enables a trigger.
- [`get`](/docs/reference/cli/triggers#roboto-triggers-get). Looks up a trigger by name.
- [`list`](/docs/reference/cli/triggers#roboto-triggers-list). Lists every trigger in the org, event-fired and scheduled.
- [`sample`](/docs/reference/cli/triggers#roboto-triggers-sample). Shows a realistic, fully dereferenced sample of an event type: what conditions and templates can see.
- [`update`](/docs/reference/cli/triggers#roboto-triggers-update). Changes a trigger's firing source, condition, or targets.

### roboto users

Get information about your account.

- [`delete`](/docs/reference/cli/users#roboto-users-delete). Removes you from the roboto platform.
- [`orgs`](/docs/reference/cli/users#roboto-users-orgs). Lists the roles that a user is a member of.
- [`show`](/docs/reference/cli/users#roboto-users-show). Shows your user record.
- [`whoami`](/docs/reference/cli/users#roboto-users-whoami). Returns the full identity context available to Roboto when you make a request.

### roboto setup

Set up this machine to use Roboto: check your access token, install agent skills, and connect your AI tools.

### roboto upgrade

Upgrade the Roboto CLI and the agent skills `roboto setup` installed.