# Chord Docs

This documentation is for end users: installation, configuration, daily usage, customization, and troubleshooting.

- 中文版入口：见 [index_CN.md](./index_CN.md)

Start with what works out of the box; move on to customization and advanced workflows when you need more.

## Find docs by task

- **Start quickly**: [Quickstart](./quickstart.md)
- **Configure models**: [Configuration & Auth](./configuration.md) · [Examples](./examples/index.md)
- **Remote control**: [Headless](./headless.md) · [Permissions & Safety](./permissions-and-safety.md)
- **Long-running tasks**: [Usage — `/loop`](./usage.md#loop--continuous-execution-mode)
- **Extend and customize**: [Customization](./customization.md) · [Hooks](./hooks.md)
- **Troubleshoot issues**: [Troubleshooting](./troubleshooting.md)

## Getting started

- [Quickstart](./quickstart.md) — get running in minutes
- [Usage](./usage.md) — TUI basics, sessions, common commands, headless mode
- [Glossary](./glossary.md) — vocabulary used across these docs

## Reference

- [CLI](./cli.md) — every command, subcommand, and flag
- [Configuration & Auth](./configuration.md) — `config.yaml`, `auth.yaml`, providers, model pools, full schema cheatsheet
- [Keybindings](./keybindings.md) — complete key map and how to customize it
- [Paths](./paths.md) — config / state / cache / project layout, what is safe to delete
- [Environment variables](./environment.md) — every `CHORD_*` / `XDG_*` / proxy variable Chord reads
- [Platform support](./platforms.md) — what works on macOS / Linux / Windows / WSL

## Going further

- [Customization](./customization.md) — agents, skills, MCP, optional LSP setup, custom slash commands
- [Hooks](./hooks.md) — 14 trigger points, payload contract, examples
- [Examples](./examples/index.md) — copy-paste-ready `config.yaml` setups for common situations

## Integration

- [Headless](./headless.md) — `chord headless` JSON control plane and `chord-gateway`

## Safety

- [Permissions & Safety](./permissions-and-safety.md) — the permission model and security boundaries

## Troubleshooting

- [Troubleshooting](./troubleshooting.md) — symptoms, common causes, and how to collect logs
