Browse sections

Command-line interface (CLI)

Install the Inquir Compute CLI, then use it to scaffold a project, authenticate, and run, deploy, and invoke functions from your terminal.

The CLI binary is inquir, published as the npm package @inquir/compute-cli. It is workspace-first: inquir init scaffolds a project, and the same commands work locally and against any workspace you belong to.

Install

Install globally with npm. Re-running with @latest also upgrades an existing install to the newest published version:

install
# Global install (also upgrades an existing install to the latest published version)
npm install -g @inquir/compute-cli@latest

# Verify (requires Node.js 22+)
inquir --version
inquir --help

# Or run without installing
npx @inquir/compute-cli@latest --help

Requires Node.js 22+. Verify the install with inquir --version. You can also run it without installing via npx @inquir/compute-cli@latest --help. On macOS/Linux a global install may need sudo, or use a Node version manager (nvm/fnm).

Usage

A typical workflow scaffolds a project, authenticates, then runs and deploys functions:

usage
inquir init                    # Scaffold a workspace (inquir.config.json + sample function)
inquir login                   # Authenticate this device via the browser (mints a PAT)
inquir list                    # List discovered local assets
inquir list -r                 # List deployed remote functions (alias: --remote)
inquir run hello --payload '{"name":"World"}'    # Run a function locally
inquir deploy hello            # Package and deploy a function (streams build logs)
inquir invoke hello --payload '{"name":"World"}' # Invoke a deployed function
inquir logs hello              # Recent remote invocation logs
inquir workspaces              # List the workspaces you belong to
inquir use acme-prod           # Set the active workspace for subsequent commands
  • inquir init — scaffold inquir.config.json, folders, and a sample function.
  • inquir login — authenticates this device through the browser and mints a Personal Access Token.
  • inquir list lists local assets; inquir list -r (alias --remote) lists deployed remote functions.
  • inquir run <fn> --payload '{…}' — run a function locally with a JSON payload.
  • inquir deploy <fn> — package, upload, and deploy a function (streams build logs).
  • inquir invoke <fn> — invoke a deployed function remotely.
  • inquir logs — show recent remote invocation history.
  • inquir workspaces lists the workspaces you belong to; inquir use <slug> sets the active workspace for subsequent commands.

Run inquir --help (or inquir help <command>) for the full command reference and flags.