Skip to main content

​
Synopsis

profclaw onboard [flags]

​
Description

onboard is the recommended first command to run after installing profClaw. It walks through a 6-step wizard:
  1. Environment Detection - scans for Node.js, Redis, Ollama, Claude CLI, Git, Docker
  2. Deployment Mode - recommends pico, mini, or pro based on available resources
  3. AI Provider - configure Anthropic, OpenAI, or Ollama (or skip for later)
  4. Configuration - generates .env and config/settings.yml
  5. Setup - creates the admin account and database
  6. Validation - verifies all required files were created

​
Flags

​
--non-interactive
boolean
Run without prompts. Useful for Docker builds, CI pipelines, and automated deployments. Uses defaults or values from other flags.
​
--mode
string
Deployment mode to configure. One of pico, mini, or pro. If omitted in interactive mode, recommended based on detected resources.
​
--provider
string
AI provider to configure in non-interactive mode. One of anthropic, openai, ollama. API keys must already be set as environment variables.
​
--port
string
default:"3000"
Server port to write into the generated .env file.

​
Examples

profclaw onboard

​
Deployment Modes

ModeRAMUse case
pico~50 MBAgent + tools only, IoT, edge devices, personal use
mini~150 MBDashboard, cron, integrations - small teams and home servers
pro~300 MBEverything, requires Redis - production and enterprise

​
What Gets Created

After onboarding succeeds: 
.env                     # Environment configuration
config/settings.yml      # Server settings
data/profclaw.db         # SQLite database

​
After Onboarding

profclaw serve           # Start the server
profclaw doctor          # Verify everything is healthy
profclaw chat            # Start an interactive chat session