CLI
Usage
CLI for interacting with Roboto. Each command group provides specific subcommands and dedicated help pages for detailed 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} ...
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. Create a new action.delete. Delete action and all of its related subresources.init. Initialize a new action package.invoke. Invoke an action on the hosted platform.invoke-local. Invoke an action locally using Docker.list-invocations. List invocations for action.search. Search for existing actions.show. Show details for an action.update. Update an existing action.
roboto cache
Manage the local Roboto cache.
clear. Clears the local Roboto cache directory.size. Returns the total size in bytes of the Roboto cache directory.where. Prints the path to the Roboto cache directory.
roboto chat
Talk with your data, using natural language.
start. Start an interactive chat session.
roboto collections
Curate collections of datasets and other data types.
changelog. Get a changelog for the revisions of a collection.create. Create a new collection.delete. Delete a collection.list. List existing collections.show. Show information about a collection.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. Create a new dataset.delete. Delete a dataset and all contained resources.delete-files. Delete files from a dataset.download-files. Download a file or directory from a dataset.import-external-file. Import a file from an external storage location (e.g. a pre-registered S3 bucket) into a dataset.list-files. List files in a dataset.rename-directory. Rename or move a directory within a dataset.rename-file. Rename or move a file within a dataset.search. Search for datasets matching filter criteria.show. Display detailed information about a dataset.update. Update metadata or properties of an existing dataset.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. Deletes a devicedisable. 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. 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. Generates a new access credentials file for an existing device.list. Lists devices which have been registered for a given org.register. Registers a device with Roboto.show. Gets info about an individual device.
roboto images
Push and pull images from Roboto’s private container registry.
delete-image. Delete a container image hosted in Roboto’s image registry. Requires Docker CLI.delete-repository. Delete an image repository hosted in Roboto’s image registry. Requires Docker CLI.list. List container images hosted in Roboto’s image registry.list-repos. List image repositories hosted in Roboto’s image registry.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. Pull a container image hosted in Roboto’s image registry. Requires Docker CLI.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. Cancel invocation.cancel-all. Cancel all queued and running invocations in your organizationlogs. Get invocation logs.show. Show invocation details.status. Get invocation status.
roboto orgs
View details of organizations that you are in, including administration options if applicable.
add-role. Promotes a user to a more permissive org access level.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. Deletes an existing organizationinvite-user. Invites a user to join an org.list-email-domains. Lists the email domains associated with a particular org.list-invites. Lists the current pending invites for a specified orgmembers. Lists the members of an organizationregister-bucket. Registers an S3 bring-your-own-bucket with Roboto. Only available to premium tier orgs.remove-role. Demotes a user to a less permissive org access level.remove-user. Removes a user from an organizationshow. Gets metadata for a single organizationunbind-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. Deletes a secret from the Roboto platform. This operation cannot be undone.list. List all secrets in an organization. This does not reveal the secret values, only the secret names and metadata.write. Write a new value to a new or existing secret.
roboto tokens
Generate and review your platform access tokens.
create. Creates a temporary access token.delete. Deletes a token by unique token_id.list. Creates a temporary access token.show. Gets a token by unique token_id.
roboto triggers
Create and manage event-driven triggers (platform events, conditions, multi-target).
create. Creates a trigger subscribing to platform events with one or more targets.delete. Deletes a trigger.disable. Disables a trigger.dry-run. Explains whether a trigger would fire for an entity, gate by gate.enable. Enables a trigger.get. Looks up a trigger by name.list. Lists every trigger in the org, event-fired and scheduled.sample. Shows a realistic, fully dereferenced sample of an event type: what conditions and templates can see.update. Changes a trigger’s firing source, condition, or targets.
roboto users
Get information about your account.
delete. Removes you from the roboto platform.orgs. Lists the roles that a user is a member of.show. Shows your user record.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.