| Command | Description |
|---|---|
create | Create a recipe in a project from a JSON request body. |
delete | Permanently delete a recipe by ID. |
download | Download a recipe’s config to a local JSON file for editing. |
generate-template | Print a ready-to-edit recipe request body for a recipe type. No API call is made. |
get | Show a single recipe by ID. |
list | List recipes in a project, optionally sorted. |
update | Rename a recipe, or replace its config from a JSON body. |
versions get | Show a single version of a recipe, including its full config. |
versions list | List version history for a recipe, newest first by default. |
CREATE
Create a recipe in a project from a JSON request body.oumi-cli recipes create [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the recipe; falls back to OUMI_PROJECT_ID or the active profile. | |
--type | choice | ✓ | Recipe kind to create. Must match the kind set in the request body; a template from ‘generate-template --type <type>’ already does, so pass the same --type you generated with. One of: training, evaluate, synthesis, analyze. |
--input-json | text | Request body for the new recipe, as inline JSON (start from recipes 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 recipe, as JSON. Pass exactly one of --input-json or --input-json-file. |
DELETE
Permanently delete a recipe by ID.oumi-cli recipes delete [OPTIONS] RECIPE_ID
| Argument | Type | Required | Description |
|---|---|---|---|
RECIPE_ID | integer | ✓ | ID of the recipe (see oumi-cli recipes list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the recipe; 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. |
DOWNLOAD
Download a recipe’s config to a local JSON file for editing.oumi-cli recipes download [OPTIONS] RECIPE_ID
| Argument | Type | Required | Description |
|---|---|---|---|
RECIPE_ID | integer | ✓ | ID of the recipe to download (see oumi-cli recipes list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the recipe; falls back to OUMI_PROJECT_ID or the active profile. | |
--out | path | Destination file or directory. Defaults to ./recipe-<id>.json in the current directory. |
GENERATE-TEMPLATE
Print a ready-to-edit recipe request body for a recipe type. No API call is made.oumi-cli recipes generate-template [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--type | choice | ✓ | Recipe kind to generate a template for; the template’s recipe kind is set to it. One of: training, evaluate, synthesis, analyze. |
GET
Show a single recipe by ID.oumi-cli recipes get [OPTIONS] RECIPE_ID
| Argument | Type | Required | Description |
|---|---|---|---|
RECIPE_ID | integer | ✓ | ID of the recipe (see oumi-cli recipes list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the recipe; falls back to OUMI_PROJECT_ID or the active profile. |
LIST
List recipes in a project, optionally sorted.oumi-cli recipes list [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project to list recipes from; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Maximum number of recipes to return (default 100). | |
--all | flag | Return all recipes, following pages until none are left (capped by --max-items). Cannot be combined with --limit. | |
--max-items | integer range | Cap on how many recipes --all returns (default 10000). | |
--sort-by | choice | Field to sort by. One of: created_at, updated_at. | |
--sort-direction | choice | Sort order (asc is oldest-first). |
UPDATE
Rename a recipe, or replace its config from a JSON body.oumi-cli recipes update [OPTIONS] RECIPE_ID
| Argument | Type | Required | Description |
|---|---|---|---|
RECIPE_ID | integer | ✓ | ID of the recipe (see oumi-cli recipes list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the recipe; falls back to OUMI_PROJECT_ID or the active profile. | |
--display-name | text | New display name for the recipe. Renames only; the recipe’s config is unchanged. Cannot be combined with --input-json or --input-json-file. | |
--input-json | text | Full replacement request body for the recipe, as inline JSON; creates a new recipe version. Cannot be combined with --display-name. | |
--input-json-file | path | Path to a file holding the replacement request body as JSON; creates a new recipe version. Cannot be combined with --display-name. |
VERSIONS GET
Show a single version of a recipe, including its full config.oumi-cli recipes versions get [OPTIONS] RECIPE_ID VERSION_ID
| Argument | Type | Required | Description |
|---|---|---|---|
RECIPE_ID | integer | ✓ | ID of the recipe (see oumi-cli recipes list). |
VERSION_ID | integer | ✓ | ID of the version to inspect (see recipes versions list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the recipe; falls back to OUMI_PROJECT_ID or the active profile. |
VERSIONS LIST
List version history for a recipe, newest first by default.oumi-cli recipes versions list [OPTIONS] RECIPE_ID
| Argument | Type | Required | Description |
|---|---|---|---|
RECIPE_ID | integer | ✓ | ID of the recipe (see oumi-cli recipes list). |
| Option | Type | Required | Description |
|---|---|---|---|
--project | text | Project that owns the recipe; falls back to OUMI_PROJECT_ID or the active profile. | |
--limit | integer range | Maximum number of versions to return (default 100). | |
--all | flag | Return all versions, following pages until none are left (capped by --max-items). Cannot be combined with --limit. | |
--max-items | integer range | Cap on how many versions --all returns (default 10000). | |
--sort-by | choice | Field to sort by. One of: created_at, updated_at, version_id. | |
--sort-direction | choice | Sort order (asc is oldest-first). |