# cmux-markdown

Opens Markdown files in a formatted panel beside the terminal and reloads the view when files change. Useful for plans, notes, and docs.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 7500 installs · ★ 28491
- Author: manaflow-ai
- License: GPL-3.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/manaflow-ai/cmux/tree/HEAD/skills/cmux-markdown/SKILL.md
- Updated: 2026-10-25
- HTML: https://affpapa.org/en/nevibecode/skills/cmux-markdown

## What it does

The skill writes or uses a Markdown file and opens it with `cmux markdown open`. Relative paths resolve from the caller’s current directory, `~` expands, and the command returns the resolved absolute path. Each overwrite or append triggers a fresh render.

The viewer handles headings, fenced code, tables, nested lists, blockquotes, links, and images. It supports light and dark modes. Write the complete file before opening it, so the panel does not show a half-written plan. You can also add a rule to `AGENTS.md` so project agents open plans through `cmux`.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add manaflow-ai/cmux --skill cmux-markdown -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/cmux-markdown/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/cmux-markdown/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add manaflow-ai/cmux --skill cmux-markdown -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/cmux-markdown/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add manaflow-ai/cmux --skill cmux-markdown -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/cmux-markdown/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install manaflow-ai/cmux cmux-markdown
```

2. **Manually: put the files in place**
- File: `.github/skills/cmux-markdown/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add manaflow-ai/cmux --skill cmux-markdown -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/manaflow-ai/cmux --path skills/cmux-markdown
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/cmux-markdown/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add manaflow-ai/cmux --skill cmux-markdown -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/manaflow-ai/cmux/tree/HEAD/skills/cmux-markdown/SKILL.md

## When to use it
- open a plan beside the terminal
- render project docs as formatted Markdown
- refresh notes when another process edits them
- show task lists in a side panel

## Example prompts
- Write the plan to `plan.md` and open it beside the current terminal with `cmux`.
- Open `design.md` in a `cmux` panel and keep the view updated as the file changes.
- Show `PLAN.md` in workspace `workspace:2` using `cmux`.

## Similar
- [setup-matt-pocock-skills](https://affpapa.org/en/nevibecode/skills/setup-matt-pocock-skills.md) — skill · 1052851 installs
- [ask-matt](https://affpapa.org/en/nevibecode/skills/ask-matt.md) — skill · 766587 installs
- [to-tickets](https://affpapa.org/en/nevibecode/skills/to-tickets.md) — skill · 711230 installs
- [writing-plans](https://affpapa.org/en/nevibecode/skills/writing-plans.md) — skill · 282859 installs
- [caveman-review](https://affpapa.org/en/nevibecode/skills/caveman-review.md) — skill · 411800 installs
- [caveman-compress](https://affpapa.org/en/nevibecode/skills/caveman-compress.md) — skill · 411500 installs

From the same set: [manaflow-ai/cmux](https://affpapa.org/en/nevibecode/by/manaflow-ai/cmux.md) — 24 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md