cedit user guide

A practical guide to cedit/cli.py, the command line that keeps your local adaptations of vendored Markdown alive across upstream updates. This is the how-to: worked examples, real output, and the flows you will actually run. For the why behind the design, read SPEC.md; for a two-minute overview, README.md.

Every command and every block of output below was run for real — against this repository or a throwaway directory — and pasted unedited.

Contents

Getting started — what cedit is doing, and a first run end to end.

• The mental model
• Prerequisites
• Five-minute tour

Command reference — every subcommand, every flag, with real output.

• The five subcommands
• Global options
• snapshot, diff and sync
• status and resolve
• md — stateless parser views

How it works — what the merge keys on, and why it survives a reflow.

• What cedit sees: blocks, hashes, keys
• The merge matrix in practice
• What alignment buys you
• The .cedit/ state directory

Task flows — the three things you will actually do.

• Vendoring a document
• Taking an upstream update
• A conflict, end to end

Help — the limits, the recipes, and what a message means.

• Limits, stated plainly
• Cookbook
• Troubleshooting
• Appendix

---

New to cedit? Read The mental model, then run the five-minute tour. Everything else is reference you can come back to.