Skip to main content

​
Workspaces

A workspace is an isolated backend environment in Xano containing your database tables, APIs, functions, tasks, and more. The CLI provides full workspace management.
Most workspace commands use the workspace ID stored in your profile. You can override it per-command with -w WORKSPACE_ID.

​
List Workspaces

Use -o json for the full JSON response.

​
Get Workspace Details

This returns details for the workspace in your current profile. To target a specific workspace, pass -w:

​
Create a Workspace

Argument / FlagDescription
nameWorkspace name (required, positional)
-dDescription
-oOutput format: summary or json

​
Edit a Workspace

Edits the workspace in your current profile: Target a different workspace with -w: You can also toggle settings: Use --no-swagger, --no-require-token, or --no-allow-push to disable those options.

​
Delete a Workspace

Deletes the workspace in your current profile: Target a different workspace with -w: Add -f (or --force) to skip the confirmation prompt.
Workspaces with active tenants cannot be deleted.

​
Branches

Branches are versions of a workspace’s business logic. They let you develop and test changes without affecting the live environment. Every workspace starts with a v1 branch.

​
List Branches

By default, backup branches are hidden to keep the list focused on the branches you actively work on. The output indicates which branch is (live): 
Branches for workspace 12345:
  v1 (live)
  v2-feature
Pass --backups to include backup branches (marked (backup)): 
Branches for workspace 12345:
  v1 (live)
  v2-feature
  v3-backup (backup)
The --backups filter is also respected by -o json. Backup branches are likewise hidden from the interactive branch pickers in xano auth and xano profile wizard. Target a different workspace with -w:

​
Get Branch Details

​
Create a Branch

By default, new branches are cloned from v1. To clone from a different source:
Argument / FlagDescription
labelBranch label (required, positional)
-sSource branch to clone from (default: v1)
-dDescription
-cColor hex code (e.g., #FF5733)
-wWorkspace ID
-oOutput format: summary or json

​
Edit a Branch

The v1 branch cannot be renamed.

​
Set a Branch Live

Promote a branch so that it serves all live API traffic: You’ll be asked to confirm before the switch takes effect. Use -f to skip confirmation.
Setting a branch live immediately affects all API consumers. Make sure you’ve tested the branch thoroughly before promoting it.

​
Delete a Branch

Add -f to skip confirmation.
The v1 branch and the currently live branch cannot be deleted. To delete a branch that is currently live, first set a different branch live with xano branch set_live <other-branch>, then delete the original branch.

​
Working with Profiles and Branches

Your profile can store a default branch, so you don’t need to specify it on every command. To update which branch your profile targets: To clear the branch (use the live branch by default): This is especially useful when you want push and pull operations to target a specific branch.