agent-doc 0.26.1

Interactive document sessions with AI agents
Documentation

agent-doc

Interactive document sessions with AI agents.

Edit a markdown file, press a hotkey, and the tool diffs your changes, sends them to an AI agent, and writes the response back into the document. The document is the UI.

Alpha Software — actively developed; APIs and frontmatter format may change between versions.

Install

# From crates.io
cargo install agent-doc

# From source
cargo build --release
cargo install --path .

Quick Start

# 1. Initialize project (creates .agent-doc/ and installs SKILL.md)
agent-doc init

# 2. Scaffold a session document
agent-doc init session.md "My Topic"

# 3. Claim the document to the current tmux pane
agent-doc claim session.md

# 4. Route hotkey triggers to the correct tmux pane
agent-doc route session.md

# 5. Run: diff, send to agent, write response back
agent-doc run session.md

The typical edit cycle: write in your editor, trigger agent-doc route <file> via a hotkey, the agent responds in the same document.

Key Features

  • Template mode — named component regions (<!-- agent:name -->) updated independently; inline attr > components.toml > built-in defaults
  • CRDT merge — yrs-based conflict-free merge for concurrent edits between agent writes and user edits
  • IPC-first writes — editor plugin receives JSON patches instead of file overwrites; preserves cursor position, undo history, and avoids "externally modified" dialogs
  • Tmux routing — persistent Claude Code sessions per document; route dispatches to the correct pane or auto-starts one
  • Streaming — real-time CRDT write-back loop (agent-doc stream) with optional chain-of-thought routing
  • Parallel fan-out — independent git worktrees per subtask, each with its own Claude session (agent-doc parallel)
  • Editor plugins — JetBrains and VS Code plugins for hotkey integration and IPC writes
  • Watch daemon — auto-submit on file change with debounce and reactive mode for stream documents
  • Git integration — auto-commit each run; squash history with agent-doc clean

Architecture

The binary owns all deterministic behavior: component parsing, patch application, CRDT merge, snapshot management, git operations, tmux routing, and IPC writes. The SKILL.md Claude Code skill is the non-deterministic orchestrator — it reads the diff, generates responses, and decides what to write.

See CLAUDE.md for the full module layout, binary vs. agent responsibility table, stream mode details, and release process.

Supported Editors

JetBrains (IntelliJ, PyCharm, etc.)

agent-doc plugin install jetbrains

Or install from JetBrains Marketplace. Configure an External Tool: Program=agent-doc, Args=run $FilePath$, Working dir=$ProjectFileDir$. Assign a keyboard shortcut.

VS Code

agent-doc plugin install vscode

Or install from the VS Code Marketplace. Add a task with "command": "agent-doc run ${file}" and bind it to a keybinding.

Vim/Neovim

nnoremap <leader>as :!agent-doc run %<CR>:e<CR>

License

Licensed under either of MIT or Apache-2.0 at your option.