@xano/cli 1.0.2 → 1.0.3-beta.3

package/README.md

@@ -522,14 +522,49 @@ xano sandbox reset --force
 # List static hosts
 xano static_host list
 
-# Create a build
+# Create / get / edit a static host
+xano static_host create marketing --description "Marketing site"
+xano static_host get marketing
+xano static_host edit marketing --name marketing-v2 --description "Updated"
+
+# Create a build (name optional — auto-generated from the timestamp if omitted).
+# For package.json builds, the CLI waits for the build to finish (--no-wait to skip).
 xano static_host build create default -f ./build.zip -n "v1.0.0"
+xano static_host build create default -f ./build.zip                 # name: 20260531-143022
 
 # List builds
 xano static_host build list default
 
 # Get build details
-xano static_host build get default 52
+xano static_host build get default --build_id 52
+
+# Pull a build to disk. Defaults to the original uploaded source
+# (including package.json). Use --source built for the compiled/served output.
+xano static_host build pull default --build_id 52    # By build ID (original source)
+xano static_host build pull default --build_id 52 --source built   # Compiled output
+xano static_host build pull default --latest         # Latest build
+xano static_host build pull default --env dev        # Build currently deployed to dev
+xano static_host build pull default --env prod -d ./prod-release
+
+# Push a directory as a new build (name optional — auto-generated if omitted).
+# For package.json builds, the CLI waits for the build to finish (--no-wait to skip).
+xano static_host build push default -d ./dist -n "v1.0.0"
+xano static_host build push default                          # current dir, auto-name
+xano static_host build push default -n "release" --description "Production build"
+
+# Delete a build (prompts for confirmation; --force to skip)
+xano static_host build delete default --build_id 52
+xano static_host build delete default --build_id 52 --force
+
+# Deploy a build to an environment
+xano static_host deploy default --build_id 52 --env dev
+xano static_host deploy default --build_id 52 --env prod
+
+# Migrate a host to instance-managed (v2) hosting
+xano static_host migrate newsite                 # one host (both envs)
+xano static_host migrate newsite --env dev        # one env
+xano static_host migrate --all                    # every v1 host in the workspace
+xano static_host migrate --all --dry-run          # preview without changing anything
 ```
 
 ## Global Options

package/dist/base-command.d.ts

@@ -103,4 +103,25 @@ export default abstract class BaseCommand extends Command {
      * Use this for all Metadata API calls to support the --verbose flag.
      */
     protected verboseFetch(url: string, options: RequestInit, verbose: boolean, authToken?: string): Promise<Response>;
+    /**
+     * Poll a static-host build until it reaches a terminal status (ok | error),
+     * showing a live, ticking spinner with the current stage and elapsed time —
+     * mirroring the UI's build progress for async (package.json) builds, which
+     * keep running after the upload returns.
+     *
+     * On a TTY it renders an animated spinner via ux.action; when quiet (JSON
+     * output) or non-interactive it falls back to plain one-line status updates.
+     *
+     * Returns the final status. Resolves to the last-seen status on timeout.
+     */
+    protected waitForBuild(opts: {
+        buildId: number | string;
+        intervalMs?: number;
+        profile: ProfileConfig;
+        quiet?: boolean;
+        staticHost: string;
+        timeoutMs?: number;
+        verbose: boolean;
+        workspaceId: string;
+    }): Promise<string>;
 }

package/dist/base-command.js

@@ -1,4 +1,4 @@
-import { Command, Flags } from '@oclif/core';
+import { Command, Flags, ux } from '@oclif/core';
 import * as yaml from 'js-yaml';
 import * as fs from 'node:fs';
 import * as os from 'node:os';
@@ -314,4 +314,103 @@ export default class BaseCommand extends Command {
         }
         return response;
     }
+    /**
+     * Poll a static-host build until it reaches a terminal status (ok | error),
+     * showing a live, ticking spinner with the current stage and elapsed time —
+     * mirroring the UI's build progress for async (package.json) builds, which
+     * keep running after the upload returns.
+     *
+     * On a TTY it renders an animated spinner via ux.action; when quiet (JSON
+     * output) or non-interactive it falls back to plain one-line status updates.
+     *
+     * Returns the final status. Resolves to the last-seen status on timeout.
+     */
+    async waitForBuild(opts) {
+        const { buildId, profile, quiet, staticHost, verbose, workspaceId } = opts;
+        const intervalMs = opts.intervalMs ?? 2000;
+        const timeoutMs = opts.timeoutMs ?? 600_000; // 10 min
+        const terminal = new Set(['error', 'ok']);
+        const url = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/static_host/${staticHost}/build/${buildId}`;
+        // Spinner only on an interactive TTY and when not emitting JSON. Verbose mode
+        // also disables it (the spinner would interleave with request/response logs).
+        const animate = Boolean(process.stdout.isTTY) && !quiet && !verbose;
+        const start = Date.now();
+        const elapsed = () => Math.round((Date.now() - start) / 1000);
+        let stage = 'pending';
+        let ticker;
+        // Reflect the current stage: live spinner status on a TTY, else a plain line.
+        const render = () => {
+            if (animate) {
+                ux.action.status = `${stageLabel(stage)} (${elapsed()}s)`;
+            }
+            else if (!quiet && !terminal.has(stage)) {
+                this.log(`Build status: ${stage}`);
+            }
+        };
+        // Stop the spinner/ticker and emit a final line.
+        const conclude = (message) => {
+            if (ticker)
+                clearInterval(ticker);
+            if (animate) {
+                ux.action.stop(message);
+            }
+            else if (!quiet) {
+                this.log(message);
+            }
+        };
+        if (animate) {
+            ux.action.start('Building', stageLabel(stage));
+            // Re-render every 120ms so the elapsed counter ticks even between polls.
+            ticker = setInterval(render, 120);
+        }
+        else if (!quiet) {
+            this.log(`Build status: ${stage}`);
+        }
+        /* eslint-disable no-await-in-loop */
+        while (Date.now() - start < timeoutMs) {
+            const response = await this.verboseFetch(url, {
+                headers: { accept: 'application/json', Authorization: `Bearer ${profile.access_token}` },
+                method: 'GET',
+            }, verbose, profile.access_token);
+            if (response.ok) {
+                const build = (await response.json());
+                const status = build.status ?? 'pending';
+                if (status !== stage) {
+                    stage = status;
+                    render();
+                }
+                if (terminal.has(status)) {
+                    const took = `${elapsed()}s`;
+                    conclude(status === 'ok' ? `done in ${took}` : `failed after ${took}`);
+                    return status;
+                }
+            }
+            await new Promise((resolve) => {
+                setTimeout(resolve, intervalMs);
+            });
+        }
+        /* eslint-enable no-await-in-loop */
+        conclude(`stopped waiting after ${Math.round(timeoutMs / 1000)}s (last status: ${stage || 'unknown'})`);
+        return stage;
+    }
+}
+/** Human-friendly label for a build status stage. */
+function stageLabel(status) {
+    switch (status) {
+        case 'building': {
+            return 'Installing & building (npm)';
+        }
+        case 'ok': {
+            return 'Finishing';
+        }
+        case 'pending': {
+            return 'Queued';
+        }
+        case 'publishing': {
+            return 'Publishing files';
+        }
+        default: {
+            return status;
+        }
+    }
 }

package/dist/commands/static_host/build/create/index.d.ts

@@ -1,4 +1,10 @@
 import BaseCommand from '../../../../base-command.js';
+/**
+ * Generate a default build name from a compact timestamp: `YYYYMMDD-HHmmss`
+ * (e.g. `20260531-143022`). Sortable, distinct down to the second, and uses
+ * local time so it lines up with when the user ran the command.
+ */
+export declare function generateBuildName(date?: Date): string;
 export default class StaticHostBuildCreate extends BaseCommand {
     static args: {
         static_host: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
@@ -8,7 +14,8 @@ export default class StaticHostBuildCreate extends BaseCommand {
     static flags: {
         description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         file: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'no-wait': 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>;

package/dist/commands/static_host/build/create/index.js

@@ -2,6 +2,21 @@ import { Args, Flags } from '@oclif/core';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import BaseCommand from '../../../../base-command.js';
+const pad2 = (n) => String(n).padStart(2, '0');
+/**
+ * Generate a default build name from a compact timestamp: `YYYYMMDD-HHmmss`
+ * (e.g. `20260531-143022`). Sortable, distinct down to the second, and uses
+ * local time so it lines up with when the user ran the command.
+ */
+export function generateBuildName(date = new Date()) {
+    const y = date.getFullYear();
+    const mo = pad2(date.getMonth() + 1);
+    const d = pad2(date.getDate());
+    const h = pad2(date.getHours());
+    const mi = pad2(date.getMinutes());
+    const s = pad2(date.getSeconds());
+    return `${y}${mo}${d}-${h}${mi}${s}`;
+}
 export default class StaticHostBuildCreate extends BaseCommand {
     static args = {
         static_host: Args.string({
@@ -16,6 +31,12 @@ Build created successfully!
 ID: 123
 Name: v1.0.0
 Status: pending
+`,
+        `$ xano static_host:build:create default -f ./build.zip
+Build created successfully!
+ID: 123
+Name: 20260531-143022
+Status: pending
 `,
         `$ xano static_host:build:create default -w 40 -f ./dist.zip -n "production" -d "Production build"
 Build created successfully!
@@ -45,8 +66,13 @@ Description: Production build
         }),
         name: Flags.string({
             char: 'n',
-            description: 'Build name',
-            required: true,
+            description: 'Build name (auto-generated from the current timestamp if omitted)',
+            required: false,
+        }),
+        'no-wait': Flags.boolean({
+            default: false,
+            description: 'Return immediately after upload instead of waiting for the build to finish',
+            required: false,
         }),
         output: Flags.string({
             char: 'o',
@@ -102,7 +128,10 @@ Description: Production build
         const fileBuffer = fs.readFileSync(filePath);
         const blob = new Blob([fileBuffer], { type: 'application/zip' });
         formData.append('file', blob, path.basename(filePath));
-        formData.append('name', flags.name);
+        // Name is optional — fall back to a timestamped name so builds can be
+        // created without thinking up a label each time.
+        const buildName = flags.name ?? generateBuildName();
+        formData.append('name', buildName);
         if (flags.description) {
             formData.append('description', flags.description);
         }
@@ -141,6 +170,22 @@ Description: Production build
                     this.log(`Description: ${flags.description}`);
                 }
             }
+            // Async (package.json) builds keep running after upload. Unless --no-wait,
+            // poll until the build finishes so the CLI mirrors the UI's progress.
+            const inProgress = result.status !== undefined && !['error', 'ok'].includes(result.status);
+            if (inProgress && !flags['no-wait']) {
+                const finalStatus = await this.waitForBuild({
+                    buildId: result.id,
+                    profile,
+                    quiet: flags.output === 'json',
+                    staticHost: args.static_host,
+                    verbose: flags.verbose,
+                    workspaceId,
+                });
+                if (finalStatus === 'error') {
+                    this.error(`Build ${result.id} failed (status: error). Check the build log with: xano static_host build get ${args.static_host} --build_id ${result.id}`);
+                }
+            }
         }
         catch (error) {
             if (error instanceof Error) {

package/dist/commands/static_host/build/delete/index.d.ts

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../../base-command.js';
+export default class StaticHostBuildDelete extends BaseCommand {
+    static args: {
+        static_host: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        build_id: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        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/static_host/build/delete/index.js

@@ -0,0 +1,114 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../../base-command.js';
+export default class StaticHostBuildDelete extends BaseCommand {
+    static args = {
+        static_host: Args.string({
+            description: 'Static Host name',
+            required: true,
+        }),
+    };
+    static description = 'Delete a static host build permanently. This action cannot be undone.';
+    static examples = [
+        `$ xano static_host build delete default --build_id 52
+Are you sure you want to delete build 52 from static host 'default'? This action cannot be undone. (y/N) y
+Deleted build 52 from static host 'default'
+`,
+        `$ xano static_host build delete default --build_id 52 --force
+Deleted build 52 from static host 'default'
+`,
+        `$ xano static_host build delete myhost --build_id 123 -w 40 -f
+Deleted build 123 from static host 'myhost'
+`,
+        `$ xano static_host build delete default --build_id 52 -f -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        build_id: Flags.string({
+            description: 'Build ID to delete',
+            required: true,
+        }),
+        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 (optional if set in profile)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(StaticHostBuildDelete);
+        const { profile, profileName } = this.resolveProfile(flags);
+        // Determine workspace_id from flag or profile
+        let workspaceId;
+        if (flags.workspace) {
+            workspaceId = flags.workspace;
+        }
+        else if (profile.workspace) {
+            workspaceId = profile.workspace;
+        }
+        else {
+            this.error(`Workspace ID is required. Either:\n` +
+                `  1. Provide it as a flag: xano static_host build delete <static_host> --build_id <id> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile edit ${profileName} -w <workspace_id>`);
+        }
+        if (!flags.force) {
+            const confirmed = await this.confirm(`Are you sure you want to delete build ${flags.build_id} from static host '${args.static_host}'? This action cannot be undone.`);
+            if (!confirmed) {
+                this.log('Deletion cancelled.');
+                return;
+            }
+        }
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/static_host/${args.static_host}/build/${flags.build_id}`;
+        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({ build_id: flags.build_id, deleted: true, static_host: args.static_host }, null, 2));
+            }
+            else {
+                this.log(`Deleted build ${flags.build_id} from static host '${args.static_host}'`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to delete build: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to delete build: ${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/static_host/build/get/index.d.ts

@@ -1,12 +1,12 @@
 import BaseCommand from '../../../../base-command.js';
 export default class StaticHostBuildGet extends BaseCommand {
     static args: {
-        build_id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
         static_host: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
     static description: string;
     static examples: string[];
     static flags: {
+        build_id: import("@oclif/core/interfaces").OptionFlag<string, 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>;

package/dist/commands/static_host/build/get/index.js

@@ -2,10 +2,6 @@ import { Args, Flags } from '@oclif/core';
 import BaseCommand from '../../../../base-command.js';
 export default class StaticHostBuildGet extends BaseCommand {
     static args = {
-        build_id: Args.string({
-            description: 'Build ID',
-            required: true,
-        }),
         static_host: Args.string({
             description: 'Static Host name',
             required: true,
@@ -13,24 +9,24 @@ export default class StaticHostBuildGet extends BaseCommand {
     };
     static description = 'Get details of a specific build for a static host';
     static examples = [
-        `$ xano static_host:build:get default 52
+        `$ xano static_host:build:get default --build_id 52
 Build Details:
 ID: 52
 Name: v1.0.0
 Status: completed
 `,
-        `$ xano static_host:build:get default 52 -w 40
+        `$ xano static_host:build:get default --build_id 52 -w 40
 Build Details:
 ID: 52
 Name: v1.0.0
 Status: completed
 `,
-        `$ xano static_host:build:get myhost 123 --profile production
+        `$ xano static_host:build:get myhost --build_id 123 --profile production
 Build Details:
 ID: 123
 Name: production-build
 `,
-        `$ xano static_host:build:get default 52 -o json
+        `$ xano static_host:build:get default --build_id 52 -o json
 {
   "id": 52,
   "name": "v1.0.0",
@@ -40,6 +36,10 @@ Name: production-build
     ];
     static flags = {
         ...BaseCommand.baseFlags,
+        build_id: Flags.string({
+            description: 'Build ID',
+            required: true,
+        }),
         output: Flags.string({
             char: 'o',
             default: 'summary',
@@ -66,11 +66,11 @@ Name: production-build
         }
         else {
             this.error(`Workspace ID is required. Either:\n` +
-                `  1. Provide it as a flag: xano static_host:build:get <static_host> <build_id> -w <workspace_id>\n` +
+                `  1. Provide it as a flag: xano static_host:build:get <static_host> --build_id <id> -w <workspace_id>\n` +
                 `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
         }
         // Construct the API URL
-        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/static_host/${args.static_host}/build/${args.build_id}`;
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/static_host/${args.static_host}/build/${flags.build_id}`;
         // Fetch build from the API
         try {
             const response = await this.verboseFetch(apiUrl, {
@@ -104,6 +104,12 @@ Name: production-build
                 if (build.status) {
                     this.log(`Status: ${build.status}`);
                 }
+                if (typeof build.file_count === 'number') {
+                    this.log(`Files: ${build.file_count}`);
+                }
+                if (typeof build.file_bytes === 'number') {
+                    this.log(`Size: ${build.file_bytes} bytes`);
+                }
                 if (build.created_at) {
                     this.log(`Created: ${build.created_at}`);
                 }

package/dist/commands/static_host/build/pull/index.d.ts

@@ -0,0 +1,52 @@
+import BaseCommand from '../../../../base-command.js';
+export interface StaticHostEnv {
+    canonical?: null | string;
+}
+export interface StaticHostSummary {
+    [k: string]: unknown;
+    dev?: StaticHostEnv;
+    name: string;
+    prod?: StaticHostEnv;
+}
+export interface BuildSummary {
+    canonical?: string;
+    id: number;
+}
+/**
+ * Find the deployed `canonical` for a static host's env from a list of hosts.
+ * Returns null when the host isn't present or nothing is deployed to that env.
+ */
+export declare function extractEnvCanonical(hosts: StaticHostSummary[], staticHost: string, env: string): null | string;
+/** Find the build whose unique `canonical` matches, or null if none do. */
+export declare function findBuildByCanonical(builds: BuildSummary[], canonical: string): BuildSummary | null;
+export default class StaticHostBuildPull extends BaseCommand {
+    static args: {
+        static_host: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        build_id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        directory: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        env: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        latest: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        source: 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 parseFileDocument;
+    /**
+     * Resolve the build ID currently deployed to a static host's dev/prod env.
+     *
+     * The deployed env stores the `canonical` of the build it was created from
+     * (static_host.{env}.canonical). Each build carries that same unique
+     * `canonical`, so we match the env's canonical against the build list to
+     * recover the build ID — a shortcut for "list builds, find the deployed one,
+     * then pull it".
+     */
+    private resolveEnvBuild;
+    private resolveLatestBuild;
+}