Developer CLI
v1.9.23Manage your entire business from the terminal
npm i -g @solidnumber/cliQuick Start
Four commands to go from zero to managing your business in the terminal.
npm i -g @solidnumber/clisolid auth login
# Email: you@company.com
# Password: ********
# Logged in to Acme Corp (ID: 42)solid pull
# Pulling pages... 12 files
# Pulling KB entries... 48 files
# Pulling services... 8 files
# Saved to ./my-business/# 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 successfullyGlobal Flags
v1.9.23Every command inherits these flags. Set via CLI or environment variable — whichever is more convenient for your shell, script, or CI pipeline.
| Flag | Purpose | Env Var |
|---|---|---|
--dry-run | Preview every mutation, no server writes | SOLID_DRY_RUN=1 |
--json | JSON output (cascades to every subcommand) | SOLID_JSON=1 |
--format json|csv|tsv | List output format for scripting | — |
--sort-by <field> | Sort list output by any field | — |
--order asc|desc | Sort 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 |
--debug | Append method/URL/body context to every error | SOLID_DEBUG=1 |
--no-color | Disable ANSI colors (standard Unix convention) | NO_COLOR=1 |
--raw | Pipeline-clean output — no spinner, no decoration | — |
--no-spinner | Disable progress spinner | — |
-V, --version | Print CLI version | — |
--dry-run intercepts every write. Audit the plan before touching production.
--json, --format csv, and --raw make every command pipe-ready for jq, awk, or xargs.
SOLID_API_KEY env var or --token for headless auth. Never persisted to disk.
solid orders list --all --format csv --sort-by amount --order desc --output orders.csv
# Fetched 1,247 orders across 13 pages
# Saved to orders.csvCommand 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 credentialssolid auth statusCheck auth state + company infosolid whoamiWho am I logged in as (alias for auth status)solid statusFull business dashboard (contacts, website, modules)solid status --jsonJSON output for scriptingsolid healthQuick health checksolid health --fullFull 6-layer health checksolid doctorRead-only live probe — 9 backend endpoints, response timesPull / 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.
CMS pages with layout, meta, and content blocks
Knowledge base with YAML frontmatter + content
Company info, website config, module flags
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)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
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
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
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 accuracyAgent 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.
Each agent's identity, configuration, learned patterns, and expertise — built from every interaction
5-criteria scoring after every interaction — tracks accuracy, helpfulness, and tool usage over time
Real-time tokens, latency, cost, revenue attribution, and ROI tracking per agent
View an agent's soul
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/100Launch a multi-agent mission
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 executedAgent dashboard
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.5xMulti-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.
Business owner managing their own company. Single login.
Freelancer/employee building for 1–2 clients. Invited to companies.
Manages many companies. Creates new clients, switches between them.
# 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-onlyRun 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# 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- \u2022 Before filing a support ticket (paste the output)
- \u2022 After switching companies
- \u2022 In CI as a smoke test (
exit 1on any failure) - \u2022 When "the CLI feels slow" — see exact per-endpoint latency
- \u2022
0\u2014 all probes passed - \u2022
1\u2014 one or more probes failed - \u2022
2\u2014 not authenticated (runsolid auth login)
Smart Typo Suggestions
New in 1.9.23When you mistype a command, the CLI ranks the nearest matches by prefix, substring, then Levenshtein distance — same UX as gh, cargo, and git.
✗ Unknown command: psh
Did you mean solid push? ✗ Unknown command: dcotor
Did you mean solid doctor? ✗ Unknown command: comapny
Did you mean one of these?
solid company
solid domains ✗ 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
solid completion bash > \
/etc/bash_completion.d/solidzsh
solid completion zsh > \
"${fpath[1]}/_solid"fish
solid completion fish > \
~/.config/fish/completions/solid.fishDon'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.
solid auth token create \
-n "GitHub Actions" \
-s kb:read,pages:write \
-e 90
# Key: sk_solid_abc123...
# (Shown once — save immediately.)# 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 --stdinname: 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 entrieskb:writeCreate/update/delete KB entriespages:readRead CMS pagespages:writeCreate/update/publish pagesvibe:executeExecute vibe modificationstrain:readRead training datatrain:writeImport/modify training datacompany:readList linked companiescompany:switchSwitch active companycms:blog:readRead blog postscms:blog:writeCreate/update blog postscms:pages:readRead CMS page contentcms:pages:writeCreate/update CMS pagescontent:review:readRead content review pipelinecontent:review:writeApprove/reject content reviewsrag:retrieveRAG context retrievalagents:readList agents, view configs, get resumesagents:writeUpdate custom instructions, personality, settingsagents:dataView reflection history and performanceagents:converseStart/continue agent conversations (full context chain)flows:readList flows, get details, metricsflows:writeCreate, update, activate, pause, archive flowsbrand:readGet brand, CSS variables, voice context, auditbrand:writeCreate and update brand identitywidgets:readList widgets, get embed codes, metricswidgets:writeCreate, update, activate, pause widgetsTelemetry & 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
# One-off (this shell)
export SOLID_NO_TELEMETRY=1
# Permanent (add to ~/.zshrc or ~/.bashrc)
echo 'export SOLID_NO_TELEMETRY=1' >> ~/.zshrcConfiguration
Credentials and preferences live in ~/.solid/. You can override any setting via environment variable — env vars take precedence over the config file.
~/.solid/
├── config.json # active company, base URL, token
├── identity.json # anonymous machine ID for telemetry
└── cli_history.json # recent commands (for solid feedback context)SOLID_API_URL — backend base URLSOLID_API_KEY — auth tokenSOLID_TIMEOUT_MS — HTTP timeoutSOLID_NO_TELEMETRY — opt outSOLID_SKIP_WELCOME — suppress first-run banner- 1. CLI flag (
--token) - 2. Environment variable (
SOLID_API_KEY) - 3. Config file (
~/.solid/config.json) - 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.
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: 47MCP 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)
npx solid-mcp --stdioHTTP (cloud / production)
https://api.solidnumber.com/mcp/v1With 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.
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 logsOpen-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 npmInstall the CLI, pull your business data, and start shipping from the terminal.