# ane Documentation

A guide to using ane, the chord-based terminal code editor for humans and agents.

---

## Contents

| # | File | What's covered |
|---|------|----------------|
| 00 | [Getting Started](00-getting-started.md) | Installation, concepts, first edits in TUI and CLI |
| 01 | [Chord System](01-chord-system.md) | 4-part grammar, actions, positionals, scopes, components, arguments, resolution pipeline |
| 02 | [Chord Examples](02-chord-examples.md) | Worked before/after examples for every valid scope/component combination |
| 03 | [Using the TUI](03-using-the-tui.md) | Modes, keybindings, file tree, chord mode, edit mode |
| 04 | [Exec Mode](04-exec-mode.md) | One-shot CLI edits, unified diff output, stdin piping, agent workflows |
| 05 | [Embedding via Crate](05-embedding-via-crate.md) | Using ane as a Rust library, feature flags, core API, tool definitions |
| 06 | [LSP Integration](06-lsp-integration.md) | Language server support, auto-detection, status, chord gating |
| 07 | [Architecture Overview](07-architecture-overview.md) | Three-layer design, module layout, dependency rules |
| 08 | [Compared to Other Editors](08-compared-to-other-editors.md) | Trade-offs vs Vim, Neovim, Emacs, Helix, Kakoune, nano, micro |
| 09 | [Syntax Highlighting and Languages](09-syntax-highlighting-and-languages.md) | Tree-sitter + LSP pipeline, supported languages, multi-language projects, per-language examples |
| 10 | [Mouse Selection](10-mouse-selection.md) | Application-managed selection, click-to-position, drag-to-select, clipboard integration, native fallback |
| 11 | [Listing, Words, and Definitions](11-listing-and-word-definition.md) | List action for exploration, Word component for text-level editing, Definition component for signatures, First/Last positionals |

---

Start with [Getting Started](00-getting-started.md) if this is your first time.
