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

# project

> Commands for managing Xata projects

The `project` command helps you create, list, describe, and manage projects in Xata.

## Subcommands

### list

List all projects.

```bash theme={null}
xata project list [--organization <id>] [--json] [-h|--help]
```

<ParamField path="--organization" type="string">
  Organization ID (default: "")
</ParamField>

<ParamField path="--json" type="boolean">
  Output in JSON format (default: false)
</ParamField>

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

**Aliases:** `ls`

### describe

Describe a project.

```bash theme={null}
xata project describe [--organization <id>] [--project <id>] [--json] [-h|--help]
```

<ParamField path="--organization" type="string">
  Organization ID (default: "")
</ParamField>

<ParamField path="--project" type="string">
  Project ID (default: "")
</ParamField>

<ParamField path="--json" type="boolean">
  Output in JSON format (default: false)
</ParamField>

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

**Aliases:** `view`, `show`

### create

Create a new project.

```bash theme={null}
xata project create --name <name> [--organization <id>] [--branch-name <name>] [--instance-type <type>] [--replicas <n>] [--region <region>] [--scale-to-zero-base <true|false>] [--scale-to-zero-child <true|false>] [--inactivity-period-base <minutes>] [--inactivity-period-child <minutes>] [--json] [-h|--help]
```

<ParamField path="--organization" type="string">
  Organization ID (default: "")
</ParamField>

<ParamField path="--name" type="string" required>
  Project Name
</ParamField>

<ParamField path="--branch-name" type="string">
  Branch Name (default: "")
</ParamField>

<ParamField path="--instance-type" type="string">
  Type of instance for this branch (default: "")
</ParamField>

<ParamField path="--replicas" type="number">
  Number of replicas for the branch (0-4, default: "")
</ParamField>

<ParamField path="--region" type="string">
  Region for the branch (default: "")
</ParamField>

<ParamField path="--scale-to-zero-base" type="boolean">
  Default scale to zero status for base branches (true|false)
</ParamField>

<ParamField path="--scale-to-zero-child" type="boolean">
  Default scale to zero status for child branches (true|false)
</ParamField>

<ParamField path="--inactivity-period-base" type="number">
  Default inactivity period in minutes for base branches (15|30|60|120|180)
</ParamField>

<ParamField path="--inactivity-period-child" type="number">
  Default inactivity period in minutes for child branches (15|30|60|120|180)
</ParamField>

<ParamField path="--json" type="boolean">
  Output in JSON format (default: false)
</ParamField>

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

### delete

Delete a project.

```bash theme={null}
xata project delete [--organization <id>] [--project <id>] [--json] [--yes] [-h|--help]
```

<ParamField path="--organization" type="string">
  Organization ID (default: "")
</ParamField>

<ParamField path="--project" type="string">
  Project ID (default: "")
</ParamField>

<ParamField path="--json" type="boolean">
  Output in JSON format (default: false)
</ParamField>

<ParamField path="--yes" type="boolean">
  Do not ask for confirmation, assume yes (default: false)
</ParamField>

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

### init

Link a project to the folder.

```bash theme={null}
xata project init [--organization <id>] [--project <id>] [--branch <id>] [--database <name>] [--json] [-h|--help]
```

<ParamField path="--organization" type="string">
  Organization ID (default: "")
</ParamField>

<ParamField path="--project" type="string">
  Project ID (default: "")
</ParamField>

<ParamField path="--branch" type="string">
  Branch ID (default: "")
</ParamField>

<ParamField path="--database" type="string">
  Database name (default: "")
</ParamField>

<ParamField path="--json" type="boolean">
  Output in JSON format (default: false)
</ParamField>

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

**Aliases:** `connect`, `switch`, `link`

### get

Get a field from a project description.

```bash theme={null}
xata project get [--organization <id>] [--project <id>] <field> [-h|--help]
```

<ParamField path="--organization" type="string">
  Organization ID (default: "")
</ParamField>

<ParamField path="--project" type="string">
  Project ID (default: "")
</ParamField>

<ParamField path="field" type="string" required>
  The field to get (default: `.catalog`)
</ParamField>

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

### set

Set a field value for a project.

```bash theme={null}
xata project set [--organization <id>] [--project <id>] <field> <value> [-h|--help]
```

<ParamField path="--organization" type="string">
  Organization ID (default: "")
</ParamField>

<ParamField path="--project" type="string">
  Project ID (default: "")
</ParamField>

<ParamField path="field" type="string" required>
  The field to set
</ParamField>

<ParamField path="value" type="string" required>
  The value to set
</ParamField>

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

## Global Flags

<ParamField path="-h, --help" type="boolean">
  Print help information and exit
</ParamField>

<ParamField path="--json" type="boolean">
  Output in JSON format
</ParamField>