| Command | Description |
|---|---|
chat | Open an interactive streaming chat session with a deployment. |
create | Create a new model deployment from a JSON request body. |
delete | Permanently delete a deployment by ID. |
endpoint | Print the inference endpoint, model path, and a runnable curl snippet. |
generate-template | Print a ready-to-edit deployment request body for a deployment type. No API call is made. |
get | Get a deployment by ID. |
health | Report a deployment’s request and error counts, latency and throughput over a time range. |
invoke | Run one inference call against a deployment and print the reply. |
is-ready | Check whether a deployment has an active replica available to serve inference. |
list | List deployments in the project. |
logs delete | Permanently delete inference log entries for a deployment, optionally within a time range. |
logs export | Export a time range of inference logs into a new or existing dataset. |
logs get | Get a single inference log entry by ID, including the full request/response. |
logs list | List inference log entries for a deployment. |
supported-models | List the models this project can deploy, before create/generate-template. |
targets list | List the inference targets attached to a deployment. |
update | Change a deployment’s display name, inference logging, or autoscaling. |
wake-up | Send a dummy request to scale a provider-idled deployment back up. |
CHAT
Open an interactive streaming chat session with a deployment.oumi-cli deployments chat [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--system | text | System instructions. | |
--temperature | float range | Sampling temperature. | |
--max-tokens | integer range | Max output tokens. | |
--top-p | float range | Nucleus sampling top-p. | |
--timeout | integer range | Seconds to wait for an idled deployment to wake up before the session starts, and the default for ‘/wake-up’; 0 waits indefinitely. Default: 600. | |
--auto-wake / --no-auto-wake | flag | Wake the deployment and re-send the turn when it has idled mid-session; togglable in-session with ‘/auto-wake’. | |
--plain / --no-plain | flag | Print a flat transcript instead of chat bubbles; already the default under NO_COLOR or a dumb terminal. |
CREATE
Create a new model deployment from a JSON request body.oumi-cli deployments create [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--input-json | text | Request body for the new deployment, as inline JSON (start from deployments generate-template). Pass exactly one of --input-json or --input-json-file. | |
--input-json-file | path | Path to a file holding the request body for the new deployment, as JSON. Pass exactly one of --input-json or --input-json-file. | |
--wait / --no-wait | flag | Wait for the deployment to become active before returning (default); --no-wait returns the operation ID immediately. |
DELETE
Permanently delete a deployment by ID.oumi-cli deployments delete [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--force | flag | Skip the confirmation prompt. Without a TTY or under --no-input, this (or --yes) is required; otherwise the command exits 2 without changing anything. | |
--yes | flag | Same as --force. | |
--wait / --no-wait | flag | Wait for the deployment to be torn down before returning (default); --no-wait returns the operation ID immediately. |
ENDPOINT
Print the inference endpoint, model path, and a runnable curl snippet.oumi-cli deployments endpoint [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. |
GENERATE-TEMPLATE
Print a ready-to-edit deployment request body for a deployment type. No API call is made.oumi-cli deployments generate-template [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--type | choice | ✓ | Deployment kind to generate a template for: custom (a tuned model) or external (a provider). |
GET
Get a deployment by ID.oumi-cli deployments get [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. |
HEALTH
Report a deployment’s request and error counts, latency and throughput over a time range.oumi-cli deployments health [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--time-window | parse_time_window | Report over the last DURATION, e.g. ‘3h’, ‘45m’, ‘7d’. Mutually exclusive with --start/--end. Give none of --time-window/--start/--end to report over the service’s own default range. | |
--end | parse_iso_timestamp | End of the reported range (ISO-8601, UTC, exclusive). Defaults to now. Must not be in the future. Mutually exclusive with --time-window. | |
--start | parse_iso_timestamp | Start of the reported range (ISO-8601, UTC). Defaults to 24 hours before --end. Rounded to the bucket boundary and clamped to available data, so the response start/end give the exact range served. Mutually exclusive with --time-window. | |
--sampling-interval | choice | Bucket width you expect the range to be served in. The service picks the width from the range, so this only checks it: the command fails if the range was served in the other width. One of: 1m, 1h. |
INVOKE
Run one inference call against a deployment and print the reply.oumi-cli deployments invoke [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--prompt, -p | text | ✓ | Prompt text (’-’ reads from stdin). |
--system | text | System instructions. | |
--temperature | float range | Sampling temperature. | |
--max-tokens | integer range | Max output tokens. | |
--top-p | float range | Nucleus sampling top-p. | |
--stream / --no-stream | flag | Stream tokens (default: on a TTY). | |
--wait / --no-wait | flag | Wake a scaled-to-zero deployment and wait for it before sending the prompt (default); --no-wait fails with exit 9 instead of waiting. | |
--timeout | integer range | Seconds the CLI will wait: the wake-up wait and the wait for each response chunk share this one budget, rather than each getting it in full. Bounds waiting only, not connect/write. 0 waits indefinitely (bounded only by Ctrl-C). Default: 600. |
IS-READY
Check whether a deployment has an active replica available to serve inference.oumi-cli deployments is-ready [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. |
LIST
List deployments in the project.oumi-cli deployments list [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project to list deployments from; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Maximum number of deployments to return (default 100). | |
--all | flag | Return all deployments, following pages until none are left (capped by --max-items). Cannot be combined with --limit. | |
--max-items | integer range | Cap on how many deployments --all returns (default 10000). |
LOGS DELETE
Permanently delete inference log entries for a deployment, optionally within a time range.oumi-cli deployments logs delete [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--start-time | parse_iso_timestamp | Delete logs at or after this time (inclusive). Omit both times to delete ALL logs. ISO-8601, e.g. 2024-01-01T00:00:00Z or a date alone (UTC if no offset). | |
--end-time | parse_iso_timestamp | Delete logs at or before this time (inclusive). Omit both times to delete ALL logs. ISO-8601, e.g. 2024-01-01T00:00:00Z or a date alone (UTC if no offset). | |
--force | flag | Skip the confirmation prompt. Without a TTY or under --no-input, this (or --yes) is required; otherwise the command exits 2 without changing anything. | |
--yes | flag | Same as --force. |
LOGS EXPORT
Export a time range of inference logs into a new or existing dataset.oumi-cli deployments logs export [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--start-time | parse_iso_timestamp | ✓ | Start of the time range to export (inclusive). ISO-8601, e.g. 2024-01-01T00:00:00Z or a date alone (UTC if no offset). |
--end-time | parse_iso_timestamp | ✓ | End of the time range to export (inclusive). ISO-8601, e.g. 2024-01-01T00:00:00Z or a date alone (UTC if no offset). |
--dataset-id | integer | Append the exported logs to this existing dataset. Mutually exclusive with --dataset-name. | |
--dataset-name | text | Create a new dataset with this name from the exported logs. Mutually exclusive with --dataset-id. | |
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--wait / --no-wait | flag | Wait for the export to finish before returning (default); --no-wait returns the operation ID immediately. |
LOGS GET
Get a single inference log entry by ID, including the full request/response.oumi-cli deployments logs get [OPTIONS] DEPLOYMENT_ID LOG_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
LOG_ID | text | ✓ | ULID of the log entry to fetch. |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. |
LOGS LIST
List inference log entries for a deployment.oumi-cli deployments logs list [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--start-time | parse_iso_timestamp | Only include logs at or after this time (inclusive). ISO-8601, e.g. 2024-01-01T00:00:00Z or a date alone (UTC if no offset). | |
--end-time | parse_iso_timestamp | Only include logs at or before this time (inclusive). ISO-8601, e.g. 2024-01-01T00:00:00Z or a date alone (UTC if no offset). | |
--limit | integer range | Maximum number of log entries to return (default 100). | |
--all | flag | Return all log entries, following pages until none are left (capped by --max-items). Cannot be combined with --limit. | |
--max-items | integer range | Cap on how many log entries --all returns (default 10000). |
SUPPORTED-MODELS
List the models this project can deploy, beforecreate/generate-template.
oumi-cli deployments supported-models [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--source | choice | Limit to one source: ‘custom’ (this project’s tuned model versions), ‘external’ (curated provider catalog, e.g. OpenAI, Anthropic or Oumi) or ‘base’ (base models to register, then deploy). Omit to list all three. | |
--project | text | Project whose deployable models to list; falls back to OUMI_PROJECT_ID or the active profile. |
TARGETS LIST
List the inference targets attached to a deployment.oumi-cli deployments targets list [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. |
UPDATE
Change a deployment’s display name, inference logging, or autoscaling.oumi-cli deployments update [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--display-name | text | New display name for the deployment. | |
--inference-logging-enabled / --no-inference-logging-enabled | flag | Enable or disable inference request logging for the deployment. | |
--min-replicas | integer range | Minimum replica count for autoscaling. Must be passed together with --max-replicas. | |
--max-replicas | integer range | Maximum replica count for autoscaling. Must be passed together with --min-replicas. | |
--scale-down-idle-seconds | integer range | Idle time before scaling down to --min-replicas. Requires --min-replicas/--max-replicas in the same invocation. |
WAKE-UP
Send a dummy request to scale a provider-idled deployment back up.oumi-cli deployments wake-up [OPTIONS] DEPLOYMENT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
DEPLOYMENT_ID | integer | ✓ | ID of the deployment (see oumi-cli deployments list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the deployment; falls back to OUMI_PROJECT_ID or the active profile. | |
--wait / --no-wait | flag | Wait for the deployment to be ready to serve inference before returning (default); --no-wait returns as soon as the wake-up request is delivered. | |
--timeout | integer range | Seconds to wait for readiness under --wait; 0 waits indefinitely (bounded only by Ctrl-C). Default: 600. |