project - Xata

A project holds branches and the defaults they inherit, such as whether they scale to zero and how long they stay idle first. IP filtering is set per project. Every command below also takes -h, --help.

xata project list — List all projects
xata project describe — Describe a project
xata project create — Create a new project
xata project delete — Delete a project
xata project init — Link this folder to a project and branch
xata project get — Get a field from a project description
xata project set — Set a field value for a project
xata project ip-filter — Manage IP filtering for a project
- xata project ip-filter list — Show IP filtering status and configured CIDR entries
- xata project ip-filter enable — Enable IP filtering for a project
- xata project ip-filter disable — Disable IP filtering for a project
- xata project ip-filter add — Add a CIDR entry to the IP filter allow list
- xata project ip-filter remove — Remove a CIDR entry from the IP filter allow list

list

List all projects

xata project list [--organization value] [--profile value] [--debug] [--json]

string

Organization ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

Aliases: xata project ls

describe

Describe a project

xata project describe [--organization value] [--project value] [--profile value] [--debug] [--json]

string

Organization ID

string

Project ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

Aliases: xata project view, xata project show

create

Create a new project

xata project create [--organization value] (--name value) [--branch-name value] [--description value] [--instance-type value] [--replicas value] [--region value] [--storage value] [--postgres-version value] [--scale-to-zero-base true|false] [--scale-to-zero-child true|false] [--inactivity-period-base 15|30|60|120|180] [--inactivity-period-child 15|30|60|120|180] [--profile value] [--debug] [--json]

string

Organization ID

string

required

Project Name

string

Branch Name

string

Short description of what the first branch is for

string

Instance type for the first branch

string

Number of read replicas for the first branch

string

Region to create the project in

string

Storage in GB for the first branch

string

Please select the PostgreSQL version for this branch

true | false

Default scale to zero status for base branches

true | false

Default scale to zero status for child branches

15 | 30 | 60 | 120 | 180

Default inactivity period in minutes for base branches

15 | 30 | 60 | 120 | 180

Default inactivity period in minutes for child branches

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

delete

Delete a project

xata project delete [--organization value] [--project value] [--yes] [--profile value] [--debug] [--json]

string

Organization ID

string

Project ID

boolean

default:"false"

Do not ask for confirmation, assume yes.

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

init

Link this folder to a project and branch Writes the organization, project, branch and database to .xata/ in this folder, so the commands run here no longer need them passed in.

xata project init [--organization value] [--project value] [--branch value] [--database value] [--profile value] [--debug] [--json]

string

Organization ID

string

Project ID

string

Branch ID or name

string

Database name on the branch

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

Examples:

# Link without prompts
xata project init --organization <org-id> --project <project-id> --branch <branch-id>

Aliases: xata project connect, xata project switch, xata project link

get

Get a field from a project description

xata project get [--organization value] [--project value] [--profile value] [--debug] [--json] <[project] field>...

string

Organization ID

string

Project ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

string

Project name and/or field to get

set

Set a field value for a project The fields are name, scale-to-zero-base, scale-to-zero-child, inactivity-period-base and inactivity-period-child. The scale to zero and inactivity fields are the defaults new branches inherit, base for branches without a parent and child for the rest. Run it without a field to list them.

xata project set [--organization value] [--project value] [--profile value] [--debug] [--json] [<field>] [<value>]

string

Organization ID

string

Project ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

string

The field to set

string

The value to set

Examples:

# Let new child branches scale to zero
xata project set scale-to-zero-child true

ip-filter

Manage IP filtering for a project Show IP filtering status and configured CIDR entries

xata project ip-filter list [--organization value] [--project value] [--profile value] [--debug] [--json]

string

Organization ID

string

Project ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

ip-filter enable

Enable IP filtering for a project

xata project ip-filter enable [--organization value] [--project value] [--profile value] [--debug] [--json]

string

Organization ID

string

Project ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

ip-filter disable

Disable IP filtering for a project

xata project ip-filter disable [--organization value] [--project value] [--profile value] [--debug] [--json]

string

Organization ID

string

Project ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

ip-filter add

Add a CIDR entry to the IP filter allow list

xata project ip-filter add [--organization value] [--project value] [--label value] [--profile value] [--debug] [--json] [<cidr>]

string

Organization ID

string

Project ID

string

Label for the CIDR entry

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

string

IP address or CIDR block to add (e.g. 192.168.0.0/24 or 10.0.0.1)

Examples:

# Allow a single address
xata project ip-filter add 203.0.113.4
# Allow a range and label it
xata project ip-filter add 203.0.113.0/24 --label office

ip-filter remove

Remove a CIDR entry from the IP filter allow list

xata project ip-filter remove [--organization value] [--project value] [--force] [--profile value] [--debug] [--json] [<cidr>]

string

Organization ID

string

Project ID

boolean

default:"false"

Skip confirmation prompts

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

string

CIDR block to remove

​list

​describe

​create

​delete

​init

​get

​set

​ip-filter

​ip-filter list

​ip-filter enable

​ip-filter disable

​ip-filter add

​ip-filter remove

list

describe

create

delete

init

get

set

ip-filter

ip-filter list

ip-filter enable

ip-filter disable

ip-filter add

ip-filter remove