@xano/cli 0.0.26 → 0.0.28

package/dist/commands/static_host/list/index.d.ts

@@ -1,15 +1,16 @@
 import BaseCommand from '../../../base-command.js';
 export default class StaticHostList extends BaseCommand {
     static args: {};
+    static description: string;
+    static examples: string[];
     static flags: {
-        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
         per_page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    static description: string;
-    static examples: string[];
     run(): Promise<void>;
     private loadCredentials;
 }

package/dist/commands/static_host/list/index.js

@@ -1,36 +1,11 @@
 import { Flags } from '@oclif/core';
+import * as yaml from 'js-yaml';
 import * as fs from 'node:fs';
 import * as os from 'node:os';
 import * as path from 'node:path';
-import * as yaml from 'js-yaml';
 import BaseCommand from '../../../base-command.js';
 export default class StaticHostList extends BaseCommand {
     static args = {};
-    static flags = {
-        ...BaseCommand.baseFlags,
-        workspace: Flags.string({
-            char: 'w',
-            description: 'Workspace ID (optional if set in profile)',
-            required: false,
-        }),
-        output: Flags.string({
-            char: 'o',
-            description: 'Output format',
-            required: false,
-            default: 'summary',
-            options: ['summary', 'json'],
-        }),
-        page: Flags.integer({
-            description: 'Page number for pagination',
-            required: false,
-            default: 1,
-        }),
-        per_page: Flags.integer({
-            description: 'Number of results per page',
-            required: false,
-            default: 50,
-        }),
-    };
     static description = 'List all static hosts in a workspace from the Xano Metadata API';
     static examples = [
         `$ xano static_host:list -w 40
@@ -61,6 +36,31 @@ Available static hosts:
 ]
 `,
     ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        page: Flags.integer({
+            default: 1,
+            description: 'Page number for pagination',
+            required: false,
+        }),
+        per_page: Flags.integer({
+            default: 50,
+            description: 'Number of results per page',
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (optional if set in profile)',
+            required: false,
+        }),
+    };
     async run() {
         const { flags } = await this.parse(StaticHostList);
         // Get profile name (default or from flag/env)
@@ -106,11 +106,11 @@ Available static hosts:
         // Fetch static hosts from the API
         try {
             const response = await fetch(apiUrl, {
-                method: 'GET',
                 headers: {
                     'accept': 'application/json',
                     'Authorization': `Bearer ${profile.access_token}`,
                 },
+                method: 'GET',
             });
             if (!response.ok) {
                 const errorText = await response.text();
@@ -143,12 +143,12 @@ Available static hosts:
                 else {
                     this.log('Available static hosts:');
                     for (const host of staticHosts) {
-                        if (host.id !== undefined) {
-                            const domainInfo = host.domain ? ` - ${host.domain}` : '';
-                            this.log(`  - ${host.name} (ID: ${host.id})${domainInfo}`);
+                        if (host.id === undefined) {
+                            this.log(`  - ${host.name}`);
                         }
                         else {
-                            this.log(`  - ${host.name}`);
+                            const domainInfo = host.domain ? ` - ${host.domain}` : '';
+                            this.log(`  - ${host.name} (ID: ${host.id})${domainInfo}`);
                         }
                     }
                 }

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

@@ -0,0 +1,14 @@
+import BaseCommand from '../../../base-command.js';
+export default class WorkspaceCreate extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private loadCredentials;
+}

package/dist/commands/workspace/create/index.js

@@ -0,0 +1,131 @@
+import { Flags } from '@oclif/core';
+import * as yaml from 'js-yaml';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import BaseCommand from '../../../base-command.js';
+export default class WorkspaceCreate extends BaseCommand {
+    static description = 'Create a new workspace via the Xano Metadata API';
+    static examples = [
+        `$ xano workspace create --name "my-workspace"
+Created workspace: my-workspace (ID: 123)
+`,
+        `$ xano workspace create --name "my-app" --description "My application workspace"
+Created workspace: my-app (ID: 456)
+  Description: My application workspace
+`,
+        `$ xano workspace create -n "new-project" -d "New project workspace" -o json
+{
+  "id": 789,
+  "name": "new-project",
+  "description": "New project workspace"
+}
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        description: Flags.string({
+            char: 'd',
+            description: 'Description for the workspace',
+            required: false,
+        }),
+        name: Flags.string({
+            char: 'n',
+            description: 'Name of the workspace',
+            required: true,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(WorkspaceCreate);
+        // Get profile name (default or from flag/env)
+        const profileName = flags.profile || this.getDefaultProfile();
+        // Load credentials
+        const credentials = this.loadCredentials();
+        // Get the profile configuration
+        if (!(profileName in credentials.profiles)) {
+            this.error(`Profile '${profileName}' not found. Available profiles: ${Object.keys(credentials.profiles).join(', ')}\n` +
+                `Create a profile using 'xano profile create'`);
+        }
+        const profile = credentials.profiles[profileName];
+        // Validate required fields
+        if (!profile.instance_origin) {
+            this.error(`Profile '${profileName}' is missing instance_origin`);
+        }
+        if (!profile.access_token) {
+            this.error(`Profile '${profileName}' is missing access_token`);
+        }
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace`;
+        // Build request body
+        const body = {
+            name: flags.name,
+        };
+        if (flags.description) {
+            body.description = flags.description;
+        }
+        // Create workspace via the API
+        try {
+            const response = await fetch(apiUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                    'content-type': 'application/json',
+                },
+                method: 'POST',
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const workspace = await response.json();
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(workspace, null, 2));
+            }
+            else {
+                // summary format
+                this.log(`Created workspace: ${workspace.name} (ID: ${workspace.id})`);
+                if (workspace.description) {
+                    this.log(`  Description: ${workspace.description}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to create workspace: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to create workspace: ${String(error)}`);
+            }
+        }
+    }
+    loadCredentials() {
+        const configDir = path.join(os.homedir(), '.xano');
+        const credentialsPath = path.join(configDir, 'credentials.yaml');
+        // Check if credentials file exists
+        if (!fs.existsSync(credentialsPath)) {
+            this.error(`Credentials file not found at ${credentialsPath}\n` +
+                `Create a profile using 'xano profile create'`);
+        }
+        // Read credentials file
+        try {
+            const fileContent = fs.readFileSync(credentialsPath, 'utf8');
+            const parsed = yaml.load(fileContent);
+            if (!parsed || typeof parsed !== 'object' || !('profiles' in parsed)) {
+                this.error('Credentials file has invalid format.');
+            }
+            return parsed;
+        }
+        catch (error) {
+            this.error(`Failed to parse credentials file: ${error}`);
+        }
+    }
+}

package/dist/commands/workspace/delete/index.d.ts

@@ -0,0 +1,20 @@
+import BaseCommand from '../../../base-command.js';
+export default class WorkspaceDelete extends BaseCommand {
+    static args: {
+        workspace_id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private confirm;
+    private loadCredentials;
+}

package/dist/commands/workspace/delete/index.js

@@ -0,0 +1,141 @@
+import { Args, Flags } from '@oclif/core';
+import * as yaml from 'js-yaml';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import BaseCommand from '../../../base-command.js';
+export default class WorkspaceDelete extends BaseCommand {
+    static args = {
+        workspace_id: Args.integer({
+            description: 'Workspace ID to delete',
+            required: true,
+        }),
+    };
+    static description = 'Delete a workspace via the Xano Metadata API. Cannot delete workspaces with active tenants.';
+    static examples = [
+        `$ xano workspace delete 123
+Are you sure you want to delete workspace 123? This action cannot be undone. (y/N) y
+Deleted workspace 123
+`,
+        `$ xano workspace delete 123 --force
+Deleted workspace 123
+`,
+        `$ xano workspace delete 123 -f -o json
+{
+  "deleted": true,
+  "workspace_id": 123
+}
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        force: Flags.boolean({
+            char: 'f',
+            default: false,
+            description: 'Skip confirmation prompt',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(WorkspaceDelete);
+        // Get profile name (default or from flag/env)
+        const profileName = flags.profile || this.getDefaultProfile();
+        // Load credentials
+        const credentials = this.loadCredentials();
+        // Get the profile configuration
+        if (!(profileName in credentials.profiles)) {
+            this.error(`Profile '${profileName}' not found. Available profiles: ${Object.keys(credentials.profiles).join(', ')}\n` +
+                `Create a profile using 'xano profile create'`);
+        }
+        const profile = credentials.profiles[profileName];
+        // Validate required fields
+        if (!profile.instance_origin) {
+            this.error(`Profile '${profileName}' is missing instance_origin`);
+        }
+        if (!profile.access_token) {
+            this.error(`Profile '${profileName}' is missing access_token`);
+        }
+        const workspaceId = args.workspace_id;
+        // Confirmation prompt unless --force is used
+        if (!flags.force) {
+            const confirmed = await this.confirm(`Are you sure you want to delete workspace ${workspaceId}? This action cannot be undone.`);
+            if (!confirmed) {
+                this.log('Deletion cancelled.');
+                return;
+            }
+        }
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}`;
+        // Delete workspace via the API
+        try {
+            const response = await fetch(apiUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'DELETE',
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify({ deleted: true, workspace_id: workspaceId }, null, 2));
+            }
+            else {
+                this.log(`Deleted workspace ${workspaceId}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to delete workspace: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to delete workspace: ${String(error)}`);
+            }
+        }
+    }
+    async confirm(message) {
+        // Use readline for simple yes/no confirmation
+        const readline = await import('node:readline');
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        return new Promise((resolve) => {
+            rl.question(`${message} (y/N) `, (answer) => {
+                rl.close();
+                resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
+            });
+        });
+    }
+    loadCredentials() {
+        const configDir = path.join(os.homedir(), '.xano');
+        const credentialsPath = path.join(configDir, 'credentials.yaml');
+        // Check if credentials file exists
+        if (!fs.existsSync(credentialsPath)) {
+            this.error(`Credentials file not found at ${credentialsPath}\n` +
+                `Create a profile using 'xano profile create'`);
+        }
+        // Read credentials file
+        try {
+            const fileContent = fs.readFileSync(credentialsPath, 'utf8');
+            const parsed = yaml.load(fileContent);
+            if (!parsed || typeof parsed !== 'object' || !('profiles' in parsed)) {
+                this.error('Credentials file has invalid format.');
+            }
+            return parsed;
+        }
+        catch (error) {
+            this.error(`Failed to parse credentials file: ${error}`);
+        }
+    }
+}

package/dist/commands/workspace/edit/index.d.ts

@@ -0,0 +1,22 @@
+import BaseCommand from '../../../base-command.js';
+export default class WorkspaceEdit extends BaseCommand {
+    static args: {
+        workspace_id: import("@oclif/core/interfaces").Arg<number | undefined, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'require-token': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        swagger: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private loadCredentials;
+}

package/dist/commands/workspace/edit/index.js

@@ -0,0 +1,176 @@
+import { Args, Flags } from '@oclif/core';
+import * as yaml from 'js-yaml';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import BaseCommand from '../../../base-command.js';
+export default class WorkspaceEdit extends BaseCommand {
+    static args = {
+        workspace_id: Args.integer({
+            description: 'Workspace ID to edit (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    static description = 'Edit an existing workspace via the Xano Metadata API';
+    static examples = [
+        `$ xano workspace edit 123 --name "new-name"
+Updated workspace: new-name (ID: 123)
+`,
+        `$ xano workspace edit --name "updated-workspace" --description "Updated description"
+Updated workspace: updated-workspace (ID: 123)
+  Description: Updated description
+`,
+        `$ xano workspace edit 123 --swagger --require-token
+Updated workspace: my-workspace (ID: 123)
+  Swagger: enabled
+  Require Token: true
+`,
+        `$ xano workspace edit 123 --no-swagger -o json
+{
+  "id": 123,
+  "name": "my-workspace",
+  "swagger": false
+}
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        description: Flags.string({
+            char: 'd',
+            description: 'New description for the workspace',
+            required: false,
+        }),
+        name: Flags.string({
+            char: 'n',
+            description: 'New name for the workspace',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        'require-token': Flags.boolean({
+            allowNo: true,
+            description: 'Whether to require a token for documentation access',
+            required: false,
+        }),
+        swagger: Flags.boolean({
+            allowNo: true,
+            description: 'Enable or disable swagger documentation',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(WorkspaceEdit);
+        // Get profile name (default or from flag/env)
+        const profileName = flags.profile || this.getDefaultProfile();
+        // Load credentials
+        const credentials = this.loadCredentials();
+        // Get the profile configuration
+        if (!(profileName in credentials.profiles)) {
+            this.error(`Profile '${profileName}' not found. Available profiles: ${Object.keys(credentials.profiles).join(', ')}\n` +
+                `Create a profile using 'xano profile create'`);
+        }
+        const profile = credentials.profiles[profileName];
+        // Validate required fields
+        if (!profile.instance_origin) {
+            this.error(`Profile '${profileName}' is missing instance_origin`);
+        }
+        if (!profile.access_token) {
+            this.error(`Profile '${profileName}' is missing access_token`);
+        }
+        // Get workspace ID from args or profile
+        const workspaceId = args.workspace_id || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Either pass a workspace ID as an argument or set one in your profile.\n' +
+                'Usage: xano workspace edit <workspace_id> [flags]');
+        }
+        // Build request body - only include fields that were specified
+        const body = {};
+        if (flags.name !== undefined) {
+            body.name = flags.name;
+        }
+        if (flags.description !== undefined) {
+            body.description = flags.description;
+        }
+        if (flags.swagger !== undefined) {
+            body.swagger = flags.swagger;
+        }
+        if (flags['require-token'] !== undefined) {
+            body.documentation = { require_token: flags['require-token'] };
+        }
+        // Check if at least one field is being updated
+        if (Object.keys(body).length === 0) {
+            this.error('No fields specified to update. Use --name, --description, --swagger, or --require-token flags.\n' +
+                'Example: xano workspace edit 123 --name "new-name"');
+        }
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}`;
+        // Update workspace via the API
+        try {
+            const response = await fetch(apiUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                    'content-type': 'application/json',
+                },
+                method: 'PUT',
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const workspace = await response.json();
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(workspace, null, 2));
+            }
+            else {
+                // summary format
+                this.log(`Updated workspace: ${workspace.name} (ID: ${workspace.id})`);
+                if (workspace.description) {
+                    this.log(`  Description: ${workspace.description}`);
+                }
+                if (workspace.swagger !== undefined) {
+                    this.log(`  Swagger: ${workspace.swagger ? 'enabled' : 'disabled'}`);
+                }
+                if (workspace.documentation?.require_token !== undefined) {
+                    this.log(`  Require Token: ${workspace.documentation.require_token}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to update workspace: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to update workspace: ${String(error)}`);
+            }
+        }
+    }
+    loadCredentials() {
+        const configDir = path.join(os.homedir(), '.xano');
+        const credentialsPath = path.join(configDir, 'credentials.yaml');
+        // Check if credentials file exists
+        if (!fs.existsSync(credentialsPath)) {
+            this.error(`Credentials file not found at ${credentialsPath}\n` +
+                `Create a profile using 'xano profile create'`);
+        }
+        // Read credentials file
+        try {
+            const fileContent = fs.readFileSync(credentialsPath, 'utf8');
+            const parsed = yaml.load(fileContent);
+            if (!parsed || typeof parsed !== 'object' || !('profiles' in parsed)) {
+                this.error('Credentials file has invalid format.');
+            }
+            return parsed;
+        }
+        catch (error) {
+            this.error(`Failed to parse credentials file: ${error}`);
+        }
+    }
+}

package/dist/commands/workspace/get/index.d.ts

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../base-command.js';
+export default class WorkspaceGet extends BaseCommand {
+    static args: {
+        workspace_id: import("@oclif/core/interfaces").Arg<number | undefined, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private loadCredentials;
+}