-h, --help.
xata project list— List all projectsxata project describe— Describe a projectxata project create— Create a new projectxata project delete— Delete a projectxata project init— Link this folder to a project and branchxata project get— Get a field from a project descriptionxata project set— Set a field value for a projectxata project ip-filter— Manage IP filtering for a projectxata project ip-filter list— Show IP filtering status and configured CIDR entriesxata project ip-filter enable— Enable IP filtering for a projectxata project ip-filter disable— Disable IP filtering for a projectxata project ip-filter add— Add a CIDR entry to the IP filter allow listxata project ip-filter remove— Remove a CIDR entry from the IP filter allow list
list
List all projectsstring
Organization ID
boolean
default:"false"
Output in JSON format
string
The profile to use
xata project ls
describe
Describe a projectstring
Organization ID
string
Project ID
boolean
default:"false"
Output in JSON format
string
The profile to use
xata project view, xata project show
create
Create a new projectstring
Organization ID
string
required
Project Name
string
Branch Name
string
Instance type for the first branch
string
Number of read replicas for the first branch
string
Region to create the project in
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
boolean
default:"false"
Output in JSON format
string
The profile to use
delete
Delete a projectstring
Organization ID
string
Project ID
boolean
default:"false"
Output in JSON format
boolean
default:"false"
Do not ask for confirmation, assume yes.
string
The profile to use
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.
string
Organization ID
string
Project ID
string
Branch ID
string
Database name
boolean
default:"false"
Output in JSON format
string
The profile to use
xata project connect, xata project switch, xata project link
get
Get a field from a project descriptionstring
Organization ID
string
Project ID
string
The profile to use
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.string
Organization ID
string
Project ID
boolean
default:"false"
Output in JSON format
string
The profile to use
string
The field to set
string
The value to set
ip-filter
Manage IP filtering for a projectip-filter list
Show IP filtering status and configured CIDR entriesstring
Organization ID
string
Project ID
boolean
default:"false"
Output in JSON format
string
The profile to use
ip-filter enable
Enable IP filtering for a projectstring
Organization ID
string
Project ID
boolean
default:"false"
Output in JSON format
string
The profile to use
ip-filter disable
Disable IP filtering for a projectstring
Organization ID
string
Project ID
boolean
default:"false"
Output in JSON format
string
The profile to use
ip-filter add
Add a CIDR entry to the IP filter allow liststring
Organization ID
string
Project ID
string
Label for the CIDR entry
boolean
default:"false"
Output in JSON format
string
The profile to use
string
IP address or CIDR block to add (e.g. 192.168.0.0/24 or 10.0.0.1)
ip-filter remove
Remove a CIDR entry from the IP filter allow liststring
Organization ID
string
Project ID
boolean
default:"false"
Skip confirmation prompts
boolean
default:"false"
Output in JSON format
string
The profile to use
string
CIDR block to remove