lkn
/
anvillm
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document all configurable options 

Add Configuration section with:
- Environment variables table (NAMESPACE, ANVILLM_*, API keys)
- Sandbox config templates table (CWD, HOME, TMPDIR, XDG_*)
- Reference from Backends section
- Remove redundant debug/terminal note from Troubleshooting

All behavior-changing environment variables now documented
This commit is contained in:
Levi Neely 2026-02-19 23:39:57 +01:00
parent 6a5c326a93
commit 9fbcf8de51
1 changed files with 29 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -156,7 +156,7 @@ network: {enabled: true, unrestricted: true}
filesystem: {rw: ["{CWD}", "{HOME}/.npm"]}
```
Templates: `{CWD}`, `{HOME}`, `{TMPDIR}` — Tip: Make `roles/default.yaml` permissive
Templates: `{CWD}`, `{HOME}`, `{TMPDIR}`, `{XDG_*}` (see Configuration) — Tip: Make `roles/default.yaml` permissive
**Kernel:** 5.13+ (Landlock v1), 6.7+ (v4), 6.10+ (v5 network) — Best-effort: `best_effort: true` (⚠️ unsandboxed if no Landlock)
@ -193,6 +193,33 @@ See `workflows/`, `kiro-cli/SKILLS_PROMPT.md`
Enables LLM clients to control AnviLLM sessions and communicate with agents
## Configuration
### Environment Variables
| Variable | Default | Description |
|----------|---------|-------------|
| `NAMESPACE` | `/tmp/ns.$USER.:0` | 9P namespace for server/client communication |
| `ANVILLM_BEADS_PATH` | `~/.beads` | Beads database location (shared across namespaces) |
| `ANVILLM_TERMINAL` | `foot` | Terminal command for tmux attach (Assist) |
| `ANTHROPIC_API_KEY` | — | Claude API key (required for Claude backend) |
| `CLAUDE_AGENT_NAME` | `anvillm-agent` | Claude agent configuration name |
| `KIRO_API_KEY` | — | Kiro API key (required for Kiro backend) |
### Sandbox Config Templates
Available in sandbox YAML files (`~/.config/anvillm/`):
| Template | Expands To | Description |
|----------|------------|-------------|
| `{CWD}` | Current working directory | Session's working directory |
| `{HOME}` | User home directory | `$HOME` |
| `{TMPDIR}` | Temp directory | `$TMPDIR` or `/tmp` |
| `{XDG_CONFIG_HOME}` | XDG config | `$XDG_CONFIG_HOME` or `~/.config` |
| `{XDG_DATA_HOME}` | XDG data | `$XDG_DATA_HOME` or `~/.local/share` |
| `{XDG_CACHE_HOME}` | XDG cache | `$XDG_CACHE_HOME` or `~/.cache` |
| `{XDG_STATE_HOME}` | XDG state | `$XDG_STATE_HOME` or `~/.local/state` |
## Troubleshooting
| Problem | Solution |
@ -207,5 +234,4 @@ Enables LLM clients to control AnviLLM sessions and communicate with agents
| Daemon won't stop | `anvilsrv fgstart` for logs |
| anvilweb issues | Check anvilsrv running, namespace matches |
Debug: `anvilsrv fgstart`
Terminal: `$ANVILLM_TERMINAL` (default: `foot`)
See Configuration section for environment variables.