Write readable docs.
Run interactive commands.
go install github.com/cheatmd-dev/cheatmd/cmd/cheatmd@latest curl -fsSL cheatmd.dev/install.sh | sh 
Terminal-first executable documentation
cheatmd is a lightweight developer productivity utility that parses plaintext Markdown documents to enable interactive searching, filtering, and execution of standard command-line snippets directly in terminal environments.
Interactive Runbooks
Convert complex deployment guides, team runbooks, and wiki pages into interactive, runnable scripts that eliminate dangerous copy-paste errors.
DevOps & Cloud Automation
Consolidate long cloud management commands, database migrations, container deployments, and build scripts into single, fuzzy-searchable selections.
Developer Onboarding
Accelerate engineer setup processes by making workspace configurations, tool prerequisites, environment variables, and linting rules interactive and self-documenting.
Built for the terminal
Plain-text source, modern terminal ergonomics.
Write in Markdown
Any heading with a code block is a cheat. No schemas, no databases, just files you can read, diff, and share.
Fuzzy search & frecency
Search titles, commands, tags, and descriptions. Frequently-used cheats float to the top automatically.
Shell-expanded variables
Variables evaluate live in your shell and present a scrollable picker, with prompt fallback.
Linting & DSL checks
cheatmd --lint catches syntax errors, broken imports, and undeclared variables before they run.
Reusable modules
Define variables and selectors once, import them anywhere. Keep cheatsheets DRY across files.
Metadata portability
Dump cheats to JSON or CSV with cheatmd dump. Pipe into your search, indexes, or tooling.
Fits your workspace
Run it as a floating pane, tmux overlay, or shell keybinding.
Zellij Floating Pane Mode
Launches CheatMD in a floating terminal overlay on top of your current layouts. Pressing Enter auto-injects the resolved command directly into your active workspace.
bind "Ctrl n" {
Run "sh" "-c" "content=$(cheatmd --print); zellij action toggle-floating-panes; zellij action write-chars \\"$content\\"" {
floating true
close_on_exit true
};
}Tmux Split-Pane Mode
Pops CheatMD open inside a fast sidebar split pane. Selecting a command will load tmux's paste buffers and insert the output directly into the adjacent pane.
bind-key -n C-n split-window "$SHELL --login -i -c 'cheatmd --print | tr -d \"\\r\\n\" | tmux load-buffer -b tmp - ; tmux paste-buffer -t {last} -b tmp -d'"Bash & Zsh Readline Widget
Simply evaluate the widget inside your shell startup script to unlock instant `Ctrl+G` selections.
eval "$(cheatmd widget $SHELL)"Run cheats where you write them
Editor integrations bring CheatMD linting, completion, and execution into your daily notes and code.
Read the wiki
Configuration, DSL, modules, and recipes. It is all in the wiki.
Heading structure, code blocks, and DSL metadata.
Interactive prompts, shell evaluation, and literal forms.
--header, --column, and --map configurations.
Flexible branching using if / fi conditions.
Export and import variables across files.
Multi-step workflows executed sequentially.
Prompt widgets, tmux, and Zellij overlays.
Import navi, tldr, and cheat collections.
Copy-pasteable cheatsheets to start from.