diff --git a/doc/env.sample b/doc/env.sample new file mode 100644 index 0000000..e2deba8 --- /dev/null +++ b/doc/env.sample @@ -0,0 +1,44 @@ +# ollie environment variables +# Copy relevant lines to ~/.config/ollie/env (KEY=VALUE, one per line) +# Lines beginning with # and blank lines are ignored. +# Inline comments are supported: KEY=value # comment + +# Mount path for the 9P filesystem (default: ~/mnt/ollie) +#OLLIE=~/mnt/ollie + +# Default backend (default: ollama) +# Supported: ollama, openai, openrouter, anthropic, copilot, kiro +#OLLIE_BACKEND=ollama + +# Default model name (backend-specific default if unset) +#OLLIE_MODEL= + +# Tool scripts directory, colon-separated (default: ~/.config/ollie/tools) +#OLLIE_TOOLS_PATH=~/.config/ollie/tools + +# Skills directory, colon-separated (default: ~/.config/ollie/skills) +#OLLIE_SKILLS_PATH=~/.config/ollie/skills + +# Plans directory (default: ~/.config/ollie/plans) +#OLLIE_PLAN_PATH=~/.config/ollie/plans + +# Memory directory (default: ~/.config/ollie/memory) +#OLLIE_MEMORY_PATH=~/.config/ollie/memory + +# Backend-specific settings + +# ollama +#OLLIE_OLLAMA_URL=http://localhost:11434 + +# openai / openrouter +#OLLIE_OPENAI_URL= +#OLLIE_OPENAI_KEY= + +# anthropic +#OLLIE_ANTHROPIC_KEY= + +# copilot +#OLLIE_COPILOT_TOKEN= + +# kiro / codewhisperer (bearer token or sqlite:// path) +#OLLIE_KIRO_TOKEN= diff --git a/doc/help.md b/doc/help.md index 7956a77..f31ff58 100644 --- a/doc/help.md +++ b/doc/help.md @@ -20,16 +20,20 @@ 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) + m/ memories (r/w) ls, cat, edit + idx memory index (ro) cat + p/ prompt templates (ro) ls, cat (rebuilt on new session, /cwd, /agent) pl/ plans (r/w) ls, cat, edit s/ sessions ls + idx session index (ro) cat: id state cwd backend model, one per line new create session (r/w) cat: KV template; echo "cwd=/path" > - / session directory rm -r to kill; mv to rename + / 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 ctxsz context size (ro) + cwd working directory (r/w) dequeue pop queued prompt (ro) enqueue queue a prompt (w) mcp MCP servers (ro) @@ -40,9 +44,11 @@ ollie/ state agent state (ro) idle | thinking | calling: systemprompt rendered system prompt (ro) usage token counts (ro) - cwd working directory (r/w) sk/ skills (r/w) ls, cat, edit + idx skill index (ro) cat + .md skill content (r/w) t/ tool scripts (r/w) ls, cat, edit, chmod + idx tool index (ro) cat ``` ## Session management @@ -58,7 +64,7 @@ echo stop > ~/mnt/ollie/s//ctl # interrupt current turn ```sh cat ~/mnt/ollie/backends # list backends -cat ~/mnt/ollie/s//models # list models +cat ~/mnt/ollie/s//models # list models for current backend echo ollama > ~/mnt/ollie/s//backend echo qwen3:8b > ~/mnt/ollie/s//model echo myagent > ~/mnt/ollie/s//agent @@ -69,11 +75,20 @@ 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) +OLLIE_BACKEND ollama | openai | openrouter | anthropic | copilot | kiro +OLLIE_MODEL default model name +OLLIE mount path (default: ~/mnt/ollie) +OLLIE_TOOLS_PATH tool scripts directory (default: ~/.config/ollie/tools) +OLLIE_SKILLS_PATH skills directory (default: ~/.config/ollie/skills) +OLLIE_PLAN_PATH plans directory (default: ~/.config/ollie/plans) +OLLIE_MEMORY_PATH memory directory (default: ~/.config/ollie/memory) + +OLLIE_OLLAMA_URL base URL for ollama (default: http://localhost:11434) +OLLIE_OPENAI_URL base URL for openai-compatible backends +OLLIE_OPENAI_KEY API key (openai, openrouter) +OLLIE_ANTHROPIC_KEY API key (anthropic) +OLLIE_COPILOT_TOKEN bearer token (copilot) +OLLIE_KIRO_TOKEN bearer token or sqlite:// path (kiro) ``` Set defaults in `~/.config/ollie/env` (KEY=VALUE, one per line).