| Command | Description |
|---|---|
create | Create a new project within an organization. |
delete | Permanently delete a project. |
get | Show details for a single project. |
list | List the projects in an organization. |
set | Save the project ID to the active profile’s config file. |
update | Update one or more fields of an existing project (at least one is required). |
CREATE
Create a new project within an organization.oumi-cli projects create [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--display-name | text | ✓ | Human-readable name for the project. |
--organization-id | text | ✓ | ID of the organization that will own the project (required; no fallback to OUMI_ORG_ID or the profile). |
--description | text | Optional free-text description. | |
--prompt | text | Default system prompt for the project. | |
--default-role | choice | Default role for new members. One of: viewer, editor, admin. | |
--default-api-key-provider | choice | Default API-key provider for the project. One of: anthropic, google_gemini, google_vertex, hugging_face, openai, wandb. | |
--user-ids | text | User ID to add as a member; repeat --user-ids to add several. |
DELETE
Permanently delete a project.oumi-cli projects delete [OPTIONS] [PROJECT_ID]
| Argument | Type | Required | Description |
|---|---|---|---|
PROJECT_ID | text | ID of the project (see oumi-cli projects list); falls back to OUMI_PROJECT_ID or the active profile. |
| Option | Type | Required | Description |
|---|---|---|---|
--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. |
GET
Show details for a single project.oumi-cli projects get [OPTIONS] [PROJECT_ID]
| Argument | Type | Required | Description |
|---|---|---|---|
PROJECT_ID | text | ID of the project (see oumi-cli projects list); falls back to OUMI_PROJECT_ID or the active profile. |
LIST
List the projects in an organization.oumi-cli projects list [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--org | text | Organization to list projects from; falls back to OUMI_ORG_ID or the active profile. | |
--limit | integer range | Maximum number of projects to return (default 100). | |
--all | flag | Return all projects, following pages until none are left (capped by --max-items). Cannot be combined with --limit. | |
--max-items | integer range | Cap on how many projects --all returns (default 10000). |
SET
Save the project ID to the active profile’s config file.oumi-cli projects set [OPTIONS] PROJECT_ID
| Argument | Type | Required | Description |
|---|---|---|---|
PROJECT_ID | text | ✓ | ID of the project to save (see oumi-cli projects list); not checked against the server. |
UPDATE
Update one or more fields of an existing project (at least one is required).oumi-cli projects update [OPTIONS] [PROJECT_ID]
| Argument | Type | Required | Description |
|---|---|---|---|
PROJECT_ID | text | ID of the project (see oumi-cli projects list); falls back to OUMI_PROJECT_ID or the active profile. |
| Option | Type | Required | Description |
|---|---|---|---|
--display-name | text | New human-readable name for the project. | |
--description | text | New free-text description. | |
--prompt | text | New default system prompt for the project. | |
--user-ids | text | User ID to add as a member; repeat --user-ids to add several. | |
--default-role | choice | Default role for new members. One of: viewer, editor, admin. |