StackBriefRepository

A reproducible evaluation

Follow the evidence before you judge the claim.

StackBrief is meant to be inspected, not merely described. This page gives you a short local path from repository to canonical model to source-cited pre-change brief.

Run the evaluation Read the source

01 Canonical model`stackbrief.json` is a versioned contract, not generated prose.

02 Source evidenceFindings lead back to files and lines when extraction can prove them.

03 Useful limitsUnknowns remain visible when static analysis cannot establish a fact.

04 Local firstThe core workflow requires no hosted model, account, telemetry, or upload.

The short path

From clone to a brief you can inspect.

Use StackBrief on itself first. The commands below build the typed packages, exercise the automated suite, generate the canonical repository model, and produce a brief around a real implementation file.

  1. 01

    Clone and verify.

    Confirm the source, type checks, CLI behaviour, and package contents before trusting the output.

    $git clone https://github.com/mojeebdev/stackbrief.git
    $cd stackbrief && npm ci && npm test
    $npm run test:package
  2. 02

    Generate the contract.

    Scan the repository. The result is the versioned `stackbrief.json` model that every local intelligence feature uses.

    $node bin/cli.js scan
  3. 03

    Read a pre-change brief.

    Start from a concrete implementation file, not an abstract question about an entire codebase.

    $node bin/cli.js brief --file packages/brief/src/change-brief.ts

What a useful result looks like

A brief should narrow the next decision.

For a selected file, expect the brief to identify what static analysis can establish: relevant routes or service boundaries, reached local files, import dependents, database or external API signals, validation targets, and evidence.

STACKBRIEF: CHANGE-BRIEF.TS

ImpactDirect dependent: change-brief.test.ts

Tracepackages/intelligence/src/index.ts

Validatechange-brief.test.ts

UnknownVerify runtime configuration separately.

↳

A necessary boundary

Static evidence is not runtime certainty.

StackBrief does not execute application code, inspect production traffic, evaluate feature flags, infer authorization rules, or decide whether a change is safe. It marks unresolved evidence as an unknown.

Framework detection is intentionally broader than deep framework-specific extraction today. The Next.js App Router adapter is isolated so equivalent adapters can grow without changing the canonical model.

Use it where the work happens

Try it in a repository you already know.

$npx @blindspotlab/stackbrief scan
$npx @blindspotlab/stackbrief brief --file path/to/a/real/source-file.ts
View the npm package