Skip to main content

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.

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

​
Subcommands

​
list

List all projects. 
xata project list [--organization <id>] [--json] [-h|--help]
​
--organization
string
Organization ID (default: "")
​
--json
boolean
Output in JSON format (default: false)
​
-h, --help
boolean
Print help information and exit
Aliases: ls

​
describe

Describe a project. 
xata project describe [--organization <id>] [--project <id>] [--json] [-h|--help]
​
--organization
string
Organization ID (default: "")
​
--project
string
Project ID (default: "")
​
--json
boolean
Output in JSON format (default: false)
​
-h, --help
boolean
Print help information and exit
Aliases: view, show

​
create

Create a new project. 
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]
​
--organization
string
Organization ID (default: "")
​
--name
string
required
Project Name
​
--branch-name
string
Branch Name (default: "")
​
--instance-type
string
Type of instance for this branch (default: "")
​
--replicas
number
Number of replicas for the branch (0-4, default: "")
​
--region
string
Region for the branch (default: "")
​
--scale-to-zero-base
boolean
Default scale to zero status for base branches (true|false)
​
--scale-to-zero-child
boolean
Default scale to zero status for child branches (true|false)
​
--inactivity-period-base
number
Default inactivity period in minutes for base branches (15|30|60|120|180)
​
--inactivity-period-child
number
Default inactivity period in minutes for child branches (15|30|60|120|180)
​
--json
boolean
Output in JSON format (default: false)
​
-h, --help
boolean
Print help information and exit

​
delete

Delete a project. 
xata project delete [--organization <id>] [--project <id>] [--json] [--yes] [-h|--help]
​
--organization
string
Organization ID (default: "")
​
--project
string
Project ID (default: "")
​
--json
boolean
Output in JSON format (default: false)
​
--yes
boolean
Do not ask for confirmation, assume yes (default: false)
​
-h, --help
boolean
Print help information and exit

​
init

Link a project to the folder. 
xata project init [--organization <id>] [--project <id>] [--branch <id>] [--database <name>] [--json] [-h|--help]
​
--organization
string
Organization ID (default: "")
​
--project
string
Project ID (default: "")
​
--branch
string
Branch ID (default: "")
​
--database
string
Database name (default: "")
​
--json
boolean
Output in JSON format (default: false)
​
-h, --help
boolean
Print help information and exit
Aliases: connect, switch, link

​
get

Get a field from a project description. 
xata project get [--organization <id>] [--project <id>] <field> [-h|--help]
​
--organization
string
Organization ID (default: "")
​
--project
string
Project ID (default: "")
​
field
string
required
The field to get (default: .catalog)
​
-h, --help
boolean
Print help information and exit

​
set

Set a field value for a project. 
xata project set [--organization <id>] [--project <id>] <field> <value> [-h|--help]
​
--organization
string
Organization ID (default: "")
​
--project
string
Project ID (default: "")
​
field
string
required
The field to set
​
value
string
required
The value to set
​
-h, --help
boolean
Print help information and exit

​
Global Flags

​
-h, --help
boolean
Print help information and exit
​
--json
boolean
Output in JSON format