@xano/cli 0.0.2

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

@@ -0,0 +1,279 @@
+import { Args, Flags } from '@oclif/core';
+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 inquirer from 'inquirer';
+import BaseCommand from '../../../base-command.js';
+export default class FunctionGet extends BaseCommand {
+    static args = {
+        function_id: Args.string({
+            description: 'Function ID',
+            required: false,
+        }),
+    };
+    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', 'xs'],
+        }),
+        include_draft: Flags.boolean({
+            description: 'Include draft version',
+            required: false,
+            default: false,
+        }),
+        include_xanoscript: Flags.boolean({
+            description: 'Include XanoScript in response',
+            required: false,
+            default: false,
+        }),
+    };
+    static description = 'Get a specific function from a workspace';
+    static examples = [
+        `$ xano function:get 145 -w 40
+Function: yo (ID: 145)
+Created: 2025-10-10 10:30:00
+Description: Sample function
+`,
+        `$ xano function:get 145 --profile production
+Function: yo (ID: 145)
+Created: 2025-10-10 10:30:00
+`,
+        `$ xano function:get
+Select a function:
+  ❯ yo (ID: 145) - Sample function
+    another-func (ID: 146)
+`,
+        `$ xano function:get 145 -w 40 --output json
+{
+  "id": 145,
+  "name": "yo",
+  "description": "Sample function"
+}
+`,
+        `$ xano function:get 145 -p staging -o json --include_draft
+{
+  "id": 145,
+  "name": "yo"
+}
+`,
+        `$ xano function:get 145 -p staging -o xs
+function yo {
+  input {
+  }
+  stack {
+  }
+  response = null
+}
+`,
+    ];
+    async run() {
+        const { args, flags } = await this.parse(FunctionGet);
+        // 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`);
+        }
+        // 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 function:get [function_id] -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+        }
+        // If function_id is not provided, prompt user to select from list
+        let functionId;
+        if (args.function_id) {
+            functionId = args.function_id;
+        }
+        else {
+            functionId = await this.promptForFunctionId(profile, workspaceId);
+        }
+        // Build query parameters
+        // Automatically set include_xanoscript to true if output format is xs
+        const includeXanoscript = flags.output === 'xs' ? true : flags.include_xanoscript;
+        const queryParams = new URLSearchParams({
+            include_draft: flags.include_draft.toString(),
+            include_xanoscript: includeXanoscript.toString(),
+        });
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/function/${functionId}?${queryParams.toString()}`;
+        // Fetch function from the API
+        try {
+            const response = await fetch(apiUrl, {
+                method: 'GET',
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${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 func = await response.json();
+            // Validate response is an object
+            if (!func || typeof func !== 'object') {
+                this.error('Unexpected API response format: expected a function object');
+            }
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(func, null, 2));
+            }
+            else if (flags.output === 'xs') {
+                // xs (XanoScript) format - output only the xanoscript element
+                if (func.xanoscript) {
+                    // If status is "ok", output only the value, otherwise output the full xanoscript object
+                    if (func.xanoscript.status === 'ok' && func.xanoscript.value !== undefined) {
+                        this.log(func.xanoscript.value);
+                    }
+                    else {
+                        this.log(JSON.stringify(func.xanoscript, null, 2));
+                    }
+                }
+                else {
+                    this.log('null');
+                }
+            }
+            else {
+                // summary format
+                this.log(`Function: ${func.name} (ID: ${func.id})`);
+                if (func.created_at) {
+                    this.log(`Created: ${func.created_at}`);
+                }
+                if (func.description) {
+                    this.log(`Description: ${func.description}`);
+                }
+                if (func.type) {
+                    this.log(`Type: ${func.type}`);
+                }
+                // Don't display xanoscript in summary mode as it can be very large
+                if (func.xanoscript) {
+                    this.log(`XanoScript: (available with -o xs or -o json)`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to fetch function: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch function: ${String(error)}`);
+            }
+        }
+    }
+    async promptForFunctionId(profile, workspaceId) {
+        try {
+            // Fetch list of functions
+            const queryParams = new URLSearchParams({
+                include_draft: 'false',
+                include_xanoscript: 'false',
+                page: '1',
+                per_page: '50',
+                sort: 'created_at',
+                order: 'desc',
+            });
+            const listUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/function?${queryParams.toString()}`;
+            const response = await fetch(listUrl, {
+                method: 'GET',
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`Failed to fetch function list: ${response.status} ${response.statusText}\n${errorText}`);
+            }
+            const data = await response.json();
+            // Handle different response formats
+            let functions;
+            if (Array.isArray(data)) {
+                functions = data;
+            }
+            else if (data && typeof data === 'object' && 'functions' in data && Array.isArray(data.functions)) {
+                functions = data.functions;
+            }
+            else if (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)) {
+                functions = data.items;
+            }
+            else {
+                this.error('Unexpected API response format');
+            }
+            if (functions.length === 0) {
+                this.error('No functions found in workspace');
+            }
+            // Create choices for inquirer
+            const choices = functions.map(func => ({
+                name: `${func.name} (ID: ${func.id})${func.description ? ` - ${func.description}` : ''}`,
+                value: func.id.toString(),
+            }));
+            // Prompt user to select a function
+            const answer = await inquirer.prompt([
+                {
+                    type: 'list',
+                    name: 'functionId',
+                    message: 'Select a function:',
+                    choices,
+                },
+            ]);
+            return answer.functionId;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to prompt for function: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to prompt for function: ${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/function/list/index.d.ts

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../base-command.js';
+export default class FunctionList extends BaseCommand {
+    static args: {};
+    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>;
+        include_draft: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        include_xanoscript: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        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>;
+        sort: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        order: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+    private loadCredentials;
+}

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

@@ -0,0 +1,208 @@
+import { Flags } from '@oclif/core';
+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 FunctionList 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'],
+        }),
+        include_draft: Flags.boolean({
+            description: 'Include draft functions',
+            required: false,
+            default: false,
+        }),
+        include_xanoscript: Flags.boolean({
+            description: 'Include XanoScript in response',
+            required: false,
+            default: false,
+        }),
+        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,
+        }),
+        sort: Flags.string({
+            description: 'Sort field',
+            required: false,
+            default: 'created_at',
+        }),
+        order: Flags.string({
+            description: 'Sort order',
+            required: false,
+            default: 'desc',
+            options: ['asc', 'desc'],
+        }),
+    };
+    static description = 'List all functions in a workspace from the Xano Metadata API';
+    static examples = [
+        `$ xano function:list -w 40
+Available functions:
+  - function-1 (ID: 1)
+  - function-2 (ID: 2)
+  - function-3 (ID: 3)
+`,
+        `$ xano function:list --profile production
+Available functions:
+  - my-function (ID: 1)
+  - another-function (ID: 2)
+`,
+        `$ xano function:list -w 40 --output json
+[
+  {
+    "id": 1,
+    "name": "function-1"
+  }
+]
+`,
+        `$ xano function:list -p staging -o json --include_draft
+[
+  {
+    "id": 1,
+    "name": "function-1"
+  }
+]
+`,
+    ];
+    async run() {
+        const { flags } = await this.parse(FunctionList);
+        // 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`);
+        }
+        // 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 function:list -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+        }
+        // Build query parameters
+        const queryParams = new URLSearchParams({
+            include_draft: flags.include_draft.toString(),
+            include_xanoscript: flags.include_xanoscript.toString(),
+            page: flags.page.toString(),
+            per_page: flags.per_page.toString(),
+            sort: flags.sort,
+            order: flags.order,
+        });
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/function?${queryParams.toString()}`;
+        // Fetch functions from the API
+        try {
+            const response = await fetch(apiUrl, {
+                method: 'GET',
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${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 data = await response.json();
+            // Handle different response formats
+            let functions;
+            if (Array.isArray(data)) {
+                functions = data;
+            }
+            else if (data && typeof data === 'object' && 'functions' in data && Array.isArray(data.functions)) {
+                functions = data.functions;
+            }
+            else if (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)) {
+                functions = data.items;
+            }
+            else {
+                this.error('Unexpected API response format');
+            }
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(functions, null, 2));
+            }
+            else {
+                // summary format
+                if (functions.length === 0) {
+                    this.log('No functions found');
+                }
+                else {
+                    this.log('Available functions:');
+                    for (const func of functions) {
+                        if (func.id !== undefined) {
+                            this.log(`  - ${func.name} (ID: ${func.id})`);
+                        }
+                        else {
+                            this.log(`  - ${func.name}`);
+                        }
+                    }
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to fetch functions: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch functions: ${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/profile/create/index.d.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+export default class ProfileCreate extends Command {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        account_origin: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        instance_origin: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        access_token: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        branch: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        default: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,123 @@
+import { Args, Command, Flags } from '@oclif/core';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import * as yaml from 'js-yaml';
+export default class ProfileCreate extends Command {
+    static args = {
+        name: Args.string({
+            description: 'Profile name',
+            required: true,
+        }),
+    };
+    static flags = {
+        account_origin: Flags.string({
+            char: 'a',
+            description: 'Account origin URL. Optional for self hosted installs.',
+            required: false,
+        }),
+        instance_origin: Flags.string({
+            char: 'i',
+            description: 'Instance origin URL',
+            required: true,
+        }),
+        access_token: Flags.string({
+            char: 't',
+            description: 'Access token for the Xano Metadata API',
+            required: true,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace name',
+            required: false,
+        }),
+        branch: Flags.string({
+            char: 'b',
+            description: 'Branch name',
+            required: false,
+        }),
+        default: Flags.boolean({
+            description: 'Set this profile as the default',
+            required: false,
+            default: false,
+        }),
+    };
+    static description = 'Create a new profile configuration';
+    static examples = [
+        `$ xano profile:create production --account_origin https://account.xano.com --instance_origin https://instance.xano.com --access_token token123
+Profile 'production' created successfully at ~/.xano/credentials.yaml
+`,
+        `$ xano profile:create staging -a https://staging-account.xano.com -i https://staging-instance.xano.com -t token456
+Profile 'staging' created successfully at ~/.xano/credentials.yaml
+`,
+        `$ xano profile:create dev -i https://dev-instance.xano.com -t token789 -w my-workspace -b feature-branch
+Profile 'dev' created successfully at ~/.xano/credentials.yaml
+`,
+        `$ xano profile:create production --account_origin https://account.xano.com --instance_origin https://instance.xano.com --access_token token123 --default
+Profile 'production' created successfully at ~/.xano/credentials.yaml
+Default profile set to 'production'
+`,
+    ];
+    async run() {
+        const { args, flags } = await this.parse(ProfileCreate);
+        const configDir = path.join(os.homedir(), '.xano');
+        const credentialsPath = path.join(configDir, 'credentials.yaml');
+        // Ensure the .xano directory exists
+        if (!fs.existsSync(configDir)) {
+            fs.mkdirSync(configDir, { recursive: true });
+            this.log(`Created directory: ${configDir}`);
+        }
+        // Read existing credentials file or create new structure
+        let credentials = { profiles: {} };
+        if (fs.existsSync(credentialsPath)) {
+            try {
+                const fileContent = fs.readFileSync(credentialsPath, 'utf8');
+                const parsed = yaml.load(fileContent);
+                if (parsed && typeof parsed === 'object' && 'profiles' in parsed) {
+                    credentials = parsed;
+                }
+                else {
+                    this.warn('Existing credentials file has invalid format. Creating new structure.');
+                }
+            }
+            catch (error) {
+                this.warn(`Failed to parse existing credentials file: ${error}`);
+                this.warn('Creating new credentials file.');
+            }
+        }
+        // Add or update the profile
+        const profileExists = args.name in credentials.profiles;
+        credentials.profiles[args.name] = {
+            account_origin: flags.account_origin ?? '',
+            instance_origin: flags.instance_origin,
+            access_token: flags.access_token,
+            ...(flags.workspace && { workspace: flags.workspace }),
+            ...(flags.branch && { branch: flags.branch }),
+        };
+        // Set default if flag is provided
+        if (flags.default) {
+            credentials.default = args.name;
+        }
+        // Write the updated credentials back to the file
+        try {
+            const yamlContent = yaml.dump(credentials, {
+                indent: 2,
+                lineWidth: -1,
+                noRefs: true,
+            });
+            fs.writeFileSync(credentialsPath, yamlContent, 'utf8');
+            if (profileExists) {
+                this.log(`Profile '${args.name}' updated successfully at ${credentialsPath}`);
+            }
+            else {
+                this.log(`Profile '${args.name}' created successfully at ${credentialsPath}`);
+            }
+            if (flags.default) {
+                this.log(`Default profile set to '${args.name}'`);
+            }
+        }
+        catch (error) {
+            this.error(`Failed to write credentials file: ${error}`);
+        }
+    }
+}

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

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+export default class ProfileDelete extends Command {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+    private confirm;
+    private promptInput;
+}