Back to Documentation

Developer CLI

Manage your entire business from the terminal

npm i -g @solidnumber/cli
17
Commands
52
Industry Templates
5
Access Modes
9
API Key Scopes

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

Command Reference

Core Workflow

solid auth loginLogin with email + password (interactive)
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 statusFull business dashboard (contacts, website, modules)
solid status --jsonJSON output for scripting
solid healthQuick health check
solid health --fullFull 6-layer health check

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

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)

# Switch between clients
solid switch "Mike's Plumbing"
# Switched to Mike's Plumbing (ID: 47)

solid pull && code .
# Open in VS Code, edit pages/kb, then push

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

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.

CI/CD pipeline example
# Create a key with specific scopes
solid auth token create -n "GitHub Actions" -s kb:read,pages:write -e 90
# Key: sk_solid_abc123... (shown once, save it!)

# Use in CI/CD via environment variable
SOLID_API_KEY=sk_solid_abc123... solid push --yes

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

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 holiday sale campaign”, or “Check inventory for low stock items”. 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)
  • 116 AI agents (24/7 autonomous)
  • 608 MCP tools across 14 servers
  • Vibe modifications (natural language)
  • Multi-tenant orchestration

Start Building

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

Free Developer Access API ReferenceMCP Protocol DocsAI Agents
SolidNumber — AI Business Infrastructure | Solid#