Organization Command

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

Subcommands

list

List all organizations.

xata organization list [--json] [-h|--help]

• Aliases: ls
• --json: Output in JSON format (default: false)
• -h, --help: Print help information and exit

describe

Describe an organization.

xata organization describe [--organization <id>] [--json] [-h|--help]

• Aliases: view, show
• --organization: Organization ID (default: "")
• --json: Output in JSON format (default: false)
• -h, --help: Print help information and exit

create

Create a new organization.

xata organization create --name <name> [--json] [-h|--help]

• --name: Organization Name (required)
• --json: Output in JSON format (default: false)
• -h, --help: Print help information and exit

delete

Delete an organization.

xata organization delete [--organization <id>] [--json] [--yes] [-h|--help]

• --organization: Organization ID (default: "")
• --json: Output in JSON format (default: false)
• --yes: Do not ask for confirmation, assume yes (default: false)
• -h, --help: Print help information and exit

get

Get a field from an organization description.

xata organization get [--organization <id>] <field> [-h|--help]

• --organization: Organization ID (default: "")
• field: The field to get (default: .catalog)
• -h, --help: Print help information and exit

Global Flags

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