Files
aircontext/templates/README.md
2026-05-18 11:45:08 +08:00

27 lines
1.0 KiB
Markdown

# AirContext (per-project)
This directory configures AirContext for **this project**. It was created the
first time you ran `aircontext` here.
## Files
- `config.yaml` — backend (LLM), trigger threshold, compaction options
- `rules.md` — compression rules sent to the LLM as system prompt
- `state.json` — runtime state (do not edit; managed by the plugin)
- `snapshots/` — backup of each JSONL before compaction; keep or delete freely
## Getting started
1. Open `config.yaml`, set `backend.endpoint` / `backend.model` / `backend.api_key`.
The default targets DeepSeek; replace with Ollama or any OpenAI-compatible
server as needed. For Ollama set `endpoint: http://localhost:11434/v1` and
any non-empty `api_key`.
2. Tune `trigger.threshold` (default 0.6 = compact at 60% of model context).
3. Edit `rules.md` to bias summaries toward what your project considers important.
4. Re-run `aircontext` from this directory.
## Disabling auto compaction temporarily
Run `/aircontext-pause` inside Claude Code, or set `safety.dry_run: true` in
config.yaml.