> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oumi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# PROJECTS

> Create, inspect, and manage Oumi projects

| Command | Description |
| - | - |
| [`create`](#create) | Create a new project within an organization. |
| [`delete`](#delete) | Delete a project by ID. |
| [`get`](#get) | Show details for a single project. |
| [`list`](#list) | List the projects in an organization. |
| [`set`](#set) | Set the active project for the current profile. |
| [`update`](#update) | Update one or more fields of an existing project (at least one is required). |

***

## CREATE

Create a new project within an organization.

```bash theme={null}
oumi-cli projects create [OPTIONS]
```

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--display-name` | str | ✓ | Human-readable name for the project. |
| `--organization-id` | str | ✓ | ID of the organization that will own the project. |
| `--description` | str | | Optional free-text description. |
| `--prompt` | str | | 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` | str | | User ID to add as a member; repeat `--user-ids` to add several. |

***

## DELETE

Delete a project by ID.

```bash theme={null}
oumi-cli projects delete [OPTIONS] [PROJECT_ID]
```

**Arguments**

| Argument | Type | Required | Description |
| - | - | - | - |
| `PROJECT_ID` | str | | ID of the project to delete; falls back to OUMI\_PROJECT\_ID or the active profile. |

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--force` | flag | | Skip the confirmation prompt (alias for `--yes`). |
| `--yes` | flag | | Skip the confirmation prompt. |

***

## GET

Show details for a single project.

```bash theme={null}
oumi-cli projects get [OPTIONS] [PROJECT_ID]
```

**Arguments**

| Argument | Type | Required | Description |
| - | - | - | - |
| `PROJECT_ID` | str | | ID of the project to show; falls back to OUMI\_PROJECT\_ID or the active profile. |

***

## LIST

List the projects in an organization.

```bash theme={null}
oumi-cli projects list [OPTIONS]
```

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--org` | str | | Organization to list projects for; falls back to OUMI\_ORG\_ID or the active profile. |
| `--limit` | int range | | Return at most N projects (default 100). The server returns the full list in one response, so this is a client-side cap. |
| `--all` | flag | | Return every project (bounded by `--max-items`). Mutually exclusive with `--limit`. |
| `--max-items` | int range | | Hard safety cap on rows fetched, in any mode (default 10000). |

***

## SET

Set the active project for the current profile.

```bash theme={null}
oumi-cli projects set [OPTIONS] {project_id}
```

**Arguments**

| Argument | Type | Required | Description |
| - | - | - | - |
| `PROJECT_ID` | str | ✓ | Project ID to activate in the current profile. |

***

## UPDATE

Update one or more fields of an existing project (at least one is required).

```bash theme={null}
oumi-cli projects update [OPTIONS] [PROJECT_ID]
```

**Arguments**

| Argument | Type | Required | Description |
| - | - | - | - |
| `PROJECT_ID` | str | | ID of the project to update; falls back to OUMI\_PROJECT\_ID or the active profile. |

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--display-name` | str | | New human-readable name for the project. |
| `--description` | str | | New free-text description. |
| `--prompt` | str | | New default system prompt for the project. |
| `--user-ids` | str | | 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`. |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.