CLI Reference¶
Complete reference for all grace commands, arguments, and options.
This page is auto-generated from the Typer application source code. It is always in sync with the installed version.
grace¶
Operator CLI for Cyber Grace workflows.
Usage¶
grace [OPTIONS] COMMAND [ARGS]...
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--env, -e |
Target environment name. | No | - |
--output, -o |
Output format: table or json. | No | table |
--verbose, -v |
Enable verbose output. | No | False |
--quiet, -q |
Suppress non-essential output. | No | False |
--version |
Show version. | No | - |
--install-completion |
Install completion for the current shell. | No | - |
--show-completion |
Show completion for the current shell, to copy it or customize the installation. | No | - |
Commands¶
| Name | Description |
|---|---|
auth |
Authentication management. |
device |
Device operations. |
data |
Cross-environment data operations. |
Subcommands¶
auth¶
Authentication management.
Usage¶
grace auth [OPTIONS] COMMAND [ARGS]...
Arguments¶
No arguments available
Options¶
No options available
Subcommands¶
login¶
Store credentials for an environment.
Usage¶
grace auth login [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--env |
Environment to authenticate against. | No | - |
logout¶
Remove stored credentials for an environment.
Usage¶
grace auth logout [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--env |
Environment to remove credentials for. | No | - |
status¶
Show credential and connectivity status for all environments.
Usage¶
grace auth status [OPTIONS]
Arguments¶
No arguments available
Options¶
No options available
device¶
Device operations.
Usage¶
grace device [OPTIONS] COMMAND [ARGS]...
Arguments¶
No arguments available
Options¶
No options available
Subcommands¶
list¶
List devices with optional filtering.
Usage¶
grace device list [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--page, -p |
Page number. | No | 1 |
--size, -s |
Page size. | No | 20 |
--filter, -f |
Filter expressions (key:op:value). | No | - |
get¶
Get detailed info for a single device.
Usage¶
grace device get [OPTIONS] DEVICE_ID
Arguments¶
| Name | Description | Required |
|---|---|---|
DEVICE_ID |
Device UUID. | Yes |
Options¶
No options available
register¶
Register a new device.
Usage¶
grace device register [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--name, -n |
Device name. | Yes | - |
--type, -t |
Device type. | Yes | - |
--device-no |
Device number. | No | - |
--vendor-id |
Vendor UUID. | No | - |
--readable-name |
Human-readable name. | No | - |
--info-file |
JSON file with device info. | No | - |
update¶
Update an existing device with diff preview and confirmation.
Usage¶
grace device update [OPTIONS] DEVICE_ID
Arguments¶
| Name | Description | Required |
|---|---|---|
DEVICE_ID |
Device UUID to update. | Yes |
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--name, -n |
New device name. | No | - |
--device-no |
New device number. | No | - |
--vendor-id |
New vendor UUID. | No | - |
--readable-name |
New readable name. | No | - |
--info-file |
JSON file with updated device info. | No | - |
--yes, -y |
Skip confirmation. | No | False |
data¶
Cross-environment data operations.
Usage¶
grace data [OPTIONS] COMMAND [ARGS]...
Arguments¶
No arguments available
Options¶
No options available
Subcommands¶
copy¶
Additive copy of records from source to target environment.
Creates new records in target. Skips records that already exist (by UUID). Does NOT update, delete, or reconcile existing records.
Usage¶
grace data copy [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--source, -s |
Source environment name. | Yes | - |
--target, -t |
Target environment name. | Yes | - |
--entity |
Entity type to copy (devices, locations, vendors, videos). | Yes | - |
--filter, -f |
Filter expressions (key:op:value). | No | - |
--limit, -l |
Max records to copy. | No | - |
--dry-run |
Show what would be copied without executing. | No | False |
--clear-storage-meta |
Null out storage_meta on videos. | No | False |
transfer¶
Transfer videos and all related data between environments.
Copies videos plus annotation_runs, segmentations, and video_steps. Resolves devices by device_no and collectors by name. Optionally copies GCS files with --copy-files.
With --update, existing video records are compared against source and patched if they differ. Other entity types are always create-or-skip.
Usage¶
grace data transfer [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--source, -s |
Source environment name. | Yes | - |
--target, -t |
Target environment name. | Yes | - |
--filter, -f |
Filter expressions (key:op:value). | No | - |
--limit, -l |
Max videos to transfer. | No | - |
--dry-run |
Show what would be transferred without executing. | No | False |
--verbose, -v |
Show detailed record and file lists. | No | False |
--copy-files |
Also copy GCS blobs to target bucket. | No | False |
--target-gcs-bucket |
Override target GCS bucket (default: auto-derive by replacing env in bucket name). | No | - |
--update |
Compare existing videos field-by-field and update those that differ. | No | False |