Xano CLI

Command-line interface for the Xano Metadata API.

Installation

npm install -g @xano/cli

Quick Start

1. Create a profile with the wizard:

   xano profile:wizard

2. List your workspaces:

   xano workspace:list

3. Run an ephemeral job:

   xano ephemeral:run:job -f script.xs

Commands

Profile Management

Profiles store your Xano credentials and default workspace settings.

# Create a profile interactively
xano profile:wizard

# Create a profile manually
xano profile:create myprofile -i https://instance.xano.com -t <access_token>

# List profiles
xano profile:list
xano profile:list --details

# Set default profile
xano profile:set-default myprofile

# Edit a profile
xano profile:edit myprofile -w 123  # Set default workspace

# Delete a profile
xano profile:delete myprofile

Workspaces

# List all workspaces
xano workspace:list
xano workspace:list -o json

Functions

# List functions in a workspace
xano function:list -w 40
xano function:list -o json

# Get a specific function
xano function:get 145
xano function:get 145 -o xs  # Output as XanoScript

# Create a function from XanoScript
xano function:create -f function.xs
cat function.xs | xano function:create --stdin

# Edit a function
xano function:edit 145           # Opens in $EDITOR
xano function:edit 145 -f new.xs # Update from file
xano function:edit 145 --publish # Publish after editing

Ephemeral Jobs & Services

Run XanoScript code without creating permanent resources.

# Run a job (executes and returns result)
xano ephemeral:run:job -f script.xs
xano ephemeral:run:job -f script.xs -a args.json  # With input arguments
xano ephemeral:run:job -f script.xs --edit        # Edit in $EDITOR first

# Run a service (starts API endpoints)
xano ephemeral:run:service -f service.xs

Static Hosts

# List static hosts
xano static_host:list

# Create a build
xano static_host:build:create default -f ./build.zip -n "v1.0.0"

# List builds
xano static_host:build:list default

# Get build details
xano static_host:build:get default 52

Global Options

All commands support these options:

| Flag | Description | |------|-------------| | -p, --profile | Profile to use (or set XANO_PROFILE env var) | | -w, --workspace | Workspace ID (overrides profile default) | | -o, --output | Output format: summary (default) or json |

Configuration

Profiles are stored in ~/.xano/credentials.yaml.

Help

xano --help
xano <command> --help