ollie/doc/help.md

80 lines
2.9 KiB
Markdown

# ollie
An AI agent exposed as a filesystem. Mount it, then use shell tools.
## Quick start
```sh
olliesrv start # start the 9P server
echo "cwd=$PWD" > ~/mnt/ollie/s/new # create a session
ls ~/mnt/ollie/s/ # find the session ID
echo "hello" > ~/mnt/ollie/s/<id>/prompt # send a prompt
cat ~/mnt/ollie/s/<id>/chat # read the conversation
tail -f ~/mnt/ollie/s/<id>/chat # follow live output
```
## Filesystem
```
ollie/
a/ agent configs (r/w) ls, cat, cp, mv, rm
backends available backends (ro) cat
help this file (ro) cat
p/ prompt templates (r/w) ls, cat, edit (rebuilt on new session, /cwd, /agent)
pl/ plans (r/w) ls, cat, edit
s/ sessions ls
new create session (r/w) cat: KV template; echo "cwd=/path" >
<id>/ session directory rm -r to kill; mv to rename
agent active agent (r/w)
backend active backend (r/w)
chat conversation log (ro)
ctl control (w) stop, kill, clear, compact, rn <name>
ctxsz context size (ro)
dequeue pop queued prompt (ro)
enqueue queue a prompt (w)
mcp MCP servers (ro)
model active model (r/w)
models available models (ro)
prompt submit prompt (w)
reply last reply (ro)
state agent state (ro) idle | thinking | calling: <tool>
systemprompt rendered system prompt (ro)
usage token counts (ro)
cwd working directory (r/w)
sk/ skills (r/w) ls, cat, edit
t/ tool scripts (r/w) ls, cat, edit, chmod
```
## Session management
```sh
echo "cwd=/path backend=ollama model=qwen3:8b" > ~/mnt/ollie/s/new
mv ~/mnt/ollie/s/<id> ~/mnt/ollie/s/my-name # rename
rm -r ~/mnt/ollie/s/<id> # kill
echo stop > ~/mnt/ollie/s/<id>/ctl # interrupt current turn
```
## Switching backend/model/agent
```sh
cat ~/mnt/ollie/backends # list backends
cat ~/mnt/ollie/s/<id>/models # list models
echo ollama > ~/mnt/ollie/s/<id>/backend
echo qwen3:8b > ~/mnt/ollie/s/<id>/model
echo myagent > ~/mnt/ollie/s/<id>/agent
```
Writes to backend, model, and agent are rejected while the agent is running.
## Environment
```
OLLIE_BACKEND ollama | openai | openrouter | anthropic | copilot | kiro
OLLIE_MODEL default model name
OLLIE_9MOUNT mount path (default: ~/mnt/ollie)
OLLIE_TOOLS_PATH tool scripts directory (default: ~/.config/ollie/tools)
OLLIE_SKILLS_PATH skills directory (default: ~/.config/ollie/skills)
```
Set defaults in `~/.config/ollie/env` (KEY=VALUE, one per line).