@brainpilot/app
v0.0.8
Published
BrainPilot CLI — Docker-free local one-click launch (bin: brainpilot / bnpt)
Readme
@brainpilot/app
BrainPilot is an open-source, single-user multi-agent collaboration platform built with TypeScript + the Pi SDK — a Principal agent coordinating specialist agents over a file-based mailbox, served as a Hono backend + React SPA. It runs as a local process; no Docker required.
This package (@brainpilot/app) is the CLI. It installs the brainpilot
command (bnpt is a built-in short alias).
Prerequisites
- Node.js ≥ 22
- An Anthropic API key (or
BP_MOCK=1for a no-key test run)
Install
npm install -g @brainpilot/appQuick Start
# 1. Scaffold config under ./brainpilot
brainpilot init --api-key <your-anthropic-key>
# 2. Launch (foreground; Ctrl-C to stop)
brainpilot upThen open the printed URL (default http://127.0.0.1:9001).
A missing key does not block launch — brainpilot up starts anyway, and you
can configure the provider URL / key / model in the web Settings → Providers
panel after it opens (the recommended path; it writes providers.json for you).
No-key smoke run
BP_MOCK=1 brainpilot upBP_MOCK=1 runs a deterministic mock agent that makes no real LLM calls — handy
for verifying the install end-to-end without an API key.
Configure a gateway / third-party endpoint
brainpilot init --api-key <key> \
--base-url https://your-gateway.example.com/api \
--model kimi-k2.6You can also omit --api-key and supply credentials via the ANTHROPIC_API_KEY
environment variable instead.
Detached mode
brainpilot up --detach # run in the background, managed by the CLI
brainpilot status # health + child pid
brainpilot logs # tail backend log (add --runtime for the runtime log)
brainpilot down # stop the detached backendCommon flags
| Flag | Meaning |
|------|---------|
| --port <n> | Backend port (default 9001) |
| --dir <path> | Data directory (default ./brainpilot) |
| --detach | Run in the background |
| --no-open | Don't open the browser on launch |
Documentation
Full documentation, architecture notes, and advanced configuration live in the GitHub README:
➡️ https://github.com/NeuroAIHub/BrainPilot
License
AGPL-3.0-only
