LazyBoy2/README.md

57 lines
1.3 KiB
Markdown
Raw Normal View History

# GrokBoy
Minimal local **GrokBot-like** CLI agent. Phase **P1**: tools + ReAct + sessions.
## Status
| Phase | Status |
|-------|--------|
| P0 streaming chat | done |
| P1 shell / files + ReAct | done |
| P2 completion / loop guard | planned |
| P3 browser (Playwright) | later |
No Docker desktop, no Codex/LazyBoy fork.
## Setup (macOS)
```bash
export GROKBOY_API_KEY=your_key # or XAI_API_KEY
# optional:
# export GROKBOY_BASE_URL=https://api.x.ai/v1
# export GROKBOY_MODEL=grok-4.6
cd ~/GrokBoy
cargo run -p grokboy -- chat
```
## Commands
- `grokboy chat` — interactive streaming chat (no tools)
- `grokboy run "<prompt>"` — one-shot agent with tools (`shell`, `list_dir`, `read_file`, `write_file`)
- `grokboy run --session <id> "<prompt>"` — continue a saved session
- `grokboy smoke` — offline tool checks (no API key required)
- `grokboy help`
Sessions are stored under `~/.grokboy/sessions/<id>.json`.
## 繁體中文
本機終端機 coding assistant。P1 已支援讀寫檔、列目錄、shell以及多輪 tool-calling。
```bash
export GROKBOY_API_KEY=你的金鑰
cd ~/GrokBoy
cargo run -p grokboy -- smoke
cargo run -p grokboy -- run "列出目前目錄並讀 README.md"
cargo run -p grokboy -- chat
```
## Layout
```
crates/grokboy-core/ # config, model, tools, agent, session
crates/grokboy/ # CLI binary
docs/ACCEPTANCE.md
```