@xano/cli 1.0.5 → 1.0.6-beta.0

package/README.md

@@ -564,6 +564,38 @@ xano tenant cluster license set <cluster_id>
 xano tenant cluster license set <cluster_id> --file ./kubeconfig.yaml
 ```
 
+### Ephemeral Tenants
+
+Manage ephemeral tenants — short-lived, auto-expiring tenants scoped to a workspace (default TTL 1h, max 72h). Unlike a sandbox, an ephemeral tenant requires a workspace.
+
+```bash
+# List ephemeral tenants in the current workspace
+xano ephemeral list
+xano ephemeral list -w 5
+
+# List ephemeral tenants across every workspace you can access
+xano ephemeral list --global
+
+# Create an ephemeral tenant (workspace required)
+xano ephemeral create "PR preview"
+xano ephemeral create "Demo" --expires-hours 24 -w 5
+xano ephemeral create "Load test" -d "48h soak" --expires-hours 48
+
+# Get / edit / delete
+xano ephemeral get <tenant_name>
+xano ephemeral edit <tenant_name> --display "New Name" -d "New description"
+xano ephemeral delete <tenant_name> --force
+
+# Pull to / push from local files (multidoc)
+xano ephemeral pull -t <tenant_name> -d ./my-ephemeral
+xano ephemeral push -t <tenant_name> -d ./my-ephemeral --dry-run   # preview first
+xano ephemeral push -t <tenant_name> -d ./my-ephemeral
+
+# Open in the browser (or print the URL)
+xano ephemeral impersonate <tenant_name>
+xano ephemeral impersonate <tenant_name> --url-only
+```
+
 ### Sandbox
 
 Manage your sandbox tenant. Each user has a single sandbox tenant that is auto-provisioned on first use.

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

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralCreate extends BaseCommand {
+    static args: {
+        display: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'expires-hours': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: 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>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,103 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralCreate extends BaseCommand {
+    static args = {
+        display: Args.string({
+            description: 'Display name for the ephemeral tenant',
+            required: true,
+        }),
+    };
+    static description = 'Create a new ephemeral (short-lived, auto-expiring) tenant in a workspace';
+    static examples = [
+        `$ xano ephemeral create "PR preview"
+Created ephemeral tenant: PR preview (e4f2-9ab1-...) - ID: 42
+  Expires: in 1 hour
+`,
+        `$ xano ephemeral create "Demo" --expires-hours 24 -w 114`,
+        `$ xano ephemeral create "Load test" --description "48h soak" --expires-hours 48 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        description: Flags.string({
+            char: 'd',
+            description: 'Ephemeral tenant description',
+            required: false,
+        }),
+        'expires-hours': Flags.integer({
+            default: 1,
+            description: 'Hours until the tenant auto-expires (1-72)',
+            max: 72,
+            min: 1,
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralCreate);
+        const { profile } = this.resolveProfile(flags);
+        // Ephemeral tenants REQUIRE a workspace (unlike sandbox, which is workspace-agnostic).
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Ephemeral tenants require a workspace — use --workspace or set one in your profile.');
+        }
+        const body = {
+            display: args.display,
+            expires_hours: flags['expires-hours'],
+            tag: [],
+        };
+        if (flags.description)
+            body.description = flags.description;
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/ephemeral`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                    'Content-Type': 'application/json',
+                },
+                method: 'POST',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const tenant = (await response.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(tenant, null, 2));
+            }
+            else {
+                this.log(`Created ephemeral tenant: ${tenant.display || tenant.name} (${tenant.name}) - ID: ${tenant.id}`);
+                if (tenant.state) {
+                    this.log(`  State: ${tenant.state}`);
+                }
+                if (tenant.ephemeral_expires_at) {
+                    // The API serializes the timestamp field as a date string
+                    // ("2026-07-24 19:49:15+0000"); tolerate a raw unix-epoch number too.
+                    const raw = tenant.ephemeral_expires_at;
+                    const expiresMs = typeof raw === 'number' ? raw * 1000 : Date.parse(String(raw).replace(' ', 'T'));
+                    this.log(`  Expires: ${Number.isNaN(expiresMs) ? String(raw) : new Date(expiresMs).toISOString()}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to create ephemeral tenant: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to create ephemeral tenant: ${String(error)}`);
+            }
+        }
+    }
+}

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

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralDelete extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    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>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: 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>;
+    };
+    run(): Promise<void>;
+    private confirm;
+}

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

@@ -0,0 +1,99 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralDelete extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name to delete',
+            required: true,
+        }),
+    };
+    static description = 'Delete an ephemeral tenant permanently. This destroys all associated infrastructure and cannot be undone.';
+    static examples = [
+        `$ xano ephemeral delete e4f2-9ab1-xyz1
+Are you sure you want to delete tenant e4f2-9ab1-xyz1? This action cannot be undone. (y/N) y
+Deleted tenant e4f2-9ab1-xyz1
+`,
+        `$ xano ephemeral delete e4f2-9ab1-xyz1 --force
+Deleted tenant e4f2-9ab1-xyz1
+`,
+        `$ xano ephemeral delete e4f2-9ab1-xyz1 -f -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        force: Flags.boolean({
+            char: 'f',
+            default: false,
+            description: '[CRITICAL] NEVER run without explicit user confirmation. Skips the confirmation prompt.',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralDelete);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const tenantName = args.tenant_name;
+        if (!flags.force) {
+            const confirmed = await this.confirm(`Are you sure you want to delete tenant ${tenantName}? This action cannot be undone.`);
+            if (!confirmed) {
+                this.log('Deletion cancelled.');
+                return;
+            }
+        }
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'DELETE',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            if (flags.output === 'json') {
+                this.log(JSON.stringify({ deleted: true, tenant_name: tenantName }, null, 2));
+            }
+            else {
+                this.log(`Deleted tenant ${tenantName}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to delete ephemeral tenant: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to delete ephemeral tenant: ${String(error)}`);
+            }
+        }
+    }
+    async confirm(message) {
+        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');
+            });
+        });
+    }
+}

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

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralEdit extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        display: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: 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>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,109 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralEdit extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name to edit',
+            required: true,
+        }),
+    };
+    static description = 'Edit an existing ephemeral tenant';
+    static examples = [
+        `$ xano ephemeral edit e4f2-9ab1-xyz1 --display "New Name" --description "Updated description"
+Updated tenant: New Name (e4f2-9ab1-xyz1) - ID: 42
+`,
+        `$ xano ephemeral edit e4f2-9ab1-xyz1 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        description: Flags.string({
+            char: 'd',
+            description: 'New description',
+            required: false,
+        }),
+        display: Flags.string({
+            description: 'New display name',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralEdit);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const tenantName = args.tenant_name;
+        const baseUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}`;
+        const headers = {
+            'accept': 'application/json',
+            'Authorization': `Bearer ${profile.access_token}`,
+            'Content-Type': 'application/json',
+        };
+        try {
+            // Fetch current tenant state (PUT requires all fields)
+            const getResponse = await this.verboseFetch(baseUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!getResponse.ok) {
+                const errorText = await getResponse.text();
+                this.error(`Failed to fetch tenant: ${getResponse.status} ${getResponse.statusText}\n${errorText}`);
+            }
+            const current = await getResponse.json();
+            // Merge in user-provided values
+            const body = {
+                description: flags.description !== undefined ? flags.description : (current.description ?? ''),
+                display: flags.display !== undefined ? flags.display : (current.display ?? current.name),
+                domain: current.domain ?? '',
+                ingress: current.ingress ?? false,
+                proxy: current.proxy ?? '',
+                rbac: {
+                    enabled: current.rbac?.enabled ?? false,
+                },
+                tag: current.tag ?? [],
+                tasks: current.tasks ?? false,
+            };
+            // Update tenant
+            const putResponse = await this.verboseFetch(baseUrl, {
+                body: JSON.stringify(body),
+                headers,
+                method: 'PUT',
+            }, flags.verbose, profile.access_token);
+            if (!putResponse.ok) {
+                const errorText = await putResponse.text();
+                this.error(`API request failed with status ${putResponse.status}: ${putResponse.statusText}\n${errorText}`);
+            }
+            const tenant = await putResponse.json();
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(tenant, null, 2));
+            }
+            else {
+                this.log(`Updated tenant: ${tenant.display || tenant.name} (${tenant.name}) - ID: ${tenant.id}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to edit ephemeral tenant: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to edit ephemeral tenant: ${String(error)}`);
+            }
+        }
+    }
+}

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

@@ -0,0 +1,21 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralGet extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: 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>;
+    };
+    run(): Promise<void>;
+    /**
+     * Render a unix-epoch-seconds expiration as a human-readable "in Xh Ym" string,
+     * falling back to an ISO timestamp if the value has already passed or is absent.
+     */
+    private formatExpiration;
+}

package/dist/commands/ephemeral/get/index.js

@@ -0,0 +1,125 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralGet extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name to retrieve',
+            required: true,
+        }),
+    };
+    static description = 'Get details of a specific ephemeral tenant';
+    static examples = [
+        `$ xano ephemeral get e4f2-9ab1-xyz1
+Tenant: PR preview (e4f2-9ab1-xyz1)
+  State: ok
+  License: tier1
+  Expires: in 1h 0m
+`,
+        `$ xano ephemeral get e4f2-9ab1-xyz1 -w 5 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralGet);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const tenantName = args.tenant_name;
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const tenant = (await response.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(tenant, null, 2));
+            }
+            else {
+                this.log(`Tenant: ${tenant.display || tenant.name} (${tenant.name})`);
+                if (tenant.state)
+                    this.log(`  State: ${tenant.state}`);
+                if (tenant.license)
+                    this.log(`  License: ${tenant.license}`);
+                if (tenant.xano_domain)
+                    this.log(`  Domain: ${tenant.xano_domain}`);
+                if (tenant.domain)
+                    this.log(`  Custom Domain: ${tenant.domain}`);
+                if (tenant.cluster?.name)
+                    this.log(`  Cluster: ${tenant.cluster.name}`);
+                const releaseName = typeof tenant.release === 'string' ? tenant.release : tenant.release?.name;
+                const releaseId = typeof tenant.release === 'object' ? tenant.release?.id : undefined;
+                if (releaseName)
+                    this.log(`  Release: ${releaseName} (ID: ${releaseId})`);
+                if (tenant.platform?.name)
+                    this.log(`  Platform: ${tenant.platform.name}`);
+                if (tenant.version !== undefined)
+                    this.log(`  Version: ${tenant.version}`);
+                if (tenant.tasks !== undefined)
+                    this.log(`  Tasks: ${tenant.tasks}`);
+                if (tenant.ingress !== undefined)
+                    this.log(`  Ingress: ${tenant.ingress}`);
+                if (tenant.type)
+                    this.log(`  Type: ${tenant.type}`);
+                this.log(`  Expires: ${this.formatExpiration(tenant.ephemeral_expires_at)}`);
+                if (tenant.deployed_at) {
+                    const d = new Date(tenant.deployed_at);
+                    const deployedDate = Number.isNaN(d.getTime()) ? tenant.deployed_at : d.toISOString().split('T')[0];
+                    this.log(`  Deployed: ${deployedDate}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to get ephemeral tenant: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to get ephemeral tenant: ${String(error)}`);
+            }
+        }
+    }
+    /**
+     * Render a unix-epoch-seconds expiration as a human-readable "in Xh Ym" string,
+     * falling back to an ISO timestamp if the value has already passed or is absent.
+     */
+    formatExpiration(expiresAt) {
+        if (!expiresAt) {
+            return '-';
+        }
+        // The API serializes the timestamp field as a date string
+        // ("2026-07-24 19:49:15+0000"); tolerate a raw unix-epoch number too.
+        const expiresMs = typeof expiresAt === 'number' ? expiresAt * 1000 : Date.parse(String(expiresAt).replace(' ', 'T'));
+        if (Number.isNaN(expiresMs)) {
+            return String(expiresAt);
+        }
+        const diffSeconds = (expiresMs - Date.now()) / 1000;
+        if (diffSeconds <= 0) {
+            return `${new Date(expiresMs).toISOString()} (expired)`;
+        }
+        const hours = Math.floor(diffSeconds / 3600);
+        const minutes = Math.floor((diffSeconds % 3600) / 60);
+        return `in ${hours}h ${minutes}m`;
+    }
+}

package/dist/commands/ephemeral/impersonate/index.d.ts

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralImpersonate extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'url-only': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: 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>;
+    };
+    run(): Promise<void>;
+    private getImpersonateResponse;
+    private getFrontendUrl;
+}