stringer

module
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Feb 17, 2026 License: MIT

README

Stringer

Stringer

CI Coverage Go Report Card Release OpenSSF Scorecard OpenSSF Best Practices

v1.0.1. Seven collectors with multi-ecosystem vulnerability and dependency health scanning, four output formats, report command, parallel pipeline with signal deduplication, delta scanning, monorepo support (6 workspace types), LLM-powered clustering and priority inference, MCP server for agent integration, interactive stringer init wizard, and CLI config management.

Codebase archaeology for developers and AI agents. Scan any repo for hidden tech debt — TODOs, vulnerabilities, bus-factor risk, stale branches, unhealthy dependencies — and get structured results you can act on immediately.

# Install via Homebrew
brew install davetashner/tap/stringer

# Or install via Go
go install github.com/davetashner/stringer/cmd/stringer@latest

# Get a health report
stringer report .

# Scan for actionable issues
stringer scan . -f markdown

# Or output as JSON for your own tooling
stringer scan . -f json -o signals.json

The Problem

Every codebase accumulates hidden debt. TODOs pile up. Dependencies go stale. One engineer becomes the sole owner of a critical module. A vulnerability lands in a transitive dependency and nobody notices.

This debt is already visible in the code — in comments, git history, dependency manifests, and GitHub issues — but no single tool surfaces all of it. Developers context-switch between grep TODO, dependency audit tools, and GitHub issue searches. AI agents burn inference tokens rediscovering what's already in the repo.

Stringer extracts these signals automatically, scores them by confidence, and outputs structured results in your format of choice — whether that's a markdown summary for a human, JSON for a CI pipeline, tasks for an AI agent, or Beads JSONL for backlog seeding.

Why Stringer?

Real scanning, not just TODO grep. Seven collectors cover vulnerability detection across 7 ecosystems, dependency health across 6 ecosystems, bus-factor analysis, code churn, stale branches, coverage gaps, and GitHub issues — all in a single command. Most of this runs locally with zero network calls.

Works without AI, works better with it. Core scanning is deterministic static analysis — no API keys, no per-request costs. The optional LLM pass adds signal clustering, priority inference, and dependency detection on top. Use --no-llm to skip it entirely.

Output goes where you need it. Markdown for humans, JSON for CI pipelines, tasks for Claude Code agents, or Beads JSONL for backlog seeding. Same scan, different consumers.

What It Does Today

Collectors
  • TODO collector (todos) — Scans source files for TODO, FIXME, HACK, XXX, BUG, and OPTIMIZE comments. Enriched with git blame author and timestamp. Confidence scoring with age-based boosts.
  • Git log collector (gitlog) — Detects reverts, high-churn files, and stale branches from git history.
  • Patterns collector (patterns) — Flags large files and modules with low test coverage ratios.
  • Lottery risk analyzer (lotteryrisk) — Flags directories with low lottery risk (single-author ownership risk) using git blame and commit history with recency weighting.
  • GitHub collector (github) — Imports open issues, pull requests, and actionable review comments from GitHub. With --include-closed, also generates pre-closed signals from merged PRs and closed issues with architectural module context. Requires GITHUB_TOKEN env var.
  • Dependency health collector (dephealth) — Detects archived, deprecated, and stale dependencies across six ecosystems: Go (go.mod), npm (package.json), Rust (Cargo.toml), Java/Maven (pom.xml), C#/.NET (*.csproj), and Python (requirements.txt/pyproject.toml).
  • Vulnerability scanner (vuln) — Detects known CVEs across seven ecosystems via OSV.dev: Go (go.mod), Java/Maven (pom.xml), Java/Gradle (build.gradle/.kts), Rust (Cargo.toml), C#/.NET (*.csproj), Python (requirements.txt/pyproject.toml), and Node.js (package.json). No language toolchains required — only network access to osv.dev. Severity-based confidence scoring from CVSS vectors.
Output Formats
  • Beads JSONL (beads) — Produces JSONL ready for bd import, with deterministic content-based IDs
  • JSON (json) — Raw signals with metadata envelope, TTY-aware pretty/compact output
  • Markdown (markdown) — Human-readable summary grouped by collector with priority distribution
  • Tasks (tasks) — Claude Code task format for direct agent consumption
Pipeline
  • Parallel execution — Collectors run concurrently via errgroup
  • Per-collector error modes — skip, warn (default), or fail
  • Signal deduplication — Content-based SHA-256 hashing merges duplicate signals
  • Beads-aware dedup — When using Beads output, filters signals already tracked in the repo
  • Delta scanning--delta mode tracks state between scans, showing only new/removed/moved signals
  • Pre-closed signals — Generates closed entries from merged PRs, closed issues, and resolved TODOs
  • Dry-run mode — Preview signal counts without producing output
  • Monorepo support — Auto-detects workspaces (go.work, pnpm, npm, lerna, nx, cargo) and scans each independently with --workspace filtering
                       ┌─────────────────────────────────┐
                       │        Target Repository        │
                       └────────────────┬────────────────┘
                                        │
     ┌───────────┬───────────┬──────────┼──────────┬───────────┬──────────┐
     ▼           ▼           ▼          ▼          ▼           ▼          ▼
 ┌───────┐ ┌─────────┐ ┌──────────┐ ┌─────────┐ ┌────────────┐ ┌──────┐ ┌──────┐
 │ TODOs │ │   Git   │ │ Patterns │ │ Lottery │ │   GitHub   │ │ Dep  │ │ Vuln │ (parallel)
 │       │ │   log   │ │          │ │  Risk   │ │ Issues/PRs │ │ Hlth │ │      │
 └───┬───┘ └────┬────┘ └────┬─────┘ └────┬────┘ └─────┬──────┘ └──┬───┘ └──┬───┘
     └───────────┴───────────┴────────────┴────────────┴───────────┴───────┘
                                        ▼
                                 ┌────────────┐
                                 │  Dedup +   │
                                 │ Validation │
                                 └──────┬─────┘
                                        │
                    ┌───────────────────┼────────────┬────────────┐
                    ▼                   ▼            ▼            ▼
               ┌─────────┐       ┌──────────┐ ┌──────────┐ ┌─────────┐
               │  Beads  │       │   JSON   │ │ Markdown │ │  Tasks  │
               │  JSONL  │       │          │ │          │ │         │
               └─────────┘       └──────────┘ └──────────┘ └─────────┘

What to Expect

Output volume depends on codebase size and coding style:

Codebase Approximate signals
Small (<5k LOC) 5-30
Medium (10k-50k LOC) 20-200
Large (100k+ LOC) 100-1,000+

Recommendation: Use --dry-run first to see signal counts, then use --max-issues to cap output on your first scan.

# Preview how many signals exist
stringer scan . --dry-run

# Start with a manageable batch
stringer scan . --max-issues 50 -f markdown

Getting Started

Quick health check
# Get a repo health report — lottery risk, churn, coverage gaps, recommendations
stringer report .
Scan for issues
# 1. Preview signal count
stringer scan . --dry-run

# 2. Scan and review as markdown
stringer scan . -f markdown

# 3. Or save as JSON for programmatic use
stringer scan . -f json -o signals.json

# 4. Focus on security
stringer scan . -c vuln,dephealth -f markdown
Seed a Beads backlog

If you use Beads for agent task tracking, stringer's default output format pipes directly into bd import:

stringer scan . --max-issues 20 | bd import -i -
bd ready --json
Machine-readable dry run
stringer scan . --dry-run --json
{
  "total_signals": 70,
  "collectors": [
    {
      "name": "todos",
      "signals": 70,
      "duration": "303.6685ms"
    }
  ],
  "duration": "303.724958ms",
  "exit_code": 0
}

Example Prompts

You don't need to memorize flags or read docs. Stringer is designed for agents. Copy-paste any of these into Claude Code, Cursor, Windsurf, or your agent of choice.

Bootstrap a new project

Install stringer (brew install davetashner/tap/stringer), then set it up in this repo — run stringer init ., scan the codebase, and give me a summary of what it found. Output as markdown.

Understand a codebase you just inherited

Use stringer to scan this project and tell me what needs attention. I want to know about TODOs, stale branches, security vulnerabilities, and any files where only one person understands the code.

Get a health report

Run stringer report . on this project and walk me through the results. What are the riskiest areas?

Check for security issues

Use stringer to scan this repo for known vulnerabilities and unhealthy dependencies. Prioritize anything with a CVE.

Ongoing maintenance

Run a stringer delta scan (stringer scan . --delta) to find new issues since the last scan. Tell me what changed.

Set up agent integration

Set up stringer's MCP server so you can use it as a tool. Run stringer init . if there's no config yet, then register the MCP server with claude mcp add stringer -- stringer mcp serve.

Scope a scan to what matters

Use stringer to scan only the src/api/ directory for TODOs and code patterns. Skip the git log and GitHub collectors — I just want local code issues. Use stringer scan . --paths src/api/ -c todos,patterns.

Generate agent docs

Use stringer to generate an AGENTS.md for this project (stringer docs . -o AGENTS.md). This will give future agents a map of the codebase.

Usage Reference

stringer scan [path] [flags]
Flag Short Default Description
--collectors -c (all) Comma-separated list of collectors to run
--format -f beads Output format
--output -o stdout Output file path
--dry-run Show signal count without producing output
--delta Only output new signals since last scan
--json Machine-readable output for --dry-run
--max-issues 0 Cap output count (0 = unlimited)
--min-confidence 0 Filter signals below this threshold (0.0-1.0)
--kind Filter by signal kind (comma-separated)
--strict Exit non-zero on any collector failure
--git-depth 0 Max commits to examine (default 1000)
--git-since Only examine commits after this duration (e.g., 90d, 6m)
--exclude -e Glob patterns to exclude from scanning
--exclude-collectors -x Comma-separated list of collectors to skip
--include-closed Include closed/merged issues and PRs from GitHub
--history-depth Filter closed items older than this duration (e.g., 90d)
--anonymize auto Anonymize author names: auto, always, or never
--collector-timeout Per-collector timeout (e.g. 60s, 2m); 0 = no timeout
--paths Restrict scanning to specific files or directories
--include-demo-paths Include demo/example/tutorial paths in noise-prone signals
--infer-priority Use LLM to infer priority from signal context
--infer-deps Use LLM to detect dependencies between signals
--no-llm Skip all LLM passes (clustering, priority, dependencies)
--workspace Scan only named workspace(s) (comma-separated)
--no-workspaces Disable monorepo auto-detection, scan root as single dir

Global flags: --quiet (-q), --verbose (-v), --no-color, --help (-h)

Available collectors: todos, gitlog, patterns, lotteryrisk, github, dephealth, vuln

Available formats: beads, json, markdown, tasks

Configuration File

Place a .stringer.yaml in your repository root to set persistent scan options. CLI flags override config file values.

# .stringer.yaml
output_format: json
max_issues: 50
no_llm: true

collectors:
  todos:
    enabled: true
    error_mode: warn
    min_confidence: 0.5
    include_patterns:
      - "*.go"
      - "*.ts"
    exclude_patterns:
      - vendor/**
      - node_modules/**
  gitlog:
    git_depth: 500
    git_since: 6m
  patterns:
    include_demo_paths: true  # report missing-tests / low-test-ratio in example dirs
  lotteryrisk:
    include_demo_paths: true  # report lottery-risk in example dirs
  github:
    include_closed: true
    history_depth: 90d

Precedence: CLI flags > .stringer.yaml > global config > defaults

Stringer also supports a global config at ~/.config/stringer/config.yaml (or $XDG_CONFIG_HOME/stringer/config.yaml). Repo-level settings override global settings. Use stringer config set --global to manage it.

If no config file exists, stringer uses its built-in defaults (all collectors enabled, beads format, no issue cap).

By default, stringer suppresses noise-prone signals (missing-tests, low-test-ratio, low-lottery-risk) in demo/example/tutorial directories (examples/, tutorials/, demos/, samples/, and variants). Use --include-demo-paths or set include_demo_paths: true per collector to scan these paths.

Other Commands

stringer report

Generates a repository health report with analysis sections for lottery risk, code churn, TODO age distribution, coverage gaps, and actionable recommendations.

stringer report .              # print to stdout
stringer report . -o report.txt # write to file
stringer report . --format json # machine-readable output
stringer report . --sections lottery-risk,churn  # specific sections only
Flag Short Default Description
--collectors -c (all) Comma-separated list of collectors to run
--sections (all) Comma-separated report sections to include
--output -o stdout Output file path
--format -f Output format (json for machine-readable)
--git-depth 0 Max commits to examine (default 1000)
--git-since Only examine commits after this duration (e.g., 90d, 6m)
--anonymize auto Anonymize author names: auto, always, or never
--exclude-collectors -x Comma-separated list of collectors to skip
--collector-timeout Per-collector timeout (e.g. 60s, 2m); 0 = no timeout
--paths Restrict scanning to specific files or directories
--workspace Report only named workspace(s) (comma-separated)

Available sections: lottery-risk, churn, todo-age, coverage, recommendations

stringer docs

Auto-generates an AGENTS.md scaffold from your repository structure, documenting modules, entry points, and conventions for AI agents.

stringer docs .              # print to stdout
stringer docs . -o AGENTS.md # write to file
stringer docs . --update     # update existing AGENTS.md, preserving manual sections
Flag Short Default Description
--output -o stdout Output file path
--update Update existing AGENTS.md, preserving manual sections
stringer context

Generates a compact context summary of the repository for use in AI prompts. Includes project structure, recent git activity, and open work items.

stringer context .
stringer context . --format json  # machine-readable output
stringer context . --weeks 8      # include 8 weeks of history
Flag Short Default Description
--output -o stdout Output file path
--format -f Output format: json or markdown
--weeks 4 Weeks of git history to include
stringer init

Bootstraps stringer in a repository. Detects project characteristics and generates starter configuration. Non-destructive by default — skips files that already exist.

stringer init .          # bootstrap stringer config
stringer init . --force  # overwrite existing .stringer.yaml

When run, stringer init:

  • Creates .stringer.yaml with sensible defaults based on project detection
  • Appends a stringer integration section to AGENTS.md
  • Generates .mcp.json when a .claude/ directory is detected (for MCP server integration)
Flag Short Default Description
--force Overwrite existing .stringer.yaml
stringer config

View and modify stringer configuration from the CLI. Supports dot-notation key paths and both repo-level and global config.

stringer config list                          # show all settings with source
stringer config get output_format             # get a single value
stringer config set output_format json        # set a value in .stringer.yaml
stringer config set collectors.todos.min_confidence 0.8
stringer config set --global no_llm true      # set in global config
Subcommand Description
get <key> Get a config value by dot-notation key path
set <key> <value> Set a config value (auto-detects type)
list List all values with source annotations (repo/global)

Use --global on get/set to target ~/.config/stringer/config.yaml instead of the repo-level .stringer.yaml.

stringer collectors

List and inspect registered collectors.

stringer collectors list         # table of all collectors with status
stringer collectors info todos   # detailed info, signal types, config options
Subcommand Description
list Show all collectors with name, status, and description
info <name> Show detailed info including signal types and config options

Agent Integration

Stringer includes an MCP server so AI agents can call stringer tools directly.

Quick Setup
# Option 1: Auto-detect and configure
stringer init .

# Option 2: Register manually with Claude Code
claude mcp add stringer -- stringer mcp serve
MCP Tools
Tool Description
scan Scan a repository for actionable work items (TODOs, git patterns, code smells)
report Generate a repository health report with metrics and recommendations
context Generate a context summary for agent onboarding
docs Generate or update an AGENTS.md scaffold

See docs/agent-integration.md for detailed usage, parameters, and example workflows.

How Output Works

Confidence Scoring

Each signal gets a confidence score (0.0-1.0) based on keyword severity and age from git blame:

Base scores by keyword:

Keyword Base Score
BUG 0.7
FIXME 0.6
HACK 0.55
TODO 0.5
XXX 0.5
OPTIMIZE 0.4

Age boost from git blame:

  • Older than 1 year: +0.2
  • Older than 6 months: +0.1
  • No blame data or recent: +0.0

Score is capped at 1.0. See DR-004 for the full design rationale.

Priority Mapping

Confidence maps to priority:

Confidence Priority
>= 0.8 P1
>= 0.6 P2
>= 0.4 P3
< 0.4 P4
Content-Based Hashing

Each signal gets a deterministic ID: SHA-256(source + kind + filepath + line + title), truncated to 8 hex characters with a str- prefix (e.g., str-0e4098f9). Re-scanning the same repo produces the same IDs, making output idempotent and preventing duplicates on reimport.

Labels

Every signal is tagged with:

  • The keyword kind (e.g., todo, fixme, hack)
  • stringer-generated — distinguishes stringer output from manually filed issues
  • The collector name (todos)
Sample Output

Given this source file:

// TODO: Add proper CLI argument parsing
// FIXME: This will panic on nil input
// HACK: Temporary workaround until upstream fixes the API

Stringer produces:

{"id":"str-0e4098f9","title":"TODO: Add proper CLI argument parsing","description":"Location: main.go:6","type":"task","priority":3,"status":"open","created_at":"","created_by":"stringer","labels":["todo","stringer-generated","stringer-generated","todos"]}
{"id":"str-11e6af70","title":"FIXME: This will panic on nil input","description":"Location: main.go:9","type":"bug","priority":2,"status":"open","created_at":"","created_by":"stringer","labels":["fixme","stringer-generated","stringer-generated","todos"]}
{"id":"str-3afa7732","title":"HACK: Temporary workaround until upstream fixes the API","description":"Location: main.go:15","type":"chore","priority":3,"status":"open","created_at":"","created_by":"stringer","labels":["hack","stringer-generated","stringer-generated","todos"]}

The type field is derived from keyword: bug/fixme -> bug, todo -> task, hack/xxx/optimize -> chore.

Exit Codes

Code Name Meaning
0 OK All collectors succeeded
1 Invalid Args Invalid arguments or bad path
2 Partial Failure Some collectors failed, partial output written
3 Total Failure No output produced

Current Limitations

  • Line-sensitive hashing. Moving a TODO to a different line changes its signal ID. Delta scanning (--delta) detects moved signals but downstream consumers may see them as new.

Roadmap

Planned for future releases:

  • Additional language support — Expand test detection heuristics to more ecosystems (PHP, Swift, Scala, Elixir)
  • Stable signal IDs — Content-based hashing that survives line moves within a file

Design Principles

Read-only. Stringer never modifies the target repository. It reads files and git history, writes output to stdout or a file.

Composable collectors. Each collector is independent, testable, and implements one Go interface. Adding a new signal source means implementing Collector with Name() and Collect() methods.

LLM-optional. Core scanning works without API keys. The LLM pass adds signal clustering, priority inference, and dependency detection but is never required. Use --no-llm to skip it entirely.

Idempotent. Running stringer twice on the same repo produces the same output. Content-based hashing ensures deterministic IDs.

Format-agnostic. The same scan pipeline feeds every output format. Beads JSONL, JSON, Markdown, and Tasks all render the same signal data — pick the format that fits your workflow.

Requirements

  • Go 1.24+ (for building from source)
  • Git (for blame enrichment and git log analysis)
  • GITHUB_TOKEN env var (optional — only needed for the GitHub collector)
  • bd CLI (optional — only needed for Beads JSONL import)

Contributing

See CONTRIBUTING.md for development setup, workflow, and guidelines. See AGENTS.md for architecture details and the collector interface. This project uses Beads for task tracking — run bd ready --json to find open work.

License

MIT

Directories

Path Synopsis
cmd
stringer command
internal
analysis
Package analysis provides LLM-powered signal clustering and bead generation.
Package analysis provides LLM-powered signal clustering and bead generation.
bootstrap
Package bootstrap implements the `stringer init` command, which detects repository characteristics and generates a starter configuration.
Package bootstrap implements the `stringer init` command, which detects repository characteristics and generates a starter configuration.
collector
Package collector defines the Collector interface and a registry for managing available collectors.
Package collector defines the Collector interface and a registry for managing available collectors.
collectors
Package collectors provides signal extraction modules for stringer.
Package collectors provides signal extraction modules for stringer.
config
Package config handles .stringer.yaml configuration files.
Package config handles .stringer.yaml configuration files.
context
Package context provides CONTEXT.md generation for agent onboarding.
Package context provides CONTEXT.md generation for agent onboarding.
gitcli
Package gitcli provides native git CLI execution for blame operations.
Package gitcli provides native git CLI execution for blame operations.
llm
Package llm provides a provider-agnostic LLM client interface and implementations for use by stringer's analysis features.
Package llm provides a provider-agnostic LLM client interface and implementations for use by stringer's analysis features.
log
Package log configures structured logging for stringer using log/slog.
Package log configures structured logging for stringer using log/slog.
mcpserver
Package mcpserver implements an MCP (Model Context Protocol) server that exposes stringer's core operations as tools over stdio transport.
Package mcpserver implements an MCP (Model Context Protocol) server that exposes stringer's core operations as tools over stdio transport.
output
Package output defines the OutputFormatter interface for writing scan results in various formats.
Package output defines the OutputFormatter interface for writing scan results in various formats.
pipeline
Package pipeline provides the scan orchestration engine for stringer.
Package pipeline provides the scan orchestration engine for stringer.
redact
Package redact provides utilities to strip sensitive values from strings before they appear in output, logs, or error messages.
Package redact provides utilities to strip sensitive values from strings before they appear in output, logs, or error messages.
report
Package report provides a pluggable section registry for stringer report.
Package report provides a pluggable section registry for stringer report.
signal
Package signal defines the core domain types for stringer.
Package signal defines the core domain types for stringer.
state
Package state manages persisted scan state for delta scanning.
Package state manages persisted scan state for delta scanning.
testable
Package testable provides interfaces for mocking external dependencies such as exec.Command and exec.LookPath in tests.
Package testable provides interfaces for mocking external dependencies such as exec.Command and exec.LookPath in tests.
validate
Package validate provides JSONL validation against the bd import schema.
Package validate provides JSONL validation against the bd import schema.
workspace
Package workspace detects monorepo structures and enumerates their workspaces.
Package workspace detects monorepo structures and enumerates their workspaces.

Jump to

Keyboard shortcuts

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