checkout

Writes the branch to .xata/ in this folder, so later commands run against it without being told which branch to use. This command also takes -h, --help.

Check out a branch in this folder Writes the branch to .xata/ in this folder, so later commands run against it without being told which branch to use.

xata checkout [--organization value] [--project value] [--branch value] [--database value] [--profile value] [--debug] [--json] [<branch>]

string

Organization ID

string

Project ID

string

Branch ID or name

string

Database name

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 branch to switch to

Examples:

# Check out a branch of the current project
xata checkout main
# Check out a branch of another project
xata checkout feature-branch --organization org-123 --project proj-456