* feat(model): add `picoclaw model add` for custom OpenAI-compatible endpoints Onboards a model from a user-supplied API base + key by hitting GET <base>/models, prompting the user to pick one, and writing the entry into model_list[] (with api_keys) plus setting it as the default model. This was previously only available in the TUI launcher (issue #2208) and is now accessible from the CLI: picoclaw model add -b URL -k KEY [-m MODEL] [-n ALIAS] * chore: remove deprecated picoclaw-launcher-tui Per RFC #2208, the TUI launcher is deprecated in favor of the CLI; its "online model picker" feature has been ported to `picoclaw model add` in the previous commit. This drops the binary and all build/release/docs references: - delete cmd/picoclaw-launcher-tui/ and assets/launcher-tui.jpg - Makefile: remove the `build-launcher-tui` target - .goreleaser.yaml: drop the build entry plus the `picoclaw-launcher-tui` ids from the launcher docker image, macOS notarize list, and nfpms contents - docker/Dockerfile.goreleaser.launcher: drop the COPY for the TUI binary - READMEs (root + 8 locales): remove the "TUI Launcher" section and screenshot link - docs/guides/docker.*: update the "launcher image includes …" sentence to reflect the two remaining binaries `make build` still succeeds; `go build ./web/backend` (the launcher target) still succeeds. `picoclaw-launcher` (web console) is unaffected.
6.0 KiB
🐳 Docker とクイックスタート
README に戻る
🐳 Docker Compose
Docker Compose を使用して PicoClaw を実行できます。ローカルに何もインストールする必要はありません。
# 1. リポジトリをクローン
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw
# 2. 初回実行 — docker/data/config.json を自動生成して終了
# (config.json と workspace/ の両方が存在しない場合のみ実行)
docker compose -f docker/docker-compose.yml --profile gateway up
# コンテナが "First-run setup complete." と表示して停止します
# 3. API Key を設定
vim docker/data/config.json # provider API key、Bot Token などを設定
# 4. 起動
docker compose -f docker/docker-compose.yml --profile gateway up -d
Tip
Docker ユーザー: デフォルトでは Gateway は
127.0.0.1でリッスンしており、コンテナ外からはアクセスできません。ヘルスチェックエンドポイントへのアクセスやポート公開が必要な場合は、環境変数でPICOCLAW_GATEWAY_HOST=0.0.0.0を設定するか、config.jsonを更新してください。
# 5. ログを確認
docker compose -f docker/docker-compose.yml logs -f picoclaw-gateway
# 6. 停止
docker compose -f docker/docker-compose.yml --profile gateway down
Launcher モード (Web コンソール)
launcher イメージには 2 つのバイナリ(picoclaw、picoclaw-launcher)が含まれており、デフォルトで Web コンソールを起動します。ブラウザベースの設定・チャット画面を提供します。
docker compose -f docker/docker-compose.yml --profile launcher up -d
ブラウザで http://localhost:18800 を開いてください。Launcher が Gateway プロセスを自動管理します。
Warning
Web コンソールは dashboard ログインパスワードで保護されます。信頼できないネットワークや公開インターネットには公開しないでください。
Agent モード (ワンショット)
# 質問する
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent -m "2+2は?"
# インタラクティブモード
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent
イメージの更新
docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml --profile gateway up -d
🚀 クイックスタート
Tip
~/.picoclaw/config.jsonに API Key を設定してください。API Key の取得先: Volcengine (CodingPlan) (LLM) · OpenRouter (LLM) · Zhipu (LLM)。Web 検索はオプションです — 無料の Tavily API (月 1000 回無料) または Brave Search API (月 2000 回無料) を取得できます。
1. 初期化
picoclaw onboard
2. 設定 (~/.picoclaw/config.json)
{
"agents": {
"defaults": {
"workspace": "~/.picoclaw/workspace",
"model_name": "gpt-5.4",
"max_tokens": 8192,
"temperature": 0.7,
"max_tool_iterations": 20
}
},
"model_list": [
{
"model_name": "ark-code-latest",
"model": "volcengine/ark-code-latest",
"api_keys": ["sk-your-api-key"],
"api_base":"https://ark.cn-beijing.volces.com/api/coding/v3"
},
{
"model_name": "gpt-5.4",
"model": "openai/gpt-5.4",
"api_keys": ["your-api-key"],
"request_timeout": 300
},
{
"model_name": "claude-sonnet-4.6",
"model": "anthropic/claude-sonnet-4.6",
"api_keys": ["your-anthropic-key"]
}
],
"tools": {
"web": {
"enabled": true,
"fetch_limit_bytes": 10485760,
"format": "plaintext",
"brave": {
"enabled": false,
"api_key": "YOUR_BRAVE_API_KEY",
"max_results": 5
},
"tavily": {
"enabled": false,
"api_key": "YOUR_TAVILY_API_KEY",
"max_results": 5
},
"duckduckgo": {
"enabled": true,
"max_results": 5
},
"perplexity": {
"enabled": false,
"api_key": "YOUR_PERPLEXITY_API_KEY",
"max_results": 5
},
"searxng": {
"enabled": false,
"base_url": "http://your-searxng-instance:8888",
"max_results": 5
}
}
}
}
新機能:
model_list設定形式により、コード変更なしで provider を追加できます。詳細はモデル設定を参照してください。request_timeoutはオプションで、単位は秒です。省略または<= 0に設定した場合、PicoClaw はデフォルトのタイムアウト(120 秒)を使用します。
3. API Key の取得
- LLM プロバイダー: OpenRouter · Zhipu · Anthropic · OpenAI · Gemini
- Web 検索 (オプション):
- Brave Search - 有料 ($5/1000 queries, ~$5-6/month)
- Perplexity - AI 搭載の検索・チャットインターフェース
- SearXNG - セルフホスト型メタ検索エンジン(無料、API Key 不要)
- Tavily - AI Agent 向けに最適化 (1000 requests/month)
- DuckDuckGo - 組み込みフォールバック(API Key 不要)
注意: 完全な設定テンプレートは
config.example.jsonを参照してください。
4. チャット
picoclaw agent -m "2+2は?"
以上です!2 分で動作する AI アシスタントが手に入ります。