--- type: reference title: AGENTS.md Index description: Overview of the cached tool documentation system — how it works, why the pre-flight check matters, and how to add new entries. tags: - documentation - index - pre-flight-check - meta timestamp: 2026-01-15 --- # pi Documentation Index This directory (`/home/dank/.pi/agent/docs/`) contains cached documentation for tools used during system configuration. It is the agent's primary reference before touching any configuration file. --- ## How to Use Before configuring any tool, check whether documentation already exists here. If it does not, a subagent **must** be spawned to fetch documentation before proceeding. This is not a suggestion. It is the difference between "I remember how to configure this" and "I will need to re-read the docs for the third time this week." --- ## Available Tool Documentation ### Core * [AGENTS.md Format](agents-md-format.md) — Structure specification for the system-level instruction file: layer conventions, naming, summary table format, and add/remove procedures. ### Tools * [Ghostty Terminal](../tools/ghostty/index.md) — GPU-accelerated terminal emulator. Complete configuration reference with 100+ options organized by category, CLI actions, keybindings, shaders, and default bindings. * [llama.cpp Server](../tools/llama-cpp/index.md) — LLM inference server. GGUF format, build guides (CPU/CUDA/Metal/Vulkan), server CLI options, API endpoints, Docker setup, and curl examples. * [Linux Power Management](../tools/linux-power-management.md) — Systemd sleep configuration, kernel sleep states, NVIDIA GPU suspend/resume, diagnostic tools, kernel parameters, and automated testing procedures. * [Niri](../tools/niri/index.md) — Scrollable-tiling Wayland compositor. Full keybind cheat sheet, configuration syntax, window management, workspace navigation, and action reference. ### Pi Packages * [pi-browser-use](../packages/pi-browser-use.md) — Browser automation extension wrapping chrome-devtools-mcp with `browser_` prefix, full config reference, session modes, vision model setup, and tool augmentation docs. * [pi-permission-system](../packages/pi-permission-system.md) — 10 docs covering permission enforcement, config reference, session approvals, cross-extension API, subagent integration, troubleshooting, and migration guides. ### Skills * [Npx Skills](../skills/npx-skills.md) — Distribution and installation patterns for agent skills via npm, package structure, SKILL.md frontmatter, discovery rules, and the Agent Skills specification. * [Vercel Labs `skills` CLI](../skills/vercel-skills.md) — CLI meta-installer for cross-agent skill distribution, supporting 68+ agents, with add/use/find/list/update/remove commands. ### References * [OKF v0.1 Specification](../references/okf-spec.md) — Complete specification for OKF knowledge bundles: bundle structure, frontmatter fields, concept documents, index/log files, cross-linking, and conformance rules. * [OKF Bundle Maintenance](../references/okf-maintenance.md) — Bundle maintenance: log.md format, frontmatter discipline, one-concept-per-file, staleness detection, and automation strategies. --- ## Adding New Tool Documentation When a subagent fetches documentation for a new tool: 1. Save it to `tools//index.md` (multi-file) or `tools/.md` (small, single-concept). 2. Add an entry to this index table. 3. Include a brief description of what the document covers. 4. Add YAML frontmatter with `type` and `description`. 5. Update `log.md` with the change. --- ## Index Format Give each row this content: - **Tool** — the tool or technology name - **File / Path** — relative path within this directory - **Status** — for example, "Complete", "Partial", "Needs Update"