Quick Start

Create a session document

agent-doc init session.md "My Topic"

This creates a markdown file with YAML frontmatter and a ## User block ready for your first message.

Write your first message

Open session.md in your editor and write under ## User:

---
session: null
agent: null
model: null
branch: null
---

# Session: My Topic

## User

Explain how TCP three-way handshake works.

Run the agent

agent-doc run session.md

The tool computes a diff, sends it to the agent, and appends the response as a ## Assistant block. Your editor reloads the file with the response.

Continue the conversation

Add a new ## User block below the assistant's response, write your follow-up, and run again:

agent-doc run session.md

Preview before running

agent-doc diff session.md       # see what changed since last run
agent-doc run session.md --dry-run  # preview the prompt without sending

Basic workflow

agent-doc init session.md "Topic"   # scaffold a session doc
# edit session.md in your editor
agent-doc run session.md            # diff, send, append response
# edit again, add follow-up
agent-doc run session.md            # next turn
agent-doc clean session.md          # squash git history when done