checkout

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.

This command also takes -h, --help.

checkout

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] [--json] [--profile value] [<branch>]

--organization · string

Organization ID

--project · string

Project ID

--branch · string

Branch ID or name

--database · string

Database name

--json · boolean · default: "false"

Output in JSON format

--profile · string

The profile to use

branch · 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