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

# Projects

> Manage projects with the AX CLI

<Note>
  The `ax projects` commands are currently in **BETA**. The API may change without notice. A one-time warning is emitted on first use. The `update` command is in **ALPHA**.
</Note>

The `ax projects` commands let you create, retrieve, and manage projects on the Arize platform.

## `ax projects list`

List all projects in a space.

```bash theme={null}
ax projects list [--space <id>] [--name <filter>] [--limit <n>] [--cursor <cursor>] [--output <fmt>] [--verbose]
```

| Option            | Description                                                    |
| ----------------- | -------------------------------------------------------------- |
| `--name`, `-n`    | Case-insensitive substring filter on project name              |
| `--space`, `-s`   | Space name or ID                                               |
| `--limit`, `-l`   | Maximum number of projects to return (default: 15)             |
| `--cursor`, `-c`  | Pagination cursor for the next page                            |
| `--output`, `-o`  | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs                                            |

**Example:**

```bash theme={null}
ax projects list --space sp_abc123
```

## `ax projects create`

Create a new project.

```bash theme={null}
ax projects create --name <name> --space <id> [--output <fmt>] [--verbose]
```

| Option            | Description                                                               |
| ----------------- | ------------------------------------------------------------------------- |
| `--name`, `-n`    | Name for the new project (required; prompted if omitted)                  |
| `--space`, `-s`   | Space name or ID to create the project in (required; prompted if omitted) |
| `--output`, `-o`  | Output format (`table`, `json`, `csv`, `parquet`) or file path            |
| `--verbose`, `-v` | Enable verbose logs                                                       |

**Example:**

```bash theme={null}
ax projects create --name "my-project" --space sp_abc123
```

## `ax projects get`

Retrieve a project by name or ID.

```bash theme={null}
ax projects get <name-or-id> [--space <id>] [--output <fmt>] [--verbose]
```

| Option            | Description                                                         |
| ----------------- | ------------------------------------------------------------------- |
| `--space`, `-s`   | Space name or ID (required when using a project name instead of ID) |
| `--output`, `-o`  | Output format (`table`, `json`, `csv`, `parquet`) or file path      |
| `--verbose`, `-v` | Enable verbose logs                                                 |

**Examples:**

```bash theme={null}
ax projects get proj_abc123
ax projects get my-project --space my-space
```

## `ax projects update`

Rename a project.

```bash theme={null}
ax projects update <name-or-id> --name <new-name> [--space <id>] [--output <fmt>] [--verbose]
```

| Option            | Description                                                         |
| ----------------- | ------------------------------------------------------------------- |
| `--name`, `-n`    | New name for the project (required; prompted if omitted)            |
| `--space`, `-s`   | Space name or ID (required when using a project name instead of ID) |
| `--output`, `-o`  | Output format (`table`, `json`, `csv`, `parquet`) or file path      |
| `--verbose`, `-v` | Enable verbose logs                                                 |

**Examples:**

```bash theme={null}
ax projects update proj_abc123 --name "renamed-project"
ax projects update my-project --space my-space --name "renamed-project"
```

## `ax projects delete`

Delete a project.

```bash theme={null}
ax projects delete <name-or-id> [--space <id>] [--force] [--verbose]
```

| Option            | Description                                                         |
| ----------------- | ------------------------------------------------------------------- |
| `--space`, `-s`   | Space name or ID (required when using a project name instead of ID) |
| `--force`, `-f`   | Skip the confirmation prompt                                        |
| `--verbose`, `-v` | Enable verbose logs                                                 |

**Examples:**

```bash theme={null}
ax projects delete proj_abc123
ax projects delete my-project --space my-space --force
```
