Skip to main content
Back to Documentation

Developer CLI

v1.9.23

Manage your entire business from the terminal

Developer Login
npm i -g @solidnumber/cli
80+
Commands
13
Global Flags
52
Industry Templates
26
API Key Scopes
389
CLI Tests

Quick Start

Four commands to go from zero to managing your business in the terminal.

1
Install the CLI
Terminal
npm i -g @solidnumber/cli
2
Login to your account
Terminal
solid auth login
# Email: you@company.com
# Password: ********
# Logged in to Acme Corp (ID: 42)
3
Pull your business data
Terminal
solid pull
# Pulling pages... 12 files
# Pulling KB entries... 48 files
# Pulling services... 8 files
# Saved to ./my-business/
4
Edit and push changes
Terminal
# Edit files in VS Code, Cursor, Vim, or any editor
solid push
# Changes: 2 pages updated, 1 KB entry created
# Push to Acme Corp? (y/n) y
# Pushed successfully

Global Flags

v1.9.23

Every command inherits these flags. Set via CLI or environment variable — whichever is more convenient for your shell, script, or CI pipeline.

FlagPurposeEnv Var
--dry-runPreview every mutation, no server writesSOLID_DRY_RUN=1
--jsonJSON output (cascades to every subcommand)SOLID_JSON=1
--format json|csv|tsvList output format for scripting
--sort-by <field>Sort list output by any field
--order asc|descSort direction
--output <file>Write output to file (creates parent dirs)
--token <token>One-shot auth token (never persisted)SOLID_API_KEY
--timeout <seconds>Per-request HTTP timeout (default 30s)SOLID_TIMEOUT_MS
--debugAppend method/URL/body context to every errorSOLID_DEBUG=1
--no-colorDisable ANSI colors (standard Unix convention)NO_COLOR=1
--rawPipeline-clean output — no spinner, no decoration
--no-spinnerDisable progress spinner
-V, --versionPrint CLI version
Safe by default

--dry-run intercepts every write. Audit the plan before touching production.

Pipeline-friendly

--json, --format csv, and --raw make every command pipe-ready for jq, awk, or xargs.

CI/CD ready

SOLID_API_KEY env var or --token for headless auth. Never persisted to disk.

Example — list orders as CSV, sorted by amount
solid orders list --all --format csv --sort-by amount --order desc --output orders.csv
# Fetched 1,247 orders across 13 pages
# Saved to orders.csv

Command Reference

Core Workflow

solid auth loginBrowser-based login (opens auth portal, captures token)
solid auth login --token sk_solid_...Login with API key (CI/CD, scripts)
solid auth logoutClear stored credentials
solid auth statusCheck auth state + company info
solid whoamiWho am I logged in as (alias for auth status)
solid statusFull business dashboard (contacts, website, modules)
solid status --jsonJSON output for scripting
solid healthQuick health check
solid health --fullFull 6-layer health check
solid doctorRead-only live probe — 9 backend endpoints, response times

Pull / Push Workflow

Work on your business using any editor. Pull downloads JSON and Markdown files, you edit them locally, then push deploys the changes. A manifest tracks file-to-ID mappings so the CLI knows what to create vs. update.

Pages (JSON)

CMS pages with layout, meta, and content blocks

KB (Markdown)

Knowledge base with YAML frontmatter + content

Settings (JSON)

Company info, website config, module flags

Directory structure after pull
my-business/
├── pages/                    # CMS pages
│   ├── home.json
│   ├── about.json
│   └── services.json
├── kb/                       # Knowledge base (Markdown)
│   ├── welcome.md
│   ├── services-overview.md
│   └── faq.md
├── services/                 # Service catalog (read-only)
│   └── consultation.json
├── solid.config.json         # Company info + website settings
└── .solid/
    └── manifest.json         # Sync metadata (DO NOT EDIT)
Safety guarantees

Push only creates and updates — it never deletes data remotely. Company isolation is enforced: the manifest locks to your company_id. Use --dry-run to preview before pushing.

AI Training

Train your AI agents directly from the terminal. Import docs, test conversations, and audit KB coverage.

Bulk import from Markdown files

Terminal
solid train import ./company-docs/
# Scanning directory... 24 .md files found
# Importing FAQ entries... 24/24
# Done. 24 KB entries created.

Chat with your agents to test training

Terminal
solid train chat marcus
# Connected to Marcus (Marketing Director)
# Type your message (Ctrl+C to exit)

> What campaigns are running?

Marcus: You have 3 active campaigns:
  1. Holiday Sale (email, 2,400 recipients)
  2. New Year Promo (SMS, 800 recipients)
  3. Referral Push (social, ongoing)

Coverage dashboard

Terminal
solid train status
# KB Coverage Dashboard
# ─────────────────────
# company_identity  ████████████ 12 entries
# services          ████████░░░░  8 entries
# faq               ██████████░░ 10 entries
# pricing           ████░░░░░░░░  4 entries  ⚠ Low
# policies          ██████░░░░░░  6 entries
#
# Gap: pricing needs more entries for AI accuracy

Agent Management

Your AI agents learn and improve over time. Inspect their soul (identity + config + learned patterns), review performance scores, track what they've learned, and coordinate multi-agent missions where ADA delegates tasks across your team.

Agent Soul

Each agent's identity, configuration, learned patterns, and expertise — built from every interaction

Performance Scoring

5-criteria scoring after every interaction — tracks accuracy, helpfulness, and tool usage over time

Telemetry

Real-time tokens, latency, cost, revenue attribution, and ROI tracking per agent

View an agent's soul

Terminal
solid agent soul sarah
#
#   Sarah — Agent Soul
#
#   ── Identity ────────────────
#   Name          Sarah
#   Type          customer_service
#   Autonomy      Level 4 / 5
#
#   ── Performance ─────────────
#   Accuracy       ████████████░░░  89%
#   Helpfulness    █████████████░░  92%
#   Tool Usage     ██████████░░░░░  78%
#   Resolution     ████████████░░░  85%
#
#   ── Learned Patterns ────────
#   customer empathy, refund handling, scheduling
#
#   ── 30d Stats ───────────────
#   Conversations: 1,420  |  Avg Score: 87/100

Launch a multi-agent mission

Terminal
solid agent mission "Create a Valentine's campaign for VIP customers" --execute
# ADA is planning the mission...
# Mission planned: m_8f2a3c
#
#   ── Mission Steps ───────────
#   ○ Step 1: Marcus — Query CRM for VIP segment, draft strategy
#   ○ Step 2: Maya — Design template, write copy, schedule sends
#
# Executing mission...
# ✓ Mission complete — 2 steps executed

Agent dashboard

Terminal
solid agent dashboard
#
#   Agent Dashboard
#
#   ╭─ Overview ─────────────────────╮
#   │ Total Agents:    48           │
#   │ Active Tasks:    3            │
#   │ 30d Tasks:       1,250        │
#   │ Success Rate:    98.8%        │
#   │ Avg Response:    2.4s         │
#   ╰───────────────────────────────╯
#
#   ── Telemetry ───────────────────
#   Tokens:       1,245,000
#   Est. Cost:    $12.45
#   Revenue:      $8,420.00
#   ROI:          676.5x

Multi-Company & Agency Mode

Agencies and developers with access to multiple companies can switch between them instantly. The CLI adapts: single-company users get a simple login, multi-company users get a picker.

Customer

Business owner managing their own company. Single login.

Developer

Freelancer/employee building for 1–2 clients. Invited to companies.

Agency

Manages many companies. Creates new clients, switches between them.

Agency workflow
# Create a new client company from a template
solid company create "Mike's Plumbing" --template plumber
# Company created (ID: 47) with plumber template (500+ KB entries)

# Send registration to the client — they get a branded referral email
solid company send-registration mike@mikesplumbing.com --name "Mike"
# Email sent with referral link. Mike onboards + pays on his own time.
# You get referral attribution automatically.

# Keep building while Mike sorts out payment
solid switch "Mike's Plumbing"
solid pull && code .
# Open in VS Code, edit pages/kb, then push

solid switch "Sarah's Salon"
# Switched to Sarah's Salon (ID: 22)

solid doctor

Read-only

Run before filing any bug. solid doctor hits 9 live backend endpoints against your authenticated company and reports status, HTTP code, and response time. Zero writes. Safe on production, safe in CI.

$ solid doctor
  Solid# CLI Doctor
  ────────────────────────────────────────
  ● PASS  auth          200   489ms  /api/v1/auth/me
  ● PASS  kb            200   487ms  /api/v1/kb/company
  ● PASS  pages         200   497ms  /api/v1/cms/pages
  ● PASS  sites         200   490ms  /api/v1/sites
  ● PASS  services      200   106ms  /api/v1/services/catalog
  ● PASS  orders        200   107ms  /api/v1/orders/
  ● PASS  crm contacts  200   111ms  /api/v1/crm/contacts
  ● PASS  leads         200   108ms  /api/v1/crm/leads/stats
  ● PASS  billing       200    67ms  /api/v1/billing/overview

  ✓ 9 passed  2462ms total
When to run it
  • \u2022 Before filing a support ticket (paste the output)
  • \u2022 After switching companies
  • \u2022 In CI as a smoke test (exit 1 on any failure)
  • \u2022 When "the CLI feels slow" — see exact per-endpoint latency
Exit codes
  • \u2022 0 \u2014 all probes passed
  • \u2022 1 \u2014 one or more probes failed
  • \u2022 2 \u2014 not authenticated (run solid auth login)

Smart Typo Suggestions

New in 1.9.23

When you mistype a command, the CLI ranks the nearest matches by prefix, substring, then Levenshtein distance — same UX as gh, cargo, and git.

$ solid psh
  ✗ Unknown command: psh

  Did you mean solid push?
$ solid dcotor
  ✗ Unknown command: dcotor

  Did you mean solid doctor?
$ solid comapny
  ✗ Unknown command: comapny

  Did you mean one of these?
    solid company
    solid domains
$ solid frobnicate
  ✗ Unknown command: frobnicate

  Run solid --help to see all commands.

Shell Completion

Tab-completion scripts reflect the live command tree — every new command you build as a developer shows up automatically. No stale static scripts.

bash

install
solid completion bash > \
  /etc/bash_completion.d/solid

zsh

install
solid completion zsh > \
  "${fpath[1]}/_solid"

fish

install
solid completion fish > \
  ~/.config/fish/completions/solid.fish
Auto-install

Don't know your shell path? Run solid completion install — it detects your shell, finds the right directory, and wires it up.

API Keys for CI/CD

Create scoped API keys for CI/CD pipelines, LLM agents, and automation scripts. Keys use the sk_solid_ prefix, are stored as SHA-256 hashes, and support fine-grained scopes.

Create a scoped key
solid auth token create \
  -n "GitHub Actions" \
  -s kb:read,pages:write \
  -e 90
# Key: sk_solid_abc123...
# (Shown once — save immediately.)
Use in CI (three interchangeable forms)
# 1. Env var (recommended)
export SOLID_API_KEY=sk_solid_abc123
solid push --yes

# 2. One-shot flag (never persisted)
solid push --yes --token sk_solid_abc123

# 3. Pipe (for secret managers)
cat /run/secrets/solid | solid auth login --stdin
.github/workflows/deploy.yml
name: Deploy site to Solid#
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with: { node-version: 20 }
      - run: npm i -g @solidnumber/cli
      - name: Smoke-test backend
        run: solid doctor
      - name: Push changes (dry-run on PR, real on main)
        run: solid push --yes
        env:
          SOLID_API_KEY: ${{ secrets.SOLID_API_KEY }}

Available Scopes

kb:readRead knowledge base entries
kb:writeCreate/update/delete KB entries
pages:readRead CMS pages
pages:writeCreate/update/publish pages
vibe:executeExecute vibe modifications
train:readRead training data
train:writeImport/modify training data
company:readList linked companies
company:switchSwitch active company
cms:blog:readRead blog posts
cms:blog:writeCreate/update blog posts
cms:pages:readRead CMS page content
cms:pages:writeCreate/update CMS pages
content:review:readRead content review pipeline
content:review:writeApprove/reject content reviews
rag:retrieveRAG context retrieval
agents:readList agents, view configs, get resumes
agents:writeUpdate custom instructions, personality, settings
agents:dataView reflection history and performance
agents:converseStart/continue agent conversations (full context chain)
flows:readList flows, get details, metrics
flows:writeCreate, update, activate, pause, archive flows
brand:readGet brand, CSS variables, voice context, audit
brand:writeCreate and update brand identity
widgets:readList widgets, get embed codes, metrics
widgets:writeCreate, update, activate, pause widgets

Telemetry & Privacy

The CLI sends anonymous usage events so we know which commands people actually use. No business data, no KB content, no customer info. Opt out any time.

What we collect

  • Command name (pull, push, etc.)
  • CLI version + Node version + platform
  • Anonymous machine ID (hash, not reversible)
  • Success / failure + error class (no stack traces)

What we NEVER collect

  • \u2717 KB entries, pages, or any business data
  • \u2717 Customer info, contacts, orders
  • \u2717 Auth tokens, API keys, passwords
  • \u2717 File paths, directory contents, env vars
Opt out
# One-off (this shell)
export SOLID_NO_TELEMETRY=1

# Permanent (add to ~/.zshrc or ~/.bashrc)
echo 'export SOLID_NO_TELEMETRY=1' >> ~/.zshrc

Configuration

Credentials and preferences live in ~/.solid/. You can override any setting via environment variable — env vars take precedence over the config file.

~/.solid/
~/.solid/
├── config.json           # active company, base URL, token
├── identity.json         # anonymous machine ID for telemetry
└── cli_history.json      # recent commands (for solid feedback context)
Environment overrides
SOLID_API_URL — backend base URL
SOLID_API_KEY — auth token
SOLID_TIMEOUT_MS — HTTP timeout
SOLID_NO_TELEMETRY — opt out
SOLID_SKIP_WELCOME — suppress first-run banner
Resolution order
  1. 1. CLI flag (--token)
  2. 2. Environment variable (SOLID_API_KEY)
  3. 3. Config file (~/.solid/config.json)
  4. 4. Interactive prompt (if TTY)

52 Industry Templates

Clone a pre-built template to bootstrap a new company with 500+ KB entries, services, FAQs, and industry-specific AI training.

Terminal
solid company create "Mike's Plumbing" --template plumber
# Creating company... done
# Applying plumber template:
#   ✓ 500+ KB entries (services, FAQ, pricing, policies)
#   ✓ Service catalog (leak repair, water heater, drain...)
#   ✓ AI agent training (plumbing terminology, pricing rules)
# Company ready at ID: 47
Home Services
plumberhvacelectricianpainterlandscaperrooferpest-controlcleaning
Health & Wellness
salonbarbershopspadentistchiropractorveterinarianpharmacyfitness
Professional Services
accountinglaw-firmconsultingreal-estateinsurancefinancial-advisor
Food & Hospitality
restaurantbakerycateringfood-truckcoffee-shopbar
Retail & E-Commerce
retail-storeboutiquejewelryauto-partspet-storeflorist
Automotive
auto-repairauto-dealercar-washtowingtire-shop
Construction & Trades
general-contractorcarpentryconcretedemolitionfencingwelding
Technology
it-servicesweb-agencysaasapp-developer

MCP Editor Integration

The Solid# MCP Server gives AI editors (Claude Code, Cursor, VS Code Copilot) direct access to 608 tools across 14 servers. Your AI assistant can query customers, update inventory, send emails, and manage your business — all from your editor.

stdio (local development)

Claude Code / Cursor
npx solid-mcp --stdio

HTTP (cloud / production)

Remote MCP endpoint
https://api.solidnumber.com/mcp/v1
What can your AI editor do?

With MCP connected, ask your AI: “Show customers who spent over $1000 this month”, “Create a calendar event for tomorrow at 10am”, “Search the knowledge base for return policies”, or “Check Google Workspace connection status”. The AI uses MCP tools to execute real actions on your business.

Integrations

Full lifecycle management for third-party integrations: browse the catalog, create, validate, test, deploy, and rollback — all from the CLI.

Integration lifecycle
solid integrations catalog           # Browse available integrations
solid integrations generate          # Scaffold a new integration
solid integrations test <id>         # Run integration tests
solid integrations deploy <id>       # Deploy to production
solid integrations health            # Check all integration health
solid integrations logs <id>         # View integration logs

Open-Core Model

Free & Open

  • CLI binary & all commands
  • Pull / Push file workflow
  • SDK libraries (JS, Python, Ruby, PHP, Java, Go, .NET)
  • Public REST API
  • MCP Server (stdio & HTTP)
  • Industry templates (52)

Platform (Subscription)

  • SmartRouter (multi-model AI routing)
  • CognitiveLimiter (AI cost control)
  • AI agents (24/7 autonomous)
  • 608 MCP tools across 14 servers
  • Vibe modifications (natural language)
  • Multi-tenant orchestration
  • Agent soul, performance scoring, and persistent memory
  • Multi-agent missions (ADA coordinates)

Start Building

v1.9.23 on npm

Install the CLI, pull your business data, and start shipping from the terminal.

npm: @solidnumber/cliLicense: BSL-1.1GitHub \u2192npm \u2192
SolidNumber — AI That Answers Calls, Books Jobs & Runs Your Business