Overview

The spideriq CLI runs SpiderPublish from your terminal — ideal for scripting, CI, and command-line workflows. It's a client of the same API as the dashboard, with the same safety model.

Install

npm install -g @spideriq/cli --registry https://npm.spideriq.ai
# or run on demand:
npx @spideriq/cli@latest --help

Authentication

Request access — this emails your workspace admin to approve:

spideriq auth request --email you@yourcompany.com

Other auth commands:

  • spideriq auth status <request-id> --poll-token <token> --wait — poll a pending request until it's approved.

  • spideriq auth login --token <spideriq_pat_…> — sign in with an existing token.

  • spideriq auth whoami — show who you're signed in as.

  • spideriq auth logout — remove stored credentials.

See Authentication for the full flow and token format.

Bind a workspace and project

Bind a directory to your workspace so every command targets the right site. This writes a spideriq.json the CLI reads on every call:

spideriq use                       # list workspaces you can access
spideriq use mycompany             # bind this directory to a workspace
spideriq use mycompany --project proj_abc123   # also bind a specific site

Manage the sites (projects) inside a workspace:

spideriq projects list
spideriq projects create "Marketing site" --slug marketing
spideriq projects use proj_abc123

Command groups

  • spideriq auth — sign in and manage tokens.

  • spideriq use / spideriq projects — bind to a workspace / manage sites.

  • spideriq content — pages, posts, docs, settings, deploy, audit. See Content Commands.

  • spideriq templates — Liquid templates and themes. See Design & Form Commands.

  • spideriq form — build, publish, and embed forms. See Design & Form Commands.

  • spideriq config — manage workspace configs (list, add, use, show, get).

  • spideriq system — health, queues.

Common flags

Most commands accept:

  • --workspace <name> — which stored credentials to use (default default).

  • --api-url <url> — point at a different environment.

  • --format <json|yaml|md> — output format on read commands.

  • --json — machine-readable output (deploy / audit).

Destructive commands add the safe-flow flags:

  • --dry-run — preview and receive a confirm_token without changing anything.

  • --confirm <token> — apply a previously previewed change.

  • --yolo — skip the preview (deploy only; not recommended).

Example session

spideriq auth request --email you@company.com     # approve via email
spideriq use mycompany                            # bind the directory
spideriq content pages                            # list pages
spideriq content deploy                           # interactive preview → confirm

Next steps