edamame

A fast Markdown editor and viewer for the terminal.

edamame shows your document rendered with headings, drawn table grids, inline images, and more — while you edit it. Only the line your cursor is on drops to raw Markdown, and it snaps back the moment you move away.

Demo

https://github.com/user-attachments/assets/85e2a303-08d6-4122-9f1f-18975613a127

Installation

Homebrew

brew install mijowi/tap/edamame

Cargo

cargo install edamame

Requires Rust 1.90 or newer.

Prebuilt binaries

Download for your platform from Releases.

From source

git clone https://github.com/mijowi/edamame
cd edamame
cargo build --release
# binary at target/release/edamame

Requires Rust 1.90 or newer.

Documentation

• Getting started — first run, the three view modes, reading the status bar
• Editing — tables, lists, links, footnotes, search, diff review, images, export
• Keybindings — every default chord and how to change it
• Configuration — every setting
• Themes — switching, and writing your own
• Vim mode — what's supported and how it differs from Vim
• Security — what protects you when you open a document you didn't write

Features

• Hybrid rendered/raw editing — the document stays formatted; only the cursor's line shows its source
• Real table editing — tables render as a grid, you edit cell by cell, Tab between cells, drag with the mouse to reorder or resize
• Inline images and Mermaid diagrams on terminals that support them
• Search and replace, with smartcase navigation
• Diff review for external changes — when something else writes your file, accept or reject each change hunk by hunk instead of losing work
• Vim mode, optional — motions, operators, text objects, :s with a live preview
• 27 themes, and a documented format for writing your own
• HTML export, self-contained or linked
• Footnotes, task lists, list continuation and renumbering
• Mouse support, fuzzy command palette, jump-to-heading, navigation history

The hybrid view

The document stays formatted while you work. The cursor's line shows its source, and renders again as soon as you leave it — so list markers, emphasis and links are editable in place without turning the page into syntax.

Tables as grids

Tables are drawn, not printed as pipes. Tab walks the cells, rows and columns can be added or removed in place, and the mouse can drag a divider to resize or a handle to reorder.

Themes

27 built in, and a documented TOML format for writing your own.

Terminal support

edamame runs anywhere, but a few things depend on your terminal:

Where support is missing, edamame adapts rather than breaking — it switches to a 256-color theme, keeps image placeholders, and tells you which chords won't arrive. Every command is reachable from the palette regardless.

Full support in kitty, Ghostty, WezTerm, and foot. Apple Terminal works, with the reduced feature set above. Run edamame --doctor to see what your terminal reports.

Security

edamame is built to open documents you didn't write. Image decoding is bounded against decompression bombs, remote image fetches are consent-gated and filtered against internal addresses, and HTML export strips scripts and unsafe link schemes. Details and the threat model are in docs/security.md.

To report a vulnerability, please use GitHub's private reporting on the Security tab rather than a public issue.

Contributing

Start with CONTRIBUTING.md. For anything non-trivial, please open an issue first — edamame keeps a deliberately narrow scope, so a feature can be well-built and still not fit.

Questions, ideas and anything you're not sure is a bug belong in Discussions.

AGENTS.md is the architecture guide — the module layout, the invariants that are easy to break, and the code style. docs/dev/ holds the design specs.

Please run the following before opening a PR:

cargo fmt
cargo clippy --all-targets --all-features -- -D warnings
cargo test

License

Apache-2.0. See LICENSE.