Offline · v0.1

trail

You clone a repo. The README is long or stale. You need a map — what lives where, which scripts matter, where to start. trail scans the top level offline and prints a structured guide. Pairs with thread (changes vs. landing).

Land cold

Top-level dirs, hints, package scripts — in seconds.

Offline

No network. Skips node_modules, .git, dist automatically.

Honest limits

Depth-1 scan v0.1 — teaches structure, not magic understanding.

Map any repo on your machine

$ git clone https://github.com/Ariadne-Dev/trail.git
$ cd trail && pnpm install
$ pnpm dev map ../thread
$ pnpm dev map .                           # current dir
$ pnpm dev map ./my-repo --format markdown --out TRAIL.md

Mapping thread

Real output from trail map ../thread.

Trail: thread
────────────────────────────────────────────────────────

Package: thread
About:   Explain git diffs for learning and review — offline, no API key — Ariadne

DIRECTORIES
  · examples/ — Examples and demos
  · src/ — Source code

SCRIPTS
  build        tsc
  explain      tsx src/cli.ts explain
  dev          tsx src/cli.ts

START HERE
  → `dev` — tsx src/cli.ts
  → `explain` — tsx src/cli.ts explain
  → `build` — tsc

Two threads, two moments

trail when you arrive — unfamiliar codebase, need a map. thread when you review — diff in front of you, need a walkthrough. Both offline. Both teach.

MIT licensed Node 18+ text · markdown · json