opencode/picoclaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README and AGENTS.md with TUI documentation

Browse source
This commit is contained in:
Rahul Bansal 2026-02-21 19:15:44 +05:30
parent 94fa0b48c8
commit 9a2824bab5
2 changed files with 23 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
AGENTS.md
View file

@ -43,6 +43,7 @@ pkg/
openai_compat/ OpenAI-compatible HTTP provider openai_compat/ OpenAI-compatible HTTP provider
session/ Session persistence (~/.picoclaw/workspace/sessions/*.json) session/ Session persistence (~/.picoclaw/workspace/sessions/*.json)
tools/ Tool system — one file per tool (exec, web, edit, filesystem, etc.) tools/ Tool system — one file per tool (exec, web, edit, filesystem, etc.)
tui/ Bubbletea terminal UI (chat viewport, markdown, tool indicators)
``` ```
## Code Style ## Code Style

20
README.md
View file

@ -255,7 +255,8 @@ picoclaw onboard
**4. Chat** **4. Chat**
```bash ```bash
picoclaw agent -m "What is 2+2?" picoclaw agent -m "What is 2+2?" # one-shot mode
picoclaw agent # interactive TUI
``` ```
That's it! You have a working AI assistant in 2 minutes. That's it! You have a working AI assistant in 2 minutes.
@ -1082,15 +1083,26 @@ picoclaw agent -m "Hello"
## CLI Reference ## CLI Reference
| Command | Description | | Command | Description |
| ------------------------- | ----------------------------- | | ------------------------- | ------------------------------------------------- |
| `picoclaw onboard` | Initialize config & workspace | | `picoclaw onboard` | Initialize config & workspace |
| `picoclaw agent -m "..."` | Chat with the agent | | `picoclaw agent -m "..."` | Send a single message (one-shot mode) |
| `picoclaw agent` | Interactive chat mode | | `picoclaw agent` | Interactive TUI chat (scrollable, markdown, tools) |
| `picoclaw gateway` | Start the gateway | | `picoclaw gateway` | Start the gateway |
| `picoclaw status` | Show status | | `picoclaw status` | Show status |
| `picoclaw cron list` | List all scheduled jobs | | `picoclaw cron list` | List all scheduled jobs |
| `picoclaw cron add ...` | Add a scheduled job | | `picoclaw cron add ...` | Add a scheduled job |
### Interactive TUI
Running `picoclaw agent` launches a full terminal UI powered by [Bubbletea](https://github.com/charmbracelet/bubbletea):
- **Scrollable chat** — PgUp/PgDown to scroll through conversation history
- **Markdown rendering** — Assistant responses are rendered with syntax highlighting
- **Tool call indicators** — See real-time status as the agent reads files, runs commands, etc.
- **Status bar** — Shows current model, message count, and session
- **Slash commands** — Type `/help` for available commands (`/new`, `/status`, `/switch model to ...`)
- **Multi-line input** — Shift+Enter to insert newlines, Enter to send
### Scheduled Tasks / Reminders ### Scheduled Tasks / Reminders
PicoClaw supports scheduled reminders and recurring tasks through the `cron` tool: PicoClaw supports scheduled reminders and recurring tasks through the `cron` tool: