@xano/cli 0.0.37 → 0.0.40

package/README.md

@@ -13,195 +13,409 @@ npm install -g @xano/cli
 
 ## Quick Start
 
-1. Create a profile with the wizard:
+1. Authenticate with Xano:
    ```bash
-   xano profile:wizard
+   xano auth
    ```
 
 2. List your workspaces:
    ```bash
-   xano workspace:list
+   xano workspace list
    ```
 
-3. Execute XanoScript code:
+3. Pull a workspace to local files:
    ```bash
-   xano run exec script.xs
+   xano workspace pull ./my-workspace
    ```
 
 ## Commands
 
-### Profile Management
+### Authentication
 
-Profiles store your Xano credentials and default workspace/project settings.
+```bash
+# Interactive browser-based authentication
+xano auth
+xano auth --origin https://custom.xano.com
+```
+
+### Profiles
+
+Profiles store your Xano credentials and default workspace settings.
 
 ```bash
-# Create a profile interactively (auto-fetches run projects)
-xano profile:wizard
+# Create a profile interactively
+xano profile wizard
 
 # Create a profile manually
-xano profile:create myprofile -i https://instance.xano.com -t <access_token>
-
-# Create a profile with workspace and project
-xano profile:create myprofile -i https://instance.xano.com -t <access_token> -w my-workspace -j my-project
+xano profile create myprofile -i https://instance.xano.com -t <access_token>
 
 # List profiles
-xano profile:list
-xano profile:list --details
+xano profile list
+xano profile list --details                  # Show masked tokens and settings
 
-# Set default profile
-xano profile:set-default myprofile
+# Get/set default profile
+xano profile get_default
+xano profile set_default myprofile
 
 # Edit a profile
-xano profile:edit myprofile -w 123              # Set default workspace
-xano profile:edit myprofile -j my-project       # Set default project
+xano profile edit myprofile -w 123
+xano profile edit myprofile --remove-branch  # Remove branch from profile
+
+# Get current user info
+xano profile me
+
+# Print access token (useful for piping)
+xano profile token
+
+# Print workspace ID (useful for piping)
+xano profile workspace
 
 # Delete a profile
-xano profile:delete myprofile
+xano profile delete myprofile
 ```
 
-The `profile:wizard` command automatically fetches your run projects and sets the first one as the default for `xano run` commands.
-
 ### Workspaces
 
 ```bash
 # List all workspaces
-xano workspace:list
-xano workspace:list -o json
+xano workspace list
+
+# Get workspace details
+xano workspace get <workspace_id>
+
+# Create a workspace
+xano workspace create my-workspace
+xano workspace create my-workspace -d "My application workspace"
+
+# Edit a workspace
+xano workspace edit <workspace_id> --name "new-name" -d "Updated description"
+xano workspace edit <workspace_id> --swagger             # Enable swagger docs
+xano workspace edit <workspace_id> --no-swagger          # Disable swagger docs
+xano workspace edit <workspace_id> --require-token       # Require token for docs
+
+# Delete a workspace (confirmation required)
+xano workspace delete <workspace_id>
+xano workspace delete <workspace_id> --force
+
+# Pull workspace to local files
+xano workspace pull ./my-workspace
+xano workspace pull ./my-workspace -b dev              # Specific branch
+xano workspace pull ./my-workspace --env --records      # Include env vars and table records
+xano workspace pull ./my-workspace --draft              # Include draft changes
+
+# Push local files to workspace
+xano workspace push ./my-workspace
+xano workspace push ./my-workspace -b dev
+xano workspace push ./my-workspace --no-records         # Schema only
+xano workspace push ./my-workspace --no-env             # Skip env vars
+xano workspace push ./my-workspace --truncate           # Truncate tables before import
+```
+
+### Branches
+
+All branch commands use **branch labels** (e.g., `v1`, `dev`), not IDs.
+
+```bash
+# List branches
+xano branch list
+
+# Get branch details
+xano branch get <branch_label>
+
+# Create a branch
+xano branch create --label dev
+xano branch create -l feature-auth -s dev -d "Auth feature"
+xano branch create -l staging --color "#ebc346"
+
+# Edit a branch
+xano branch edit <branch_label> --label "new-label"
+xano branch edit <branch_label> --color "#ff0000"
+
+# Set live branch
+xano branch set_live <branch_label>
+xano branch set_live <branch_label> --force
+
+# Delete a branch
+xano branch delete <branch_label>
+xano branch delete <branch_label> --force
 ```
 
 ### Functions
 
 ```bash
-# List functions in a workspace
-xano function:list -w 40
-xano function:list -o json
+# List functions
+xano function list
+xano function list --include_draft --include_xanoscript
+xano function list --sort created_at --order desc --page 1 --per_page 50
 
-# Get a specific function
-xano function:get 145
-xano function:get 145 -o xs  # Output as XanoScript
+# Get a function
+xano function get <function_id>
+xano function get <function_id> -o xs                   # Output as XanoScript
+xano function get <function_id> -o json
 
 # Create a function from XanoScript
-xano function:create -f function.xs
-cat function.xs | xano function:create --stdin
+xano function create -f function.xs
+cat function.xs | xano function create --stdin
 
 # Edit a function
-xano function:edit 145           # Opens in $EDITOR
-xano function:edit 145 -f new.xs # Update from file
-xano function:edit 145 --publish # Publish after editing
+xano function edit <function_id>                        # Opens in $EDITOR
+xano function edit <function_id> -f new.xs              # Update from file
+xano function edit <function_id> --no-publish           # Edit without publishing
+```
+
+### Releases
+
+All release commands use **release names** (e.g., `v1.0`), not IDs.
+
+```bash
+# List releases
+xano release list
+
+# Get release details
+xano release get <release_name>
+
+# Create a release
+xano release create --name "v1.0" --branch main
+xano release create --name "v1.1-hotfix" --branch main --hotfix
+xano release create --name "v1.0" --branch main --table-ids 1,2,3
+
+# Edit a release
+xano release edit <release_name> --name "v1.0-final" -d "Updated description"
+
+# Export (download) a release
+xano release export <release_name>
+xano release export <release_name> --output ./backups/my-release.tar.gz
+
+# Import a release file
+xano release import --file ./my-release.tar.gz
+
+# Delete a release (confirmation required)
+xano release delete <release_name>
+xano release delete <release_name> --force
+
+# Pull release to local files
+xano release pull ./my-release -r v1.0
+xano release pull ./my-release -r v1.0 --env --records
+
+# Push local files as a new release
+xano release push ./my-release -n "v2.0"
+xano release push ./my-release -n "v2.0" --hotfix -d "Critical fix"
+xano release push ./my-release -n "v2.0" --no-records --no-env
+```
+
+### Platforms
+
+```bash
+# List platforms
+xano platform list
+
+# Get platform details
+xano platform get <platform_id>
+```
+
+### Testing
+
+#### Unit Tests
+
+```bash
+# List unit tests
+xano unit_test list
+xano unit_test list --branch dev --obj-type function
+
+# Run a single unit test
+xano unit_test run <unit_test_id>
+
+# Run all unit tests
+xano unit_test run_all
+xano unit_test run_all --branch dev --obj-type function
+```
+
+#### Workflow Tests
+
+```bash
+# List workflow tests
+xano workflow_test list
+xano workflow_test list --branch dev
+
+# Get workflow test details
+xano workflow_test get <workflow_test_id>
+xano workflow_test get <workflow_test_id> -o xs          # Output as XanoScript
+xano workflow_test get <workflow_test_id> --include-draft
+
+# Run a single workflow test
+xano workflow_test run <workflow_test_id>
+
+# Run all workflow tests
+xano workflow_test run_all
+xano workflow_test run_all --branch dev
+
+# Delete a workflow test
+xano workflow_test delete <workflow_test_id>
 ```
 
-### Xano Run
+### Tenants
 
-Execute XanoScript code and manage projects, sessions, environment variables, and secrets.
+Manage tenants, their environment variables, backups, deployments, and clusters.
 
-#### Executing Code
+#### CRUD
 
 ```bash
-# Execute XanoScript (job or service)
-xano run exec script.xs                          # Single file
-xano run exec ./my-workspace                     # Directory (multidoc from .xs files)
-xano run exec https://example.com/script.xs     # From URL
-xano run exec script.xs -a args.json             # With input arguments (file)
-xano run exec script.xs -a https://ex.com/args.json  # With input arguments (URL)
-xano run exec script.xs --edit                   # Edit in $EDITOR first
-xano run exec script.xs --env API_KEY=secret     # With env overrides
-cat script.xs | xano run exec --stdin            # From stdin
+# List tenants
+xano tenant list
+
+# Get tenant details
+xano tenant get <tenant_name>
+
+# Create a tenant
+xano tenant create "My Tenant"
+xano tenant create "My Tenant" -d "Description" --cluster_id 1 --platform_id 5
 
-# Get document info (type, inputs, env vars)
-xano run info -f script.xs
+# Edit a tenant
+xano tenant edit <tenant_name> --display "New Name" -d "New description"
+
+# Delete a tenant (confirmation required)
+xano tenant delete <tenant_name>
+xano tenant delete <tenant_name> --force
 ```
 
-When a directory is provided, all `.xs` files are collected recursively and combined into a multidoc (joined with `---` separators), similar to `xano workspace push`.
+#### Impersonate
+
+```bash
+# Open a tenant in the browser
+xano tenant impersonate <tenant_name>
 
-#### Projects
+# Print the URL without opening the browser
+xano tenant impersonate <tenant_name> --url-only
+
+# Output credentials as JSON
+xano tenant impersonate <tenant_name> -o json
+```
+
+#### Pull / Push
+
+```bash
+# Pull tenant to local files
+xano tenant pull ./my-tenant -t <tenant_name>
+xano tenant pull ./my-tenant -t <tenant_name> --env --records
+xano tenant pull ./my-tenant -t <tenant_name> --draft
+
+# Push local files to tenant
+xano tenant push ./my-tenant -t <tenant_name>
+xano tenant push ./my-tenant -t <tenant_name> --no-records
+xano tenant push ./my-tenant -t <tenant_name> --no-env
+xano tenant push ./my-tenant -t <tenant_name> --truncate
+```
+
+#### Deployments
 
 ```bash
-# List projects
-xano run projects list
+# Deploy a platform version
+xano tenant deploy_platform <tenant_name> --platform_id 5
 
-# Create a project
-xano run projects create -n "My Project"
-xano run projects create -n "My Project" -d "Description"
+# Deploy a release by name
+xano tenant deploy_release <tenant_name> --release v1.0
+```
+
+#### Tenant License
 
-# Update a project
-xano run projects update <project-id> -n "New Name"
-xano run projects update <project-id> -d "New description"
+```bash
+# Get tenant license
+xano tenant license get <tenant_name>
 
-# Delete a project
-xano run projects delete <project-id>
-xano run projects delete <project-id> --force    # Skip confirmation
+# Set tenant license
+xano tenant license set <tenant_name> --license tier2
 ```
 
-#### Sessions
+#### Tenant Environment Variables
 
 ```bash
-# List sessions
-xano run sessions list
+# List env var keys
+xano tenant env list <tenant_name>
 
-# Get session details
-xano run sessions get <session-id>
+# Get a single env var
+xano tenant env get <tenant_name> --name DATABASE_URL
 
-# Start/stop a session
-xano run sessions start <session-id>
-xano run sessions stop <session-id>
+# Set an env var
+xano tenant env set <tenant_name> --name DATABASE_URL --value postgres://...
 
-# Delete a session
-xano run sessions delete <session-id>
-xano run sessions delete <session-id> --force    # Skip confirmation
+# Delete an env var
+xano tenant env delete <tenant_name> --name DATABASE_URL
 
-# Get sink data for a completed session
-xano run sink get <session-id>
+# Export all env vars to YAML
+xano tenant env get_all <tenant_name>
+xano tenant env get_all <tenant_name> --file ./env.yaml
+
+# Import all env vars from YAML (replaces existing)
+xano tenant env set_all <tenant_name>
+xano tenant env set_all <tenant_name> --file ./env.yaml --clean
 ```
 
-#### Environment Variables
+#### Backups
 
 ```bash
-# List environment variable keys
-xano run env list
+# List backups
+xano tenant backup list <tenant_name>
+
+# Create a backup
+xano tenant backup create <tenant_name>
 
-# Set an environment variable
-xano run env set API_KEY my-secret-key
+# Export (download) a backup
+xano tenant backup export <tenant_name> --backup_id 10
+xano tenant backup export <tenant_name> --backup_id 10 --output ./backup.tar.gz
 
-# Get an environment variable value
-xano run env get API_KEY
+# Import a backup file
+xano tenant backup import <tenant_name> --file ./backup.tar.gz
 
-# Delete an environment variable
-xano run env delete API_KEY
-xano run env delete API_KEY --force              # Skip confirmation
+# Restore from a backup
+xano tenant backup restore <tenant_name> --backup_id 10
+
+# Delete a backup (confirmation required)
+xano tenant backup delete <tenant_name> --backup_id 10
+xano tenant backup delete <tenant_name> --backup_id 10 --force
 ```
 
-#### Secrets
+#### Clusters
 
 ```bash
-# List secrets
-xano run secrets list
+# List clusters
+xano tenant cluster list
+
+# Get cluster details
+xano tenant cluster get <cluster_id>
+
+# Create a cluster
+xano tenant cluster create --name "us-east-1" --credentials_file ./kubeconfig.yaml
+xano tenant cluster create --name "eu-west-1" --type run -d "EU run cluster"
 
-# Set a secret
-xano run secrets set docker-registry -t dockerconfigjson -v '{"auths":{...}}' -r ghcr.io
-xano run secrets set service-key -t service-account-token -v 'token-value'
+# Edit a cluster
+xano tenant cluster edit <cluster_id> --name "us-east-1" -d "Updated" --domain "us-east.xano.io"
 
-# Get a secret value
-xano run secrets get docker-registry
+# Delete a cluster (confirmation required)
+xano tenant cluster delete <cluster_id>
+xano tenant cluster delete <cluster_id> --force
 
-# Delete a secret
-xano run secrets delete docker-registry
-xano run secrets delete docker-registry --force  # Skip confirmation
+# Get cluster kubeconfig
+xano tenant cluster license get <cluster_id>
+
+# Set cluster kubeconfig
+xano tenant cluster license set <cluster_id>
+xano tenant cluster license set <cluster_id> --file ./kubeconfig.yaml
 ```
 
 ### Static Hosts
 
 ```bash
 # List static hosts
-xano static_host:list
+xano static_host list
 
 # Create a build
-xano static_host:build:create default -f ./build.zip -n "v1.0.0"
+xano static_host build create default -f ./build.zip -n "v1.0.0"
 
 # List builds
-xano static_host:build:list default
+xano static_host build list default
 
 # Get build details
-xano static_host:build:get default 52
+xano static_host build get default 52
 ```
 
 ## Global Options
@@ -220,7 +434,7 @@ All commands support these options:
 Use `-v` or `--verbose` to see detailed HTTP request and response information, useful for debugging:
 
 ```bash
-xano run exec script.xs -v
+xano workspace list -v
 ```
 
 This will show:
@@ -240,10 +454,19 @@ profiles:
     access_token: <token>
     workspace: <workspace_id>
     branch: <branch_id>
-    project: <project_id>
 default: default
 ```
 
+## Scripts
+
+### Bump Version
+
+```bash
+./scripts/bump-version.sh           # patch: 0.0.38 -> 0.0.39
+./scripts/bump-version.sh minor     # minor: 0.0.38 -> 0.1.0
+./scripts/bump-version.sh major     # major: 0.0.38 -> 1.0.0
+```
+
 ## Help
 
 ```bash

package/dist/commands/auth/index.d.ts

@@ -8,13 +8,11 @@ export default class Auth extends Command {
     run(): Promise<void>;
     private fetchBranches;
     private fetchInstances;
-    private fetchProjects;
     private fetchWorkspaces;
     private promptProfileName;
     private saveProfile;
     private selectBranch;
     private selectInstance;
-    private selectProject;
     private selectWorkspace;
     private startAuthServer;
     private validateToken;

package/dist/commands/auth/index.js

@@ -49,7 +49,6 @@ Opening browser for Xano login at https://custom.xano.com...`,
             // Step 4: Workspace selection
             let workspace;
             let branch;
-            let project;
             this.log('');
             this.log('Fetching available workspaces...');
             const workspaces = await this.fetchWorkspaces(token, instance.origin);
@@ -63,26 +62,18 @@ Opening browser for Xano login at https://custom.xano.com...`,
                     if (branches.length > 0) {
                         branch = await this.selectBranch(branches);
                     }
-                    // Step 6: Project selection
-                    this.log('');
-                    this.log('Fetching available projects...');
-                    const projects = await this.fetchProjects(token, instance.origin, workspace.id, branch);
-                    if (projects.length > 0) {
-                        project = await this.selectProject(projects);
-                    }
                 }
             }
-            // Step 7: Profile name
+            // Step 6: Profile name
             this.log('');
             const profileName = await this.promptProfileName();
-            // Step 8: Save profile
+            // Step 7: Save profile
             await this.saveProfile({
                 access_token: token,
                 account_origin: flags.origin,
                 branch,
                 instance_origin: instance.origin,
                 name: profileName,
-                project,
                 workspace: workspace?.id,
             });
             this.log('');
@@ -148,32 +139,6 @@ Opening browser for Xano login at https://custom.xano.com...`,
         }
         return [];
     }
-    async fetchProjects(accessToken, origin, workspaceId, branchId) {
-        try {
-            const branchParam = branchId ? `?branch=${branchId}` : '';
-            const response = await fetch(`${origin}/api:meta/workspace/${workspaceId}/project${branchParam}`, {
-                headers: {
-                    accept: 'application/json',
-                    Authorization: `Bearer ${accessToken}`,
-                },
-                method: 'GET',
-            });
-            if (!response.ok) {
-                throw new Error(`API request failed with status ${response.status}`);
-            }
-            const data = (await response.json());
-            if (Array.isArray(data)) {
-                return data.map((proj) => ({
-                    id: proj.id || proj.name,
-                    name: proj.name,
-                }));
-            }
-            return [];
-        }
-        catch {
-            return [];
-        }
-    }
     async fetchWorkspaces(accessToken, origin) {
         try {
             const response = await fetch(`${origin}/api:meta/workspace`, {
@@ -245,7 +210,6 @@ Opening browser for Xano login at https://custom.xano.com...`,
             instance_origin: profile.instance_origin,
             ...(profile.workspace && { workspace: profile.workspace }),
             ...(profile.branch && { branch: profile.branch }),
-            ...(profile.project && { project: profile.project }),
         };
         // Set as default profile
         credentials.default = profile.name;
@@ -288,23 +252,6 @@ Opening browser for Xano login at https://custom.xano.com...`,
         ]);
         return instances.find((inst) => inst.id === instanceId);
     }
-    async selectProject(projects) {
-        const { selectedProject } = await inquirer.prompt([
-            {
-                choices: [
-                    { name: '(Skip project)', value: '' },
-                    ...projects.map((proj) => ({
-                        name: proj.name,
-                        value: proj.id,
-                    })),
-                ],
-                message: 'Select a project',
-                name: 'selectedProject',
-                type: 'list',
-            },
-        ]);
-        return selectedProject || undefined;
-    }
     async selectWorkspace(workspaces) {
         const { selectedWorkspace } = await inquirer.prompt([
             {

package/dist/commands/profile/create/index.d.ts

@@ -11,8 +11,6 @@ export default class ProfileCreate extends Command {
         branch: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         default: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         instance_origin: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        project: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        run_base_url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;