Command Reference

This page lists every Xano CLI command with its flags and usage. For detailed guides on each topic, see the linked pages.

Global Flags

These flags are available on all commands:

Flag	Env Variable	Description
`-p, --profile`	`XANO_PROFILE`	Use a specific profile instead of the default
`-v, --verbose`	`XANO_VERBOSE`	Show HTTP request/response details for troubleshooting

`xano auth`

Browser-based authentication. Opens your browser to log in and creates a profile.

xano auth
xano auth -o https://my-xano.my-domain.com
xano auth -o https://my-xano.my-domain.com --insecure

Flag	Description
`-o, --origin`	Account/environment URL (for self-hosted or non-production)
`-k, --insecure`	Skip TLS certificate verification

See Get Started — Authentication.

`xano update`

Update the CLI to the latest version.

xano update
xano update --check

Flag	Description
`--check`	Check for updates without installing

`xano profile`

Manage CLI profiles. See Profiles for full documentation.

Command	Description
`xano profile wizard`	Interactive token-based profile setup
`xano profile create <name>`	Create a profile non-interactively
`xano profile edit <name>`	Update fields on an existing profile
`xano profile list`	List all profiles (`-d` for details)
`xano profile get`	Print the default profile name
`xano profile set <name>`	Set the default profile
`xano profile me`	Verify the current profile against the Xano API
`xano profile token`	Print the access token for the default profile
`xano profile workspace`	Print the workspace ID for the default profile
`xano profile workspace set`	Interactively change the workspace on a profile
`xano profile delete <name>`	Delete a profile (`-f` to skip confirmation)

`xano profile wizard`

xano profile wizard
xano profile wizard -n production -o https://my-xano.my-domain.com

Flag	Description
`-n`	Profile name
`-o`	Account/environment origin URL

`xano profile create`

xano profile create my-profile -t TOKEN -i https://instance.xano.io -w WORKSPACE_ID -b BRANCH --default

Flag	Description
`-t`	Access token (required)
`-i`	Instance origin URL (required)
`-a`	Account origin URL (for self-hosted)
`-w`	Workspace ID
`-b`	Branch label
`-k, --insecure`	Skip TLS certificate verification
`--default`	Set as the default profile

`xano profile edit`

xano profile edit my-profile -w NEW_WORKSPACE_ID
xano profile edit my-profile --remove-branch
xano profile edit my-profile --insecure

Flag	Description
`-t`	Access token
`-i`	Instance origin URL
`-a`	Account origin URL
`-w`	Workspace ID
`-b`	Branch label
`-k, --insecure`	Enable insecure mode
`--remove-branch`	Clear the branch
`--remove-insecure`	Disable insecure mode
`--default`	Set as default

`xano workspace`

Manage workspaces. See Workspaces & Branches for full documentation.

Command	Description
`xano workspace list`	List all workspaces
`xano workspace get [id]`	Get workspace details
`xano workspace create <name>`	Create a workspace
`xano workspace edit <id>`	Edit a workspace
`xano workspace delete <id>`	Delete a workspace (`-f` to skip confirmation)
`xano workspace pull <dir>`	Pull workspace to local files
`xano workspace push <dir>`	Push local files to workspace
`xano workspace git pull <dir>`	Pull XanoScript from a Git repo

`xano workspace pull`

xano workspace pull ./my-workspace
xano workspace pull ./my-workspace -b v2-feature --env --records --draft

Flag	Description
`-b`	Branch name (overrides profile)
`-w`	Workspace ID (overrides profile)
`--env`	Include environment variables
`--records`	Include database records
`--draft`	Include draft versions of resources

See Push & Pull — Pull.

`xano workspace push`

xano workspace push ./my-workspace
xano workspace push ./my-workspace --dry-run
xano workspace push ./my-workspace --force --delete --no-sync-guids

Flag	Description
`-b`	Branch name (overrides profile)
`-w`	Workspace ID (overrides profile)
`--records`	Include table records
`--env`	Include environment variables
`--dry-run`	Show preview then exit without applying
`--force`	Skip preview and confirmation prompt
`--partial`	Push without requiring a workspace block
`--delete`	Delete remote objects not present locally
`--no-sync-guids`	Skip writing server-assigned GUIDs back to local files
`--truncate`	Truncate all table records before importing

See Push & Pull — Push.

`xano workspace git pull`

xano workspace git pull ./output -r https://github.com/owner/repo
xano workspace git pull ./output -r https://github.com/owner/repo -b main --path src/

Flag	Description
`-r`	Git repository URL (required)
`-b`	Branch, tag, or ref
`-t`	Personal access token for private repos
`--path`	Subdirectory within the repo

See Push & Pull — Pull from Git.

`xano workspace create`

xano workspace create "My Workspace" -d "Description"

Flag	Description
`-d`	Description
`-o`	Output format: `summary` or `json`

`xano workspace edit`

xano workspace edit WORKSPACE_ID -n "New Name" -d "New description"
xano workspace edit WORKSPACE_ID --swagger --require-token

Flag	Description
`-n`	Workspace name
`-d`	Description
`--swagger` / `--no-swagger`	Enable/disable Swagger
`--require-token` / `--no-require-token`	Enable/disable token requirement

`xano branch`

Manage workspace branches. See Workspaces & Branches for full documentation.

Command	Description
`xano branch list [workspace_id]`	List all branches
`xano branch get <label>`	Get branch details
`xano branch create`	Create a new branch
`xano branch edit <label>`	Edit a branch
`xano branch set_live <label>`	Promote a branch to live
`xano branch delete <label>`	Delete a branch (`-f` to skip confirmation)

`xano branch create`

xano branch create -l v2-feature
xano branch create -l v3-hotfix -s v2-feature -d "Hotfix branch" -c "#FF5733"

Flag	Description
`-l`	Branch label (required)
`-s`	Source branch to clone from (default: `v1`)
`-d`	Description
`-c`	Color hex code
`-w`	Workspace ID

`xano branch edit`

xano branch edit v2-feature -l v2-ready -d "Ready for review" -c "#00FF00"

Flag	Description
`-l`	New branch label
`-d`	Description
`-c`	Color hex code

`xano release`

Manage versioned releases. See Releases for full documentation.

Command	Description
`xano release list`	List all releases
`xano release get <name>`	Get release details
`xano release create`	Create a release
`xano release edit <name>`	Edit a release
`xano release delete <name>`	Delete a release (`-f` to skip confirmation)
`xano release export <name>`	Export release as `.tar.gz`
`xano release import`	Import a release file
`xano release pull <dir>`	Pull release as local XanoScript
`xano release push <dir>`	Push local files as a new release

`xano release create`

xano release create -n "v1.0" -b v1 -d "Initial release"

Flag	Description
`-n`	Release name (required)
`-b`	Branch to create from (required)
`-d`	Description
`--hotfix`	Mark as a hotfix release
`--table-ids`	Comma-separated table IDs to include
`-w`	Workspace ID

`xano release pull`

xano release pull ./my-release -r v1.0

Flag	Description
`-r`	Release name (required)
`--env`	Include environment variables
`--records`	Include database records
`-w`	Workspace ID

`xano release push`

xano release push ./my-release -n "v2.0"

Flag	Description
`-n`	Release name (required)
`-d`	Description
`--hotfix`	Mark as a hotfix release
`--no-records`	Skip importing records
`--no-env`	Skip environment variables
`-w`	Workspace ID

`xano release export`

xano release export v1.0
xano release export v1.0 --output ./backups/release.tar.gz

Flag	Description
`--output`	Custom output file path

`xano release import`

xano release import --file ./my-release.tar.gz

Flag	Description
`--file`	Path to release `.tar.gz` file (required)

`xano tenant`

Manage tenants, deployments, and backups. See Tenants for full documentation.

Command	Description
`xano tenant list`	List all tenants
`xano tenant get <name>`	Get tenant details
`xano tenant create <display>`	Create a tenant
`xano tenant edit <name>`	Edit a tenant
`xano tenant delete <name>`	Delete a tenant (`-f` to skip confirmation)
`xano tenant impersonate <name>`	Open tenant dashboard in browser
`xano tenant pull <dir>`	Pull tenant as local XanoScript
`xano tenant push <dir>`	Push local files to a tenant
`xano tenant deploy_release <name>`	Deploy a release to a tenant
`xano tenant deploy_platform <name>`	Deploy a platform to a tenant
`xano tenant license get <name>`	Get tenant license
`xano tenant license set <name>`	Set tenant license

`xano tenant create`

xano tenant create "My Tenant" --license tier2 --cluster_id 5

Flag	Description
`-d`	Description
`--license`	License tier: `tier1` (default), `tier2`, `tier3`
`--cluster_id`	Cluster ID (required for tier2/tier3)
`--platform_id`	Platform ID
`--domain`	Custom domain
`--ephemeral`	Mark as ephemeral
`--ingress / --no-ingress`	Enable/disable ingress
`--tasks / --no-tasks`	Enable/disable background tasks
`-w`	Workspace ID

`xano tenant pull`

xano tenant pull ./my-tenant -t TENANT_NAME

Flag	Description
`-t`	Tenant name (required)
`--env`	Include environment variables
`--records`	Include database records
`--draft`	Include draft versions
`-w`	Workspace ID

`xano tenant push`

xano tenant push ./my-tenant -t TENANT_NAME

Flag	Description
`-t`	Tenant name (required)
`--no-records`	Skip importing records
`--no-env`	Skip environment variables
`--truncate`	Truncate records before importing
`-w`	Workspace ID

Tenant Environment Variables

Command	Description
`xano tenant env list <name>`	List env var keys
`xano tenant env get <name> --name KEY`	Get a single env var
`xano tenant env set <name> --name KEY --value VAL`	Set an env var
`xano tenant env delete <name> --name KEY`	Delete an env var
`xano tenant env get_all <name>`	Export all env vars (`--file` for YAML)
`xano tenant env set_all <name>`	Import env vars from YAML (`--file`, `--clean`)

Tenant Backups

Command	Description
`xano tenant backup list <name>`	List backups (`--page` for pagination)
`xano tenant backup create <name>`	Create a backup
`xano tenant backup restore <name>`	Restore from backup (`--backup_id`, `-f`)
`xano tenant backup export <name>`	Export backup as `.tar.gz` (`--backup_id`, `--output`)
`xano tenant backup import <name>`	Import a backup file (`--file`)
`xano tenant backup delete <name>`	Delete a backup (`--backup_id`, `-f`)

Tenant Clusters

Command	Description
`xano tenant cluster list`	List clusters
`xano tenant cluster get <id>`	Get cluster details
`xano tenant cluster create`	Create a cluster (`--name`, `--credentials_file`)
`xano tenant cluster edit <id>`	Edit a cluster
`xano tenant cluster delete <id>`	Delete a cluster (`-f`)
`xano tenant cluster license get <id>`	Get cluster kubeconfig
`xano tenant cluster license set <id>`	Set cluster kubeconfig (`--file`)

`xano platform`

View platform versions. See Platforms for full documentation.

Command	Description
`xano platform list`	List all platforms
`xano platform get <id>`	Get platform details

`xano unit_test`

Run unit tests. See Testing for full documentation.

Command	Description
`xano unit_test list`	List unit tests (`--branch`, `--obj-type`)
`xano unit_test run <id>`	Run a single unit test
`xano unit_test run_all`	Run all unit tests (`--branch`, `--obj-type`)

`xano workflow_test`

Run workflow tests. See Testing for full documentation.

Command	Description
`xano workflow_test list`	List workflow tests (`-b` for branch)
`xano workflow_test get <id>`	Get test details (`--include-draft`, `-o`)
`xano workflow_test run <id>`	Run a single test
`xano workflow_test run_all`	Run all tests (`-b` for branch)
`xano workflow_test delete <id>`	Delete a test (`-f`)

`xano function`

Manage custom functions.

Command	Description
`xano function list`	List all custom functions
`xano function get <id>`	Get function details
`xano function run <id>`	Run a function

`xano static_host`

Manage static file hosting.

Command	Description
`xano static_host list`	List static hosts
`xano static_host get <id>`	Get static host details
`xano static_host upload <dir>`	Upload files to a static host

Getting Started

Core Concepts

Commands

Guides

Reference

Global Flags

`xano auth`

`xano update`

`xano profile`

`xano profile wizard`

`xano profile create`

`xano profile edit`

`xano workspace`

`xano workspace pull`

`xano workspace push`

`xano workspace git pull`

`xano workspace create`

`xano workspace edit`

`xano branch`

`xano branch create`

`xano branch edit`

`xano release`

`xano release create`

`xano release pull`

`xano release push`

`xano release export`

`xano release import`

`xano tenant`

`xano tenant create`

`xano tenant pull`

`xano tenant push`

Tenant Environment Variables

Tenant Backups

Tenant Clusters

`xano platform`

`xano unit_test`

`xano workflow_test`

`xano function`

`xano static_host`

Getting Started

Core Concepts

Commands

Guides

Reference

​Global Flags

​xano auth

​xano update

​xano profile

​xano profile wizard

​xano profile create

​xano profile edit

​xano workspace

​xano workspace pull

​xano workspace push

​xano workspace git pull

​xano workspace create

​xano workspace edit

​xano branch

​xano branch create

​xano branch edit

​xano release

​xano release create

​xano release pull

​xano release push

​xano release export

​xano release import

​xano tenant

​xano tenant create

​xano tenant pull

​xano tenant push

​Tenant Environment Variables

​Tenant Backups

​Tenant Clusters

​xano platform

​xano unit_test

​xano workflow_test

​xano function

​xano static_host

Global Flags

`xano auth`

`xano update`

`xano profile`

`xano profile wizard`

`xano profile create`

`xano profile edit`

`xano workspace`

`xano workspace pull`

`xano workspace push`

`xano workspace git pull`

`xano workspace create`

`xano workspace edit`

`xano branch`

`xano branch create`

`xano branch edit`

`xano release`

`xano release create`

`xano release pull`

`xano release push`

`xano release export`

`xano release import`

`xano tenant`

`xano tenant create`

`xano tenant pull`

`xano tenant push`

Tenant Environment Variables

Tenant Backups

Tenant Clusters

`xano platform`

`xano unit_test`

`xano workflow_test`

`xano function`

`xano static_host`