Synopsis
Description
onboard is the recommended first command to run after installing profClaw. It walks through a 6-step wizard:
- Environment Detection - scans for Node.js, Redis, Ollama, Claude CLI, Git, Docker
- Deployment Mode - recommends
pico,mini, orprobased on available resources - AI Provider - configure Anthropic, OpenAI, or Ollama (or skip for later)
- Configuration - generates
.envandconfig/settings.yml - Setup - creates the admin account and database
- Validation - verifies all required files were created
Flags
boolean
Run without prompts. Useful for Docker builds, CI pipelines, and automated deployments. Uses defaults or values from other flags.
string
Deployment mode to configure. One of
pico, mini, or pro. If omitted in interactive mode, recommended based on detected resources.string
AI provider to configure in non-interactive mode. One of
anthropic, openai, ollama. API keys must already be set as environment variables.string
default:"3000"
Server port to write into the generated
.env file.Examples
Deployment Modes
What Gets Created
After onboarding succeeds:After Onboarding
Related
profclaw init- Lightweight init without the wizardprofclaw doctor- Diagnose environment issuesprofclaw serve- Start the HTTP serverprofclaw config- Manage configuration