The sandbox is an isolated copy of your workspace where you can push and test changes without affecting your live environment. Once you’re satisfied, you can review and promote changes from the sandbox to your workspace through the browser.
Sandbox commands operate on your personal sandbox environment, which is tied to your profile. You don’t need to specify a workspace or tenant — the CLI manages this automatically.
Get Your Sandbox
This returns your sandbox details. If you don’t have one yet, it creates one automatically. Use -o json for the full JSON response.
Pull & Push
The sandbox supports the same pull and push workflow as workspace pull & push, using the multidoc format behind the scenes.
Pull from Sandbox
| Flag | Description |
|---|
--env | Include environment variables |
--records | Include database records |
--draft | Include draft versions of resources |
Push to Sandbox
| Flag | Description |
|---|
--env | Include environment variables in import |
--records | Include records in import |
--truncate | Truncate all table records before importing |
--no-transaction | Skip wrapping the import in a database transaction |
This is the recommended way to deploy changes to tenants. Instead of pushing directly to a tenant (which is not supported), push to your sandbox first, review the changes, then promote them.
Open your sandbox in the browser to review changes and promote them to the workspace:
To get the URL without opening the browser (useful for scripting):
Reset
Reset your sandbox to clear all workspace data and drafts, returning it to a clean state:
Add -f to skip the confirmation prompt.
Resetting a sandbox clears all data and drafts. This cannot be undone.
Delete
Delete your sandbox environment entirely. It will be re-created automatically the next time you access it.
Add -f to skip the confirmation prompt.
Environment Variables
Manage environment variables on your sandbox, just like tenant environment variables.
List Env Var Keys
Get a Single Env Var
Set an Env Var
Delete an Env Var
Export All Env Vars
Export all environment variables to a YAML file:
Import All Env Vars
Import environment variables from a YAML file (replaces existing):
Sandbox License
Sandbox Tests
Run unit tests and workflow tests against your sandbox environment.
Unit Tests
Filter by branch or object type:
Workflow Tests
Filter by branch with -b:
Typical Workflow
A common pattern for deploying changes through the sandbox:
Make changes locally
Edit .xs files in your editor or with AI tools.
Test in the sandbox
Review and test your changes in the sandbox environment.
Promote to your workspace
Open the sandbox in the browser to review and promote:
Xano