Walkthru CLI

Commit registration, wired into git.

The Walkthru CLI installs git hooks that register commits with the API and print the quiz URL returned by the web app.

01 · Overview

What Walkthru does

Walkthru has two surfaces over one data model. The web app visualizes your git history and answers questions about it. The CLI registers commit metadata after commits are created and retries unregistered outgoing commits before push.

02 · Install

Install the CLI

Install globally from npm. Requires Node 20.9+.

bash

npm install -g @walkthru/cli

Stores the token locally so the CLI can register commits with your Walkthru account.

bash

walkthru login

04 · Set up a repo

walkthru init

Run inside a repository. Installs hooks into .git/hooks/post-commit and .git/hooks/pre-push and writes a .walkthru.json config.

bash

cd your-repo
walkthru init

05 · Configuration

.walkthru.json

Lives at the repo root and controls hook registration behavior.

.walkthru.json

{
  "includeDiff": true,
  "maxDiffBytes": 120000
}

includeDiff — include the commit patch in the registration payload.
maxDiffBytes — truncate large diffs before sending them to the API.

06 · Hook flow

What registration looks like

post-commit

$ git commit -m "feat: add retry policy"
[main 4f3a8c2] feat: add retry policy

Walkthru quiz for 4f3a8c2: https://walkthru.dev/...