Skip to main content

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.

See an example saga.

Requirements

  • Python 3.11+
  • git
  • The gh CLI, 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, or OPENROUTER_API_KEY — or a running local server (Ollama / LM Studio) and no key, with a local/ 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 (on by default; --no-open to disable)

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 two Claude Code skills. To install both:

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.
  • saga-comments — say "/saga-comments" (or "address the saga comments") to read an exported saga.comments.json and act on the reviewer's feedback in code.

Reviewing: comments

The saga page is also a lightweight review surface. Open saga.html and 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 at the top of the Chapters list). Comments are drafted in your browser's localStorage, so they survive a reload.

When you're done, click Export comments to download a saga.comments.json sidecar next to the HTML. (Export is disabled in the hosted example so it never writes a file — every other part of the review UX works.) Two commands consume it:

# Post everything as a single PENDING review on the PR (you submit it on GitHub).
saga comments push --comments saga.comments.json

# Emit the comments as JSON on stdout — for a coding agent to act on.
saga comments read --comments saga.comments.json

push uses the gh CLI: it finds the open PR for the sidecar's branch and creates one pending review (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 the gh CLI, authenticated.

How it works

  1. diff.py computes git diff base...head (no checkout) and the commit list — or, given a PR URL, fetches the same diff and metadata from GitHub via gh.
  2. model.py splits the diff into stable-id hunks (h0, h1, …).
  3. generate.py sends the labeled diff + commits (+ optional intent) to the chosen model via instructor, which returns chapters as schema-validated JSON. Coverage is re-validated in code — every hunk must belong to a chapter or generation fails.
  4. render.py reconstructs each chapter's diff and inlines everything into one self-contained HTML file.

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

saga_cli-0.3.0.tar.gz (523.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

saga_cli-0.3.0-py3-none-any.whl (39.2 kB view details)

Uploaded Python 3

File details

Details for the file saga_cli-0.3.0.tar.gz.

File metadata

  • Download URL: saga_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 523.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for saga_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3e58886171e8f584a82763ccd66beb7b10b369c69624905f307152a9e573e572
MD5 7fa90110ffcb92825db9558fc8c47a0b
BLAKE2b-256 91ca27683e5afad4ce88cfd98936255deda93c51306ac65d1ac63a7147920a22

See more details on using hashes here.

File details

Details for the file saga_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: saga_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 39.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for saga_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1fbdb4986d82bb3b073940f9ab969ec334bc82ca5b0e0e791d0668a061aa7da2
MD5 94320f418dbea60d61b0ba06ed78b269
BLAKE2b-256 38be9d24332b1fe1152e619854aef8e6958d6e3b49a1bf4d705d424ab4fa2183

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page