The organization command helps you create, list, describe, and manage organizations in Xata.

Subcommands

list

List all organizations.
xata organization list [--json] [-h|--help]
--json
boolean
Output in JSON format (default: false)
-h, --help
boolean
Print help information and exit
Aliases: ls

describe

Describe an organization.
xata organization describe [--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: view, show

create

Create a new organization.
xata organization create --name <name> [--json] [-h|--help]
--name
string
required
Organization Name
--json
boolean
Output in JSON format (default: false)
-h, --help
boolean
Print help information and exit

delete

Delete an organization.
xata organization delete [--organization <id>] [--json] [--yes] [-h|--help]
--organization
string
Organization 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

get

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

Global Flags

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