Yggdrasil

The god-tree of your codebase
Flatten any subset of your project into an AI-ready codex — index + contents, in one command.

---

What is Yggdrasil?

Yggdrasil is a project flattener and diff engine. It builds a single, deterministic codex from whatever subset of your codebase you choose:

• A full index of files
• Accurate line counts
• Language-tagged code blocks
• Markdown or plain text output
• Optional rich diff mode
• Optional movement annotations ([MOVED])

Use it for:

• LLM prompts
• Documentation snapshots
• Code reviews
• Reproducible archives
• Project comparisons

Yggdrasil does not guess what you want. You explicitly choose the files — this makes your snapshot deterministic and deeply controllable.

---

How Yggdrasil Selects Files (Critical)

Yggdrasil never prints the entire repo by default. You must specify what to include using any of:

• --only <paths…>
• --show <extensions…>
• --white <manifest>

You may also exclude using:

• --ignore
• --black

Formatting is separate:

• --printed → Markdown (SHOW.md by default)
• --contents --out FILE → explicit output mode

--printed does not select files. It only specifies the output format.

---

Snapshot Examples

These examples are accurate and guaranteed to work because they always include a file-selection flag.

Export all .rs and .md files as Markdown

ygg --show rs md --printed

Export specific files and directories

ygg --only src/main.rs \
        src/scanner \
        src/snapshot/format_selection.rs \
        src/snapshot/writer.rs \
    --printed

Export files listed in a manifest

WHITE.md:

src/lib/model.rs
src/app/main.tsx
README.md

Command:

ygg --white WHITE.md --printed

Use explicit --contents --out

Markdown:

ygg --show py --contents --out PY_SNAPSHOT.md

Plain text:

ygg --show rs --contents --out snapshot.txt

List file paths without contents

ygg --show rs
ygg --show py md txt

Flatten everything under a directory

ygg --only src --printed

---

Interactive Mode

Interactive paste mode is ONLY triggered by --whited.

--white never triggers interactive input.

The --whited Shortcut (Interactive)

--whited enables the fastest workflow:

• launches interactive paste mode
• implies --white
• implies --contents
• writes Markdown to SHOW.md automatically

Run:

ygg --whited

You will see:

Enter WHITE patterns (one per line):
Tip: Paste your paths (e.g., from VS Code → Copy Relative Path).
Finish with Ctrl+D (Linux/macOS) or Ctrl+Z then Enter (Windows).

Paste:

src/main.rs
src/utils/io.rs
README.md

Then Yggdrasil generates SHOW.md automatically.

This is the only flag that triggers interactive paste mode.

---

Diff Mode

Compare directories:

ygg diff src/ -- old_src/

Compare specific files:

ygg diff controller.py -- controller_old.py

Align annotations:

ygg diff --align-tags src/ -- old_src/

Diff features:

• inline diff visualization
• contextual additions/removals
• cross-file movement detection
• [MOVED → file:line] annotations
• optional aligned metadata

---

Installation

Requires Rust:

cargo install yggdrasil-cli

Ensure ~/.cargo/bin is in your path.

Install from local source:

cargo install --path . --force

---

Philosophy

In Norse myth, Yggdrasil is the world-tree unifying realms. This tool unifies your project structure into one portable artifact.

Design principles:

• Explicit over implicit
• Deterministic, repeatable output
• Minimal configuration
• LLM-friendly structure
• Complete control over what’s included

---

Roadmap

Completed (v0.2.4)

• Snapshot export
• Markdown and plain-text modes
• Manifests: --white and interactive --whited
• Blacklists: --ignore, --black
• --only and --show filters
• Diff engine
• Block movement detection
• --align-tags
• --printed

Planned (v0.3 → v1.0)

• Tree-view / flat-view toggle
• Themeable CLI output
• HTML codex export
• Combined codex+diff bundles

---

License

MIT License.