truthboard

module
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 3, 2026 License: MIT

README

Truthboard

Your repo already knows the status. Stop typing it twice.

Truthboard is a git-native tracker with one rule: status is derived from repo reality, never typed by hand. Humans and AI agents write down intent once — a small markdown spec — and the board, drift report, and stakeholder digest are computed from branches, merges, and commit trailers. On repos with no specs it runs as a pure read-only auditor, and either way it can check your existing tracker's claims against what the repo proves.

What it looks like

Every status on this board was computed, not typed. Apple Pay support is in progress because a branch carrying its id has commits; One-page checkout flow is done because its work landed on main — the card's evidence line says so. Cards carry the story's intent: priority, points, bug/task type badges, epic and sprint tags, and the owner's avatar. The filter row totals points per epic, and the sprint panel is pure arithmetic plus a date window: s12 · 1/3 done · 5/10 pts · 2026-07-14 → 2026-07-25 · active, 8d left — nothing there can be edited, because none of it is an opinion.

A story opens into its intent — goal and Given/When/Then acceptance, where checking a box records human sign-off, deliberately separate from delivery — followed by the derived truth panel: the status, the commit that landed it, and every signal that links work to this spec. The promise is editable; the proof is not.

Install

curl -fsSL https://raw.githubusercontent.com/emmanuel-D/truthboard/main/install.sh | sh

The script picks the right build for your platform (macOS/Linux, amd64/arm64), verifies it against the release checksums, and installs to /usr/local/bin or ~/.local/bin — no sudo. Homebrew works too:

brew install emmanuel-D/truthboard/truthboard

Or grab a tarball from Releases yourself (Windows lives there), or build from source:

go install github.com/emmanuel-D/truthboard/cmd/truthboard@latest

Single static binary; the only runtime dependency is git. Optional: gh/glab for tracker claims, npm for package scripts.

Stay current with truthboard update (--check to only look): it verifies the download against the release checksums and swaps the binary atomically. Detached boards keep running the old binary until you truthboard stop && truthboard ui --detach — the board's footer shows which version is serving it.

Quick start in an existing project

cd your-project
truthboard init --agents --hooks   # specs + MCP + AGENTS.md + trailer nudge
truthboard ui --detach             # the board, running in the background

That's the whole setup. Write your first story (truthboard spec new or the board's + New story), work on a branch containing its id, and the card moves itself. In npm projects, init also wires npm run board, board:status, board:stop, and board:audit.

Spec mode — the tracker

truthboard init                             # opt in: creates .truthboard/specs/
truthboard spec new "Add email verification" --owner emmanuel
truthboard brief tb-4f2a                    # context packet for an AI agent (or a human)
truthboard next                             # highest-priority planned story, as a brief —
                                            # "start the next story" is one deterministic call
truthboard audit                            # spec board + drift + digest, all derived
truthboard link tb-4f2a "hotfix/*"          # fix a linking miss — fixes the input, never the status

A spec is one markdown file (YAML frontmatter + Goal/Acceptance body), versioned with your code. Backlog structure is intent too:

  • epic groups stories, priority (1/2/3) orders them, type marks a story, bug, or task (badges and filters follow), and points is an optional estimate — sprint and epic rollups then count points done vs planned, with unestimated stories counted distinctly, never as zero.
  • sprint (e.g. --sprint s12) puts a story in an iteration; the audit, reports, and board show a per-sprint rollup (done/total, points, what's still open). Give a sprint a calendar window with an intent file — .truthboard/sprints/s12.md with start:/end: dates — and its future/active/completed state and days remaining are derived from the dates. There is still no sprint status to set: a sprint finishes when its stories land.
  • needs: [tb-1a2b] declares prerequisites. Readiness is derived: a story whose needs haven't all landed is waiting (shown on every surface), truthboard next skips it, and a dependency cycle is a loud drift finding, never a silent skip.
  • hold: is why work is paused, in one human sentence — "waiting on legal sign-off". Git can prove work stopped; it can never prove why, so this is the one field a person writes that no history would produce. It is intent, not a status: the story stays exactly as stalled or planned as git says it is. And git is allowed to argue back — a hold on work that has landed, or on work with fresh commits, is reported as contradicted everywhere the note appears and lands in the drift report. A reason can be wrong; it cannot be wrong silently. Clearing one is deleting the line — there is no "unhold".

Linking signals, strongest first: a Spec: tb-4f2a commit trailer, the id in a branch name, the spec's branch glob. Derived statuses: planned → in-progress → in-review → done (plus stalled), and a done spec loudly becomes regressed when its landed work is reverted or CI goes red on the landing commit — without CI data the tool says nothing rather than guessing. There is no command to set a status — that's the product.

MCP — agents as first-class citizens

truthboard mcp serves the spec layer over the Model Context Protocol (stdio, JSON-RPC 2.0), so agents stop shelling out. There is nothing Claude-specific in it: any MCP-capable client works — Claude Code is one of them, not the requirement. truthboard adopt registers the server in both committed config files — .mcp.json (Claude Code, and the shape Cursor and friends read) and .vscode/mcp.json (VS Code, and so GitHub Copilot) — so the two most common editors are wired by the same command. Other tools want the same one-liner in their own config:

# Claude Code
claude mcp add truthboard -- truthboard mcp
// GitHub Copilot / VS Code — .vscode/mcp.json (written by init --agents)
// Note the key: VS Code spells it "servers", not "mcpServers".
{ "servers": { "truthboard": { "type": "stdio", "command": "truthboard", "args": ["mcp"] } } }
// Cursor — .cursor/mcp.json
{ "mcpServers": { "truthboard": { "command": "truthboard", "args": ["mcp"] } } }
# Codex CLI — ~/.codex/config.toml
[mcp_servers.truthboard]
command = "truthboard"
args = ["mcp"]
// Gemini CLI — .gemini/settings.json
{ "mcpServers": { "truthboard": { "command": "truthboard", "args": ["mcp"] } } }

The server takes an optional repository — truthboard mcp [repo] — and this is the one command where that argument earns its keep, because an MCP server runs in the directory its client chose. When the hub lives in a subdirectory (the init --workspace layout) and agents are launched from the workspace parent, point the server at it:

{ "mcpServers": { "truthboard": { "command": "truthboard", "args": ["mcp", "./hub"] } } }

A relative path keeps the file portable — it is committed and shared, so this machine's absolute paths do not belong in it. A path that is not a git repository fails at startup with the same message every other command gives, instead of starting and refusing every tool call afterwards.

The working agreement travels the same way: it lives in AGENTS.md, the cross-tool convention that Copilot, Codex, Cursor, Gemini CLI and friends already read — CLAUDE.md exists only to import it for Claude Code. Point your tool at the server and the agreement is already there.

Two things are worth knowing about Copilot's server-side coding agent (the one that opens PRs from github.com, as opposed to Copilot in your editor). Its MCP servers are configured in the repository's settings on GitHub, not in a committed file, so no local command can wire it for you. And its commits are made on GitHub's infrastructure, where your local commit-msg hook never runs — the trailer nudge simply won't fire. Neither costs you the board: give the agent a branch whose name carries the spec id and the work links anyway. That fallback is the reason linking has three signals instead of one.

Tools: list_specs, get_brief (the context packet to start work), next_spec (the highest-priority startable story — an idle agent needs no human to pick, and is never handed a story whose dependencies haven't landed), create_spec, update_spec, get_board. Deliberately absent: any tool that sets a status — an agent's work shows up on the board the same way a human's does, through commits with the spec trailer.

Sprint planning and the stakeholder summary

Two commands cover the two meetings, and neither needs an API key:

truthboard summary            # what we delivered, what is paused and why
truthboard summary s12 --ids  # one sprint, with story ids for looking things up

summary is written for the person who does not read git. No branch names, no story ids, and none of the derived-status words — a story was delivered, not "done"; it is paused, not "stalled". Every paused story carries a reason, and the reason is whichever source has the most standing: a hold: note, else the title of the story blocking it, else how long it has been untouched. A hold the evidence has already contradicted is never repeated as though it were current. Nothing here calls a model — it is arithmetic the audit already did, so a stakeholder never needs an account to learn what shipped.

The planning side is derived the same way. truthboard audit --format json carries a plan object — what rolls over from the closing sprint with each story's derived status, what is already committed, ready versus blocked candidates in backlog order with their blockers named, and the committed points against what the last sprint actually landed. That reference is one prior sprint and says so: Truthboard keeps no velocity history and will not project one. truthboard plan (below) only turns those same numbers into prose.

Terminal board — the same truth, no browser

truthboard board

A read-only Bubbletea TUI: kanban columns, arrow/vim navigation, enter for a story's goal and acceptance, e/s/a to cycle epic, sprint, and owner filters, d/g for the drift report and digest. Refreshes itself; q quits. No keybinding writes anything, because there is nothing to set.

LLM assist — optional, explicit, never a source of truth

With ANTHROPIC_API_KEY (Anthropic API) or OLLAMA_HOST (local Ollama) set — TRUTHBOARD_LLM_MODEL overrides the model — three commands light up:

truthboard draft "usage-based billing for teams"   # concept → epic of real stories
truthboard review s12                              # narrated sprint review
truthboard plan s13                                # narrated sprint planning summary

draft writes fully-formed specs (goal + Given/When/Then acceptance) through the same files a human would edit, and refuses placeholder stories. review narrates a sprint — or the whole digest window — strictly from derived facts: the LLM is a writer, never a source. Nothing calls a model unless one of these three commands is explicitly invoked.

plan is the other end of the sprint boundary: what rolls over from the sprint that is closing, what is already committed to the next one, which unsprinted stories are ready and which are blocked (naming the needs: ids that block them), and the committed points against what the last sprint actually landed. Omit the slug and it targets the next dated sprint that has not started. The load reference is one prior sprint and says so — Truthboard keeps no velocity history and will not project one.

The same numbers are in truthboard audit --format json under plan, so the planning summary is reproducible with no API key at all; the LLM only turns it into prose.

Web board — for the people who used to ask "what's the status?"

truthboard ui              # opens http://127.0.0.1:1337, auto-refreshing
truthboard ui --forge      # include tracker claims (slower refresh)
truthboard ui --detach     # keep it running in the background
truthboard ui --fetch 60s  # poll origin so the board tracks the remote
truthboard ui --notify <url>  # post stalled/regressed transitions to a webhook
truthboard status          # is a board running for this repo?
truthboard stop            # stop the detached board

Below the kanban the board carries the same two views the commands above print: Where things stand — delivered, being worked on, paused with reasons, not started — and The sprint about to start, with what rolls over, what is committed, ready versus blocked candidates, and the load against what the last sprint landed. Both are rendered from data already on /api/board, so a shared board shows them to everyone who opens the URL with nothing to run and no key to hold.

Detached boards are per-repo: state lives inside .git/ (never committed), no system services, no root.

In npm projects, truthboard init also wires these as package scripts — npm run board, board:status, board:stop, board:audit — via npm pkg set, never touching your existing scripts.

A live page rendering the spec board, branches, drift, and digest — and where POs create and refine stories: click a card to edit its title, goal, acceptance, epic, and priority. The promise is editable; the proof is not: intent edits write the markdown spec files (a plain git diff, with an uncommitted-changes nudge on the page), while statuses stay computed with no route by which anything could set one. The page ships as embedded static assets via go:embed — still one binary, no build step.

The one thing the board deletes is a spent branch. Every branch it reports carries the refs it still has (local, origin) and a retire button: two confirmations, then the local ref, the ref on origin, or both. A branch whose commits are not in the integration branch is refused, naming what would be lost, until you override it deliberately — and the integration branch and the checked-out branch are never deletable at all. Statuses do not move: they are derived from the merge, which stays where it landed.

With --notify (or TRUTHBOARD_NOTIFY_URL), the board also tells people when the truth changes for the worse: a story transitioning into stalled or regressed — or recovering back out — posts one Slack-compatible message carrying the audit's evidence line. First sight is baseline, steady state is silent, and the seen-state lives in .git/ per clone.

Multi-machine: a board that tracks the remote

The board derives everything from the local clone, so by default it is only as fresh as your last git fetch. When the machine showing the board is not the machine doing the work — a PO's laptop, a shared box — add --fetch:

truthboard ui --detach --fetch 60s

Remote-tracking refs refresh unconditionally, so branch statuses, drift, and the digest track the remote with no local git use. Spec files are intent and live in the working tree, so the checkout is fast-forwarded only when it is clean and on the integration branch — uncommitted work is never touched, and the page says loudly when refs are fresh but story files are not (or when fetching fails).

To give the whole team one URL, bind beyond loopback:

truthboard ui --detach --fetch 60s --host 0.0.0.0 --no-open

A board served beyond loopback is read-only by default: it shows the truth; intent editing stays a same-machine (clone) privilege. To write stories from anywhere — a phone on the road — arm an edit token (--edit-token / TRUTHBOARD_EDIT_TOKEN): writes carrying the token are committed to the server's clone and pushed to origin by the board itself, so git pull && truthboard next (or an agent's next_spec) picks them up at home. The token opens the promise, never the proof — statuses stay derived. truthboard status reports the fetch interval and shared host.

For a board that updates the moment work lands instead of on the next poll, arm the push webhook: --webhook-secret <secret> (or TRUTHBOARD_WEBHOOK_SECRET) enables POST /webhook — point a GitHub (HMAC signature) or GitLab (X-Gitlab-Token) push webhook at it and a push triggers an immediate fetch + re-derive, with open browsers updating instantly over server-sent events. Bad or missing secrets are rejected in constant time and logged; the endpoint can only make the board fresher, never change what it says.

To put a board like this on a real server — EC2 or any VPS under systemd, Docker (the repo ships a Dockerfile), or a PaaS like Coolify — follow docs/deploy.md.

Multi-repo: one board over N repositories

When a project spans several repos, one of them (or a dedicated planning repo) becomes the hub: it carries .truthboard/ — every spec, plus a workspace manifest listing the other repos:

# .truthboard/workspace.yml
repos:
  api:
    remote: git@github.com:acme/api.git
    integration: main
  web:
    remote: git@github.com:acme/web.git

Intent lives in the hub; proof is gathered from every declared spoke. The board server mirror-clones and fetch-syncs each spoke, branches render as api:feature/tb-1234-…, and a Spec: trailer landing on a spoke's integration branch flips the story to done exactly like a hub landing — while active work in any repo outranks a landing in another. A spoke the audit cannot see is a loud finding, never a silent omission.

A story that must land in several repos declares it — repos: [api, web] (hub names the hub itself) — and is done only when the trailer landed in every one, with per-repo evidence in the meantime: api ✓ landed · web — no branch yet. A revert in any declared repo regresses it. Details in docs/multi-repo.md.

Audit mode — works on any repo, no specs needed

truthboard audit ~/dev/some-repo  # board + drift + digest from git alone
truthboard audit --format md      # markdown (for a weekly drift issue)
truthboard audit --format json    # machine-readable (for CI/automation)

What it reports:

  • Derived board — every non-integration branch classified as in-review, in-progress, stalled, or done (merge detected by ancestry or patch-equivalence, so squash/rebase merges are caught).
  • Drift — stale promises (work that stopped without landing), shadow work (commits that bypassed any branch/MR flow), zombie branches (landed but never deleted), and a misconfigured remote default branch if it spots one.
  • Claims vs proof — when the repo is on GitHub and gh is available, the tracker's claims are checked against the repo: assigned tickets with no matching activity, tickets whose fix already landed but are still open, branches with no ticket and no PR, PRs closed without merging. Unassigned open issues are backlog, not claims — they are never flagged.
  • Digest — what actually landed recently, readable by a non-developer.

Git evidence always outranks tracker claims: enrichment can upgrade a branch to in-review, but nothing a tracker says can un-merge a merged branch.

GitHub Action

Maintain a recurring drift-report issue, updated in place on a schedule:

name: Truthboard
on:
  schedule:
    - cron: '0 8 * * 1'
  workflow_dispatch:
permissions:
  contents: read
  issues: write
  pull-requests: read
jobs:
  drift:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # full history — the audit reads branch/merge topology
      - uses: emmanuel-D/truthboard@main

Inputs: stale-days (default 7), digest-days (default 14), issue-title (default "Truthboard drift report"), github-token (defaults to the workflow token). The action never blocks, labels, or closes anything.

Build

go build ./cmd/truthboard
go test ./...

Single static binary, no runtime dependencies beyond git itself.

License

MIT — see LICENSE.

Status

v0.11.0 is the current release (retire spent branches, truthboard mcp pointed at a directory, Copilot wiring). Landed on main and shipping with the next tag: the sprint-planning half of the boundary (truthboard plan and the board's planning panel), hold: reasons that git contradicts when it disagrees, and truthboard summary — the plain-language view for stakeholders. Check Releases for what is actually published; this section describes intent, the tags describe fact.

Built as the CONCEPT-V1.md spec-driven tracker on the CONCEPT-V2.md audit engine; the inference logic was validated at 100% done-vs-not-done accuracy against GitHub PR state on real repos before being ported to Go (CONCEPT-V1 §11). Truthboard tracks its own roadmap in .truthboard/specs/ — run truthboard audit on this repo to see the board this README describes, derived live.

Directories

Path Synopsis
cmd
truthboard command
Command truthboard audits a git repository: it derives work-unit statuses, a drift report, and a digest from repo reality — read-only, never asking a human for status.
Command truthboard audits a git repository: it derives work-unit statuses, a drift report, and a digest from repo reality — read-only, never asking a human for status.
internal
adopt
Package adopt wires a repository so AI agents route their work through Truthboard by default: MCP registration, a standing working agreement, and an optional commit-msg nudge.
Package adopt wires a repository so AI agents route their work through Truthboard by default: MCP registration, a standing working agreement, and an optional commit-msg nudge.
audit
Package audit derives work-unit statuses, a drift report, and a digest from git history alone.
Package audit derives work-unit statuses, a drift report, and a digest from git history alone.
forge
Package forge fetches tracker claims (issues, PRs) from a forge via its CLI.
Package forge fetches tracker claims (issues, PRs) from a forge via its CLI.
gitrepo
Package gitrepo is a thin runner for git plumbing commands against a repository path.
Package gitrepo is a thin runner for git plumbing commands against a repository path.
lifecycle
Package lifecycle manages the detached board process for a repo: start in the background, report status, stop.
Package lifecycle manages the detached board process for a repo: start in the background, report status, stop.
llm
Package llm gives the binary two optional LLM-backed workflows — drafting a backlog from a concept and narrating a sprint review — without pulling in any SDK.
Package llm gives the binary two optional LLM-backed workflows — drafting a backlog from a concept and narrating a sprint review — without pulling in any SDK.
mcp
Package mcp exposes the spec layer over the Model Context Protocol (stdio transport, newline-delimited JSON-RPC 2.0) so agents like Claude Code stop shelling out.
Package mcp exposes the spec layer over the Model Context Protocol (stdio transport, newline-delimited JSON-RPC 2.0) so agents like Claude Code stop shelling out.
report
Package report renders an audit.Result for humans (terminal), for the weekly drift issue (markdown), and for automation (json).
Package report renders an audit.Result for humans (terminal), for the weekly drift issue (markdown), and for automation (json).
selfupdate
Package selfupdate replaces the running truthboard binary with the latest GitHub release.
Package selfupdate replaces the running truthboard binary with the latest GitHub release.
spec
Package spec implements the intent layer from CONCEPT-V1: one markdown file per unit of work in .truthboard/specs/, YAML frontmatter + free-form body.
Package spec implements the intent layer from CONCEPT-V1: one markdown file per unit of work in .truthboard/specs/, YAML frontmatter + free-form body.
tui
Package tui renders the derived board as an interactive terminal dashboard (Bubbletea).
Package tui renders the derived board as an interactive terminal dashboard (Bubbletea).
web
Branch cleanup is the second deliberate exception to this server's read-only doctrine (the sync loop is the first), and the only one that deletes anything.
Branch cleanup is the second deliberate exception to this server's read-only doctrine (the sync loop is the first), and the only one that deletes anything.
workspace
Package workspace reads the multi-repo manifest: intent lives in one hub repo (the one carrying .truthboard/), and proof is gathered from the spoke repos declared in .truthboard/workspace.yml.
Package workspace reads the multi-repo manifest: intent lives in one hub repo (the one carrying .truthboard/), and proof is gathered from the spoke repos declared in .truthboard/workspace.yml.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL