Restructure all 6 README files (en, zh, ja, fr, pt-br, vi) from
~1200-1580 lines down to ~250 lines each. Long sections (Chat Apps,
Providers, Configuration, Docker, Spawn Tasks, Troubleshooting, Tools)
are extracted into dedicated docs under docs/{lang}/ subdirectories.
Changes:
- Split README content into 7 sub-documents per language (42 new files)
- Update News section with v0.2.3/v0.2.1/v0.2.0/20K milestones
- Add 3 new Features (MCP Support, Vision Pipeline, Smart Routing)
- Complete CLI reference (14 commands, was 7)
- Fix Go badge 1.21+ -> 1.25+ (matches go.mod)
- Add LoongArch to architecture badge
- Fix Install section: hardcoded v0.1.1 -> latest/download URL
- Add Termux GitHub links
- Fix currency symbol placement ($599 not 599$)
- Add missing channels (Feishu, Slack, IRC, OneBot, MaixCam, Pico)
- Add missing providers (Kimi, Minimax, Avian, Mistral, Longcat, ModelScope)
- Add missing security docs (allow_read/write_paths, allow_remote, symlink)
- Remove incorrect azure from Providers table (azure uses model_list only)
- Cross-verified all claims against source code
Co-authored-by: BeaconCat <BeaconCat@users.noreply.github.com>
5.5 KiB
🐳 Docker và Bắt Đầu Nhanh
Quay lại README
🐳 Docker Compose
Bạn cũng có thể chạy PicoClaw bằng Docker Compose mà không cần cài đặt gì trên máy.
# 1. Clone repo này
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw
# 2. Lần chạy đầu tiên — tự động tạo docker/data/config.json rồi thoát
docker compose -f docker/docker-compose.yml --profile gateway up
# Container hiển thị "First-run setup complete." và dừng lại.
# 3. Cấu hình API key của bạn
vim docker/data/config.json # Set provider API keys, bot tokens, etc.
# 4. Khởi động
docker compose -f docker/docker-compose.yml --profile gateway up -d
Tip
Người dùng Docker: Mặc định, Gateway lắng nghe trên
127.0.0.1, không thể truy cập từ host. Nếu bạn cần truy cập các health endpoint hoặc mở port, hãy đặtPICOCLAW_GATEWAY_HOST=0.0.0.0trong môi trường hoặc cập nhậtconfig.json.
# 5. Kiểm tra log
docker compose -f docker/docker-compose.yml logs -f picoclaw-gateway
# 6. Dừng
docker compose -f docker/docker-compose.yml --profile gateway down
Chế Độ Launcher (Web Console)
Image launcher bao gồm cả ba binary (picoclaw, picoclaw-launcher, picoclaw-launcher-tui) và khởi động web console mặc định, cung cấp giao diện trình duyệt để cấu hình và chat.
docker compose -f docker/docker-compose.yml --profile launcher up -d
Mở http://localhost:18800 trong trình duyệt. Launcher tự động quản lý tiến trình gateway.
Warning
Web console chưa hỗ trợ xác thực. Tránh để lộ ra internet công cộng.
Chế Độ Agent (One-shot)
# Đặt câu hỏi
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent -m "What is 2+2?"
# Chế độ tương tác
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent
Cập Nhật
docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml --profile gateway up -d
🚀 Bắt Đầu Nhanh
Tip
Cấu hình API Key trong
~/.picoclaw/config.json. Lấy API Key: Volcengine (CodingPlan) (LLM) · OpenRouter (LLM) · Zhipu (LLM). Tìm kiếm web là tùy chọn — lấy miễn phí Tavily API (1000 truy vấn miễn phí/tháng) hoặc Brave Search API (2000 truy vấn miễn phí/tháng).
1. Khởi tạo
picoclaw onboard
2. Cấu hình (~/.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
}
}
}
}
Mới: Định dạng cấu hình
model_listcho phép thêm provider mà không cần thay đổi code. Xem Cấu Hình Mô Hình để biết chi tiết.request_timeoutlà tùy chọn và tính bằng giây. Nếu bỏ qua hoặc đặt<= 0, PicoClaw sử dụng timeout mặc định (120s).
3. Lấy API Key
- Nhà cung cấp LLM: OpenRouter · Zhipu · Anthropic · OpenAI · Gemini
- Tìm kiếm Web (tùy chọn):
- Brave Search - Trả phí ($5/1000 truy vấn, ~$5-6/tháng)
- Perplexity - Tìm kiếm bằng AI với giao diện chat
- SearXNG - Công cụ tìm kiếm tổng hợp tự host (miễn phí, không cần API key)
- Tavily - Tối ưu cho AI Agent (1000 yêu cầu/tháng)
- DuckDuckGo - Fallback tích hợp (không cần API key)
Lưu ý: Xem
config.example.jsonđể có mẫu cấu hình đầy đủ.
4. Chat
picoclaw agent -m "What is 2+2?"
Vậy là xong! Bạn có một trợ lý AI hoạt động trong 2 phút.