Open markdown files in a formatted viewer panel with live reload. Use when you need to display plans, documentation, or notes alongside the terminal with rich rendering (headings, code blocks, tables, lists).
インストールする前に、エージェントに与えられる指示の中身を確認できます。
Write a .md file, open it in a panel, and the panel re-renders whenever the file changes on disk. Use it for agent plans and task lists alongside the terminal, documentation and changelogs while working, and notes another process updates progressively.
cmux markdown open plan.md # split next to the current terminal
cmux markdown open /path/to/PLAN.md
cmux markdown open design.md --workspace workspace:2 # also --surface, --window
Relative paths resolve against the caller's cwd and ~ expands; the resolved absolute path comes back in the output.
Write the full plan file first, then open it, so the panel never shows a partially written file. After that, overwrite or append freely: each write triggers a re-render, and atomic replacement (editor saves, sed -i, VS Code) is handled.
To instruct coding agents in a project, add to its AGENTS.md:
## Plan Display
When creating a plan or task list, write it to a `.md` file and open it in cmux:
cmux markdown open plan.md
The panel renders markdown with rich formatting and auto-updates when the file changes.
Headings h1-h6 (dividers on h1/h2), fenced code blocks in monospace, inline code with a highlighted background, tables with alternating row colors, nested ordered and unordered lists, blockquotes with a left border, bold/italic/strikethrough, clickable links, horizontal rules, and inline images. Light and dark mode both supported.
| Reference | When to Use |
|---|---|
| references/commands.md | Full command syntax, options, output shape, panel behavior |
| references/live-reload.md | File watching, atomic writes, unavailable-file state, performance |
まだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
End-user control of cmux topology and routing (windows, workspaces, panes/surfaces, focus, moves, reorder, identify, trigger flash). Use when automation needs deterministic placement and navigation in a multi-pane cmux layout.
日本語の概要は準備中です。原文の説明を表示しています。
cmux package architecture, refactor layering, dependency inversion, file organization, DocC documentation, package design discipline, testability, and Swift 6 concurrency rules. Use before adding or meaningfully rewriting Swift files, Swift packages, coordinators, services, repositories, or public package APIs.
日本語の概要は準備中です。原文の説明を表示しています。
Backend TypeScript and Cloud VM development rules for cmux. Use when editing web/app/api, web/services, backend scripts, Cloud VM lifecycle, provider integrations, Postgres, Stack Auth pricing gates, migrations, or provider image build scripts.
日本語の概要は準備中です。原文の説明を表示しています。
Stripe checkout, pricing, subscription, Pro plan, webhook, and entitlement runbook for cmux billing work. Use when editing or debugging billing, pricing, Stripe Checkout, subscription recording, Pro plan status, webhooks, entitlement metadata, or pricing dev/prod tooling.
日本語の概要は準備中です。原文の説明を表示しています。
End-user browser automation with cmux. Use when you need to open sites, inspect or interact with browser surfaces, wait for page state, and extract data without stealing focus.
日本語の概要は準備中です。原文の説明を表示しています。
Screenshot or record a cmux window from the CLI, for a pull request, a bug report, or to see what the app actually looks like right now. Use when a change is visual, when a drag or an animation cannot be described in text, or when a reviewer needs evidence rather than a claim.
日本語の概要は準備中です。原文の説明を表示しています。