Generate a self-contained static HTML saga of a git diff — a chapter-by-chapter guided tour of a change.
Project description
Saga
Generate a chapter-by-chapter guided tour of a code change as a single, self-contained static HTML page, a saga of your diff. It partitions a diff into ordered chapters that tell one coherent story, each with a plain-language narration and just the hunks that belong to it. Large PRs become easy to review without losing the thread.
The output is one HTML file with everything inlined (diff2html, syntax highlighting, the data). Open it offline, email it, commit it, or drop it on any static host.
Requirements
- Python 3.11+
git- The
ghCLI, authenticated — only for reviewing a PR by URL (saga <pr-url>) or pushing review comments - An API key for your chosen provider, in the standard environment variable:
ANTHROPIC_API_KEY,OPENAI_API_KEY, orOPENROUTER_API_KEY— or a running local server (Ollama / LM Studio) and no key, with alocal/model
Generation is one structured LLM call made through instructor.
Install
Install once and the saga command is available from any repo:
uv tool install saga-cli # recommended
# or
pipx install saga-cli
# or, into the current environment
pip install saga-cli
Installing from a local checkout instead? Point the installer at this directory,
e.g. uv tool install /path/to/saga. To upgrade: uv tool install --force saga-cli.
Usage
From inside the repo, on the branch you want to review:
saga
From inside the repo, reviewing a different branch:
saga --base main --head my-feature -o saga.html --open
Run it from anywhere with --repo:
saga --repo ~/src/some-project --base main --head my-feature -o out.html
From a GitHub PR URL
Point saga straight at a pull request by passing its URL as the first argument. No checkout is needed and it works from any directory:
saga https://github.com/owner/repo/pull/5
saga https://github.com/owner/repo/pull/5 --model openai/gpt-4o -o pr5.html
This fetches the PR's diff, commits, and branch names with the
gh CLI (so gh must be installed and authenticated),
then builds the saga exactly as it would for a local branch. In this mode the PR
defines the change set, so --base, --head, and --repo are ignored.
The optional positional argument is a GitHub PR URL (as above); all flags below apply to both modes.
| Flag | Default | Meaning |
|---|---|---|
--base |
auto-detected | Base ref to diff against (defaults to the repo's default branch, e.g. origin/main); local mode only |
--head |
current branch | Head ref to walk through; local mode only |
--intent PATH |
— | Optional plan/spec describing the change's intent, for plan-aware narration and deviation flagging |
--model |
anthropic/claude-opus-4-8 |
provider/model string (see Providers); also $SAGA_MODEL |
-o, --output |
saga.html |
Output file |
--repo |
cwd | A path inside the target git repo; local mode only |
--open / --no-open |
on | Open the result in a browser (the served URL when serving, else the file:// page) |
--serve / --no-serve |
on | On an interactive terminal, serve the saga after generating so comments save into the file (see Reviewing); --no-serve writes and exits |
Providers
The model is a single provider/model string, dispatched through instructor.
Choose it with --model or the SAGA_MODEL environment variable, and set
the matching API key:
| Provider | --model example |
API key env var |
|---|---|---|
| Anthropic | anthropic/claude-opus-4-8 |
ANTHROPIC_API_KEY |
| OpenAI | openai/gpt-4o |
OPENAI_API_KEY |
| OpenRouter | openrouter/anthropic/claude-3.5-sonnet |
OPENROUTER_API_KEY |
| Local | local/qwen2.5-coder:14b |
none |
| Claude CLI | claude-cli or claude-cli/sonnet |
none (Claude Code login) |
export SAGA_MODEL=openai/gpt-4o
export OPENAI_API_KEY=sk-…
saga --base main --head my-feature -o saga.html
Local LLMs (Ollama / LM Studio)
A local/ model runs against any OpenAI-compatible local server, with no API
key. Pull a capable coder model first (ollama pull qwen2.5-coder:14b), then:
saga --model local/qwen2.5-coder:14b --base main --head my-feature
local/ defaults to Ollama's endpoint (http://localhost:11434/v1). Point it
at another server — e.g. LM Studio — with SAGA_LOCAL_BASE_URL:
export SAGA_LOCAL_BASE_URL=http://localhost:1234/v1 # LM Studio
saga --model local/your-loaded-model --base main --head my-feature
Two caveats: saga requires schema-valid JSON output, so use an instruction-tuned model that follows JSON prompting reliably; and the full diff plus a 16k output budget can exceed a small model's context window — prefer larger-context models and expect weaker narration than a frontier hosted model.
Claude Code CLI (no API key)
If you don't have an Anthropic API key but you are logged into the
Claude Code CLI — for example with a Claude
Pro/Max subscription — the claude-cli model routes generation through
claude -p instead of the API, reusing that login:
saga --model claude-cli --base main --head my-feature
saga --model claude-cli/sonnet --base main --head my-feature # pin a model
This shells out to the claude binary (which must be on your PATH and logged
in), constrains its output to saga's schema via --json-schema, and runs it as
a plain transform with no tools. ANTHROPIC_API_KEY and ANTHROPIC_AUTH_TOKEN
are dropped for the subprocess so it uses your Claude Code login rather than
silently billing an API key. It is slower than a direct API call (Claude Code
boots an agent per run) and subject to your subscription's usage limits.
As a Claude Code skill
The skills/ directory contains a Claude Code skill. To install it:
cp -R "$(pwd)/skills" ~/.claude/skills/saga
saga— say "/saga" (or "give me a walkthrough of this branch") to generate a saga. It resolves the base/head refs and runs the tool for you.
Reviewing: comments
The saga page is also a lightweight review surface. Leave three kinds of comments — inline (click a line's number in any chapter's diff), per-file (the "💬 File comment" control in each file header), and one overall review comment (the box on the Wrap up page — reach it with the "Wrap up →" button in any chapter's nav or the card at the end of the chapters list).
Comments live inside the HTML file, in an embedded block that saga serve rewrites
in place. That keeps the file a single portable artifact: you can commit it, email it, or
open it offline, and the comments travel with it and reload every time — no server needed
to read them.
Open through saga serve
Saving comments back into the file needs a local process (a browser can't portably write
to its own file — the File System Access API is Chromium-only, so Safari and Firefox can't).
So an interactive saga run auto-starts a local server and opens the saga through it:
serving at http://127.0.0.1:52345/ — Ctrl-C to stop
On that page, edits autosave into the file within a second (a status pill shows
Saved / Saving… / Reconnecting…), and two buttons appear:
- Publish to GitHub — posts everything as a single pending review via the
ghCLI (inline → line comments, per-file → a note anchored to the file's first changed line, overall → the review body). Nothing is submitted until you review and submit it on GitHub. Requires theghCLI, authenticated. - Copy for agent — copies the comments as JSON for a coding agent to act on.
To serve a saga you generated earlier (or received), point saga serve at it:
saga serve ./saga.html
The server is loopback-only (127.0.0.1), holds no state of its own (the file is the
store), and needs no API key. Stop it with Ctrl-C.
Static mode (no server)
If you open a saga as a bare file:// — double-clicked, emailed, committed — there is no
server, so reading works but drafting is browser-only: a banner appears and the pill
reads Draft (this browser only). Your drafts buffer in that browser's localStorage.
Reopen the file through saga serve before commenting to save into the file and
publish. Drafts made on a bare file:// page live under a different browser origin than
the served page and cannot be recovered by serving later — so serve is the front door.
From the command line / a coding agent
The same publish/read paths are available as commands that read the file's embedded block:
# Post the comments as a single PENDING review (you submit it on GitHub).
saga comments push path/to/saga.html
# Emit the comments as JSON on stdout for a coding agent to act on.
saga comments read path/to/saga.html
Both default to ./saga.html.
How it works
diff.pycomputesgit diff base...head(no checkout) and the commit list — or, given a PR URL, fetches the same diff and metadata from GitHub viagh.model.pysplits the diff into stable-id hunks (h0, h1, …).generate.pysends the labeled diff + commits (+ optional intent) to the chosen model viainstructor, which returns chapters as schema-validated JSON. Coverage is re-validated in code — every hunk must belong to a chapter or generation fails.render.pyreconstructs each chapter's diff and inlines everything into one self-contained HTML file, including an empty comments block (comments_block.py) and a per-filesagaId.serve.pyserves that file on a loopback port derived from thesagaIdand rewrites the comments block in place as you review;comments.pyreads the same block to publish to GitHub or hand comments to an agent.
Not included (yet)
- A GitHub Action to auto-generate saga on PRs.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file saga_cli-0.4.0.tar.gz.
File metadata
- Download URL: saga_cli-0.4.0.tar.gz
- Upload date:
- Size: 543.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
662c0070103f0f151249e7485e93d8fd064eaa97b57acd87fa1690a1e6bbc055
|
|
| MD5 |
07b1e36ed86f2710a35598789cfe5a79
|
|
| BLAKE2b-256 |
3c85a9c067f01be3d2a58c1b09595c63a6fb3cc57f5d94cb1faa8948b966fcdf
|
File details
Details for the file saga_cli-0.4.0-py3-none-any.whl.
File metadata
- Download URL: saga_cli-0.4.0-py3-none-any.whl
- Upload date:
- Size: 53.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5a3a4eb7b53ac7599dc9e1c1865555272cdd64455c8b1bb27e865f27a43bced2
|
|
| MD5 |
f282bbf8b2d7c7672ead250ea99da888
|
|
| BLAKE2b-256 |
690b4d414f23f5f353cdf14623e844f4c16696bc43eab729ea68a637f8991ecb
|