agent-doc is alpha software. Expect breaking changes between minor versions.
Use BREAKING CHANGE: prefix in version entries to flag incompatible changes.
- SPEC.md gaps filled: Document comment stripping as skill-level behavior (§4),
--root DIRflag for audit-docs (§7.6),agent-doc-versionfrontmatter field for auto-update detection (§7.12), and startup version check (warn_if_outdated). - Flaky test fix: Skill tests no longer use
std::env::set_current_dir. Refactoredinstall/checkto accept an explicit root path (install_at/check_at), eliminating CWD races in parallel test execution. - CLAUDE.md module layout updated: Added
claim.rs,prompt.rs,skill.rs,upgrade.rsto the documented module layout.
- SKILL.md: comment stripping for diff: Strip HTML comments (
<!-- ... -->) and link reference comments ([//]: # (...)) before comparing snapshot vs current content. Comments are a user scratchpad and no longer trigger agent responses. - SKILL.md: auto-update check: New
agent-doc-versionfrontmatter field enables pre-flight version comparison. If the installed binary is newer,agent-doc skill installruns automatically before proceeding. - PromptPanel: JDialog to JLayeredPane overlay: Replace
JDialogpopup with aJLayeredPaneoverlay in the JetBrains plugin, eliminating window-manager popup leaks.
agent-doc claim <file>: New subcommand — claim a document for the current tmux pane. Reads session UUID from frontmatter +$TMUX_PANE, updatessessions.json. Last-call-wins semantics. Also invokable as/agent-doc claim <file>via the Claude Code skill.agent-doc skill install: Install the bundled SKILL.md to.claude/skills/agent-doc/SKILL.mdin the current project. The skill content is embedded in the binary viainclude_str!, ensuring version sync.agent-doc skill check: Compare installed skill vs bundled version. Exit 0 if up to date, exit 1 if outdated or missing.- SKILL.md updated: Fixed stale
$()pattern →agent-doc commit <FILE>. Added/agent-doc claimsupport. - SPEC.md expanded: Added §7.7–7.13 (all commands), §8 Session Routing with use case table (U1–U11), §8.3 Claim Semantics.
- Multi-session prompt polling:
agent-doc prompt --allpolls all live sessions in one call, returns JSON array.SessionEntrynow includes afilefield for document path (backward-compatible). agent-doc commit <file>: New subcommand —git add -f+ commit with internally-generated timestamp. Replaces shell$()substitution in IDE/skill workflows.- Prompt detection:
agent-doc promptsubcommand added in v0.2.0 (unreleased). - send-keys fix: Literal text (
-l) + separate Enter,new-window -aappend flag (unreleased since v0.2.0).
agent-doc upgradeself-update: Downloads prebuilt binary from GitHub Releases as the primary upgrade strategy. Falls back tocargo install, thenpip install --upgrade, then manual instructions includingcurl | sh.
- Upgrade check: Queries crates.io for latest version with a 24h cache. Prints a one-line stderr warning on startup if outdated.
agent-doc upgrade: New subcommand triescargo installthenpip install --upgrade, or prints manual instructions.
- Language-agnostic audit-docs: Replace Cargo.toml-only root detection with 3-pass strategy (project markers → .git → CWD fallback). Scan 28 file extensions across 6 source dirs instead of .rs only.
- --root CLI flag: Override auto-detection of project root for audit-docs.
- Test coverage: Add unit tests for frontmatter, snapshot, and diff modules.
Initial release.
- Interactive document sessions: Edit a markdown document, run an AI agent, response appended back into the document.
- Session continuity: YAML frontmatter tracks session ID, agent backend, and model. Fork from current session on first run, resume on subsequent.
- Diff-based runs: Only changed content is sent as a diff, with the full document for context. Double-run guard via snapshots.
- Merge-safe writes: 3-way merge via
git merge-fileif the file is edited during agent response. Conflict markers written on merge failure. - Git integration: Pre-commit user changes before agent call, leave agent response uncommitted for editor diff gutters.
-bflag for auto-branch,--no-gitto skip. - Agent backends: Agent-agnostic core. Claude backend included. Custom backends configurable via
~/.config/agent-doc/config.toml. - Commands:
run,init,diff,reset,clean,audit-docs. - Editor integration: JetBrains External Tool, VS Code task, Vim/Neovim mapping.