CLI Reference¶
usvc¶
UnitySVC customer CLI — remote operations against the UnitySVC customer backend via the unitysvc-py HTTP SDK.
Usage:
Options:
-V, --version: Show version and exit.--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
env: Show the environment variables the SDK and...resolve: Dry-run resolve a gateway path to its...secrets: Customer secret management (list, set,...aliases: Remote service-alias operations (list,...recurrent-requests: Remote recurrent-request operations (list,...groups: Service-group operations (list, show,...services: Per-service operations (show, interfaces,...enrollments: Enrollment management (list, show, cancel).
usvc env¶
Show the environment variables the SDK and CLI will use.
Usage:
Options:
--help: Show this message and exit.
usvc resolve¶
Dry-run resolve a gateway path to its candidates.
Usage:
Options:
--path TEXT: Gateway request path, e.g. 'v1/chat/completions'. [required]--routing-key TEXT: Optional routing key as inline JSON, e.g. '{"model": "gpt-4"}'.--gateway TEXT: Gateway prefix the path belongs to: api | s3 | smtp. [default: api]--strategy TEXT: Override the group's configured routing strategy (e.g. 'by_price').--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc secrets¶
Customer secret management (list, set, delete).
Usage:
Options:
--help: Show this message and exit.
Commands:
list: List secrets owned by the authenticated...set: Set a secret by name (idempotent — creates...delete: Delete a secret by name.
usvc secrets list¶
List secrets owned by the authenticated customer.
Usage:
Options:
--skip INTEGER: Offset for pagination. [default: 0]--limit INTEGER: Max records to return. [default: 100]-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc secrets set¶
Set a secret by name (idempotent — creates or rotates).
Maps to PUT /v1/customer/secrets/{name}. The value is encrypted
server-side and cannot be retrieved later. Resolution order for
the value, in order of precedence:
--value VALUE— explicit literal (or--value "$ENV_NAME"via shell expansion).- piped stdin —
echo v | usvc secrets set X(trailing newline stripped). - interactive prompt — TTY only; hidden input.
Mirrors the convention used by gh secret set, vault kv put,
and similar tools.
Usage:
Arguments:
NAME: Secret name (unique per customer). [required]
Options:
--value TEXT: Secret value. If omitted: reads from stdin when piped, prompts with hidden input when run interactively.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc secrets delete¶
Delete a secret by name.
Usage:
Arguments:
NAME: Secret name. [required]
Options:
-y, --yes: Skip confirmation prompt.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc aliases¶
Remote service-alias operations (list, show, delete).
Usage:
Options:
--help: Show this message and exit.
Commands:
list: List aliases owned by the authenticated...show: Show a single alias as JSON.delete: Delete an alias by id.
usvc aliases list¶
List aliases owned by the authenticated customer.
Usage:
Options:
--skip INTEGER: Offset for pagination. [default: 0]--limit INTEGER: Max records to return. [default: 100]-n, --name TEXT: Filter by alias name.--include-deactivated: Include deactivated aliases.-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc aliases show¶
Show a single alias as JSON.
Usage:
Arguments:
ALIAS_ID: Alias ID. [required]
Options:
--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc aliases delete¶
Delete an alias by id.
Usage:
Arguments:
ALIAS_ID: Alias ID. [required]
Options:
-y, --yes: Skip confirmation prompt.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc recurrent-requests¶
Remote recurrent-request operations (list, show, trigger, delete).
Usage:
Options:
--help: Show this message and exit.
Commands:
list: List recurrent requests owned by the...show: Show a single recurrent request as JSON.trigger: Force an immediate run of a recurrent...delete: Delete a recurrent request by id.
usvc recurrent-requests list¶
List recurrent requests owned by the authenticated customer.
Usage:
Options:
--service-id TEXT: Filter by service id.--enrollment-id TEXT: Filter by enrollment id.--status TEXT: Filter by status.--skip INTEGER: Offset for pagination. [default: 0]--limit INTEGER: Max records to return. [default: 100]-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc recurrent-requests show¶
Show a single recurrent request as JSON.
Usage:
Arguments:
REQUEST_ID: Recurrent request ID. [required]
Options:
--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc recurrent-requests trigger¶
Force an immediate run of a recurrent request.
Usage:
Arguments:
REQUEST_ID: Recurrent request ID. [required]
Options:
--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc recurrent-requests delete¶
Delete a recurrent request by id.
Usage:
Arguments:
REQUEST_ID: Recurrent request ID. [required]
Options:
-y, --yes: Skip confirmation prompt.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc groups¶
Service-group operations (list, show, services, dispatch).
Usage:
Options:
--help: Show this message and exit.
Commands:
list: List service groups visible to the customer.show: Show full detail for one group as JSON.services: List services that belong to a group...dispatch: One-shot HTTP through the group's gateway...
usvc groups list¶
List service groups visible to the customer.
Usage:
Options:
-n, --name TEXT: Filter by partial-substring match on the slug.-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc groups show¶
Show full detail for one group as JSON.
Usage:
Arguments:
NAME: Group slug name. [required]
Options:
--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc groups services¶
List services that belong to a group (cursor-paginated).
Usage:
Arguments:
NAME: Group slug name. [required]
Options:
--cursor TEXT: Pagination cursor from a previous page.--limit INTEGER: Page size (max records per page). [default: 50]--search TEXT: Filter by partial service name.-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc groups dispatch¶
One-shot HTTP through the group's gateway interface.
Body is written raw to stdout; the HTTP status line goes to stderr,
so usvc groups dispatch llm --json '{"messages": [...]}' > out.json
captures only the response body.
Usage:
Arguments:
NAME: Group slug name. [required]
Options:
--path TEXT: Sub-path appended to the group interface base URL.-X, --method TEXT: HTTP method. [default: POST]--json TEXT: Request body as inline JSON.-d, --data TEXT: Raw request body. Prefix with '@' to read from a file.-H, --header TEXT: Extra header 'Key: Value'. Repeatable.--timeout FLOAT: Per-request timeout in seconds.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc services¶
Per-service operations (show, interfaces, dispatch, schedule, enroll, required-secrets, optional-secrets).
Usage:
Options:
--help: Show this message and exit.
Commands:
show: Show full service detail as JSON.interfaces: List access interfaces dispatchable by...dispatch: One-shot HTTP through the service's...schedule: Schedule a recurring dispatch.enroll: Enroll in a service.required-secrets: List customer secrets the picked interface...optional-secrets: List customer secrets the picked interface...
usvc services show¶
Show full service detail as JSON.
Usage:
Arguments:
SERVICE_ID: Service UUID. [required]
Options:
--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc services interfaces¶
List access interfaces dispatchable by this customer.
Usage:
Arguments:
SERVICE_ID: Service UUID. [required]
Options:
-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc services dispatch¶
One-shot HTTP through the service's gateway interface.
Body is written raw to stdout; HTTP status line goes to stderr.
Usage:
Arguments:
SERVICE_ID: Service UUID. [required]
Options:
--interface TEXT: Pick an interface by name (required when ambiguous).--enrollment TEXT: Pick the interface bound to this enrollment UUID.--path TEXT: Sub-path appended to the interface base URL.-X, --method TEXT: HTTP method. [default: POST]--json TEXT: Request body as inline JSON.-d, --data TEXT: Raw request body. Prefix with '@' to read from a file.-H, --header TEXT: Extra header 'Key: Value'. Repeatable.--timeout FLOAT: Per-request timeout in seconds.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc services schedule¶
Schedule a recurring dispatch. Prints the new recurrent-request as JSON.
Pick exactly one of --recurrence, --interval, or --cron.
Usage:
Arguments:
SERVICE_ID: Service UUID. [required]
Options:
--recurrence TEXT: Schedule as inline JSON (advanced — see SDK docs).--interval INTEGER: Sugar: fixed-interval schedule, in seconds.--cron TEXT: Sugar: cron expression, e.g. '/5 * * * '.--timezone TEXT: Timezone for --cron (ignored for --interval / --recurrence). [default: UTC]--interface TEXT: Pick interface by name.--enrollment TEXT: Pick interface by enrollment UUID.--path TEXT: Sub-path appended to interface base URL.-X, --method TEXT: HTTP method. [default: POST]--json TEXT: Request body template as inline JSON.-H, --header TEXT: Extra header 'Key: Value'. Repeatable.--name TEXT: Optional human-friendly label.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc services enroll¶
Enroll in a service. Prints the new enrollment ID + status.
Usage:
Arguments:
SERVICE_ID: Service UUID. [required]
Options:
--parameters TEXT: Enrollment parameters as inline JSON object.-p, --parameter TEXT: Single 'key=value' parameter (string-valued). Repeatable; merged with --parameters.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc services required-secrets¶
List customer secrets the picked interface requires.
Prints one secret name per line (pipeable). Empty output means none are required.
Usage:
Arguments:
SERVICE_ID: Service UUID. [required]
Options:
--interface TEXT: Inspect a specific interface by name.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc services optional-secrets¶
List customer secrets the picked interface can use but doesn't require.
Usage:
Arguments:
SERVICE_ID: Service UUID. [required]
Options:
--interface TEXT: Inspect a specific interface by name.-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc enrollments¶
Enrollment management (list, show, cancel).
Usage:
Options:
--help: Show this message and exit.
Commands:
list: List enrollments owned by the...show: Show one enrollment as JSON.cancel: Cancel an enrollment (sets...
usvc enrollments list¶
List enrollments owned by the authenticated customer.
Usage:
Options:
--skip INTEGER: Offset for pagination. [default: 0]--limit INTEGER: Max records to return. [default: 100]--no-service-details: Skip embedding the service detail payload (faster).-f, --format TEXT: Output format: table | json. [default: table]--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc enrollments show¶
Show one enrollment as JSON.
Usage:
Arguments:
ENROLLMENT_ID: Enrollment UUID. [required]
Options:
--no-service-details: Skip embedding the service detail payload (faster).--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.
usvc enrollments cancel¶
Cancel an enrollment (sets status=cancelled; preserves parameters).
Usage:
Arguments:
ENROLLMENT_ID: Enrollment UUID. [required]
Options:
-y, --yes: Skip confirmation prompt.--api-key TEXT: Customer API key (svcpass_...). Defaults to $UNITYSVC_API_KEY. [env var: UNITYSVC_API_KEY]--base-url TEXT: Backend base URL. [env var: UNITYSVC_API_URL; default: https://api.unitysvc.com/v1]--help: Show this message and exit.