Files
picoclaw/docs/ja/docker.md
T
BeaconCat 403ceb39be docs: fix inaccuracies, add translations, and expand channel docs (#1837)
## Config field fixes (cross-verified against Go source)
- MaixCam: server_address → host + port
- IRC: use_tls → tls, channels_to_join → channels (all 6 languages)
- WeCom AI Bot: callback port 18791 → 18790
- credential_encryption: base_url → api_base, add required model field,
  remove incorrect passphrase-only mode docs
- providers.md: agents.defaults.model → model_name (×4), remove
  non-existent session.backlog_limit
- migration guide, troubleshooting: agents.defaults.model → model_name
- ANTIGRAVITY_AUTH: fix file path, Go 1.21 → 1.25, model → model_name
- spawn-tasks: fix truncated file, add Heartbeat introduction
- tools_configuration: add Tavily/SearXNG/GLMSearch, exec allow_remote/
  timeout_seconds/custom_allow_patterns, cron allow_command, skills
  github/search_cache, clawhub timeout/max_zip_size/max_response_size
- configuration: fix builtin skills path (build-time embedded, not cwd),
  HEARTBEAT.md marked auto-generated

## Broken link fixes (15 total)
- chat-apps.md: WeCom/Matrix links with wrong relative paths
- providers.md: migration link with extra docs/ prefix
- hardware-compatibility.md: README links with wrong depth (all 5 langs)
- chat-apps.md: WhatsApp dead links → anchor links (zh/ja)

## Getting-started accuracy
- README (all 6 langs): add picoclaw.io as recommended download,
  add missing picoclaw model CLI command
- docker.md: clarify first-run trigger condition (all 6 langs)
- configuration.md: fix builtin skills path description (all 6 langs)

## QQ channel
- Add quick setup via q.qq.com/qqbot/openclaw (one-click bot creation)
- Add manual setup as fallback (all 6 languages)

## Feishu channel
- Update setup flow: WebSocket/SDK mode, no webhook URL needed
- Preserve Lark international domain note (all 6 languages)

## chat-apps.md
- Add Feishu, Slack, IRC, OneBot detail sections (all 6 languages)
- Add MaixCam section to ja/fr/pt-br/vi
- Fix all channel doc links to point to correct language version

## New translations (25 files, 5 docs × 5 languages)
debug.md, credential_encryption.md, hardware-compatibility.md,
ANTIGRAVITY_AUTH.md, ANTIGRAVITY_USAGE.md → zh/ja/fr/pt-br/vi

## Channel docs (6 languages each, 60 new files)
telegram, discord, qq, feishu, maixcam, dingtalk, line, slack, onebot,
wecom/wecom_aibot, wecom/wecom_app, wecom/wecom_bot

Co-authored-by: BeaconCat <BeaconCat@users.noreply.github.com>
2026-03-20 22:37:05 +08:00

6.0 KiB
Raw Blame History

🐳 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 イメージには 3 つのバイナリ(picoclawpicoclaw-launcherpicoclaw-launcher-tui)がすべて含まれており、デフォルトで Web コンソールを起動します。ブラウザベースの設定・チャット画面を提供します。

docker compose -f docker/docker-compose.yml --profile launcher up -d

ブラウザで http://localhost:18800 を開いてください。Launcher が Gateway プロセスを自動管理します。

Warning

Web コンソールはまだ認証をサポートしていません。公開インターネットに公開しないでください。

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_key": "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_key": "your-api-key",
      "request_timeout": 300
    },
    {
      "model_name": "claude-sonnet-4.6",
      "model": "anthropic/claude-sonnet-4.6",
      "api_key": "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 アシスタントが手に入ります。