Agent skill

Cmux Markdown Viewer Panel

by basicmachines-co in basicmachines-co/basic-memory

Opens markdown files in a formatted cmux panel beside the terminal that re-renders on every change, handy for plans and task lists.

AGPL-3.0Auto-check passedDocuments & Office

Install Cmux Markdown Viewer Panel

skills CLI
$ npx skills add basicmachines-co/basic-memory --skill cmux-markdown -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install basicmachines-co/basic-memory cmux-markdown --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/basicmachines-co/basic-memory.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/cmux-markdown .claude/skills/cmux-markdown && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
cmux-markdown
GitHub stars
4.1k
Used in
2 other repos
Token cost
~527 tokens
SKILL.md length
185 words
Files
4 (incl. references)
Skills in repo
49
Repo updated
First seen
Licence
AGPL-3.0

At a glance

Opens markdown files in a formatted cmux panel beside the terminal that re-renders on every change, handy for plans and task lists.

  • Showing an agent plan or task list in a rendered panel next to the terminal
  • SKILL.md covers Agent usage, Rendering and Deep-dive references
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Watching documentation or a changelog update live as it is edited

What it does

The agent writes a .md file and opens it with cmux markdown open, which splits a panel next to the current terminal. The panel re-renders whenever the file changes on disk, including atomic replacements from editor saves or sed -i. Options place it in a given workspace, surface or window, and relative paths resolve against the working directory with the absolute path printed back.

Agents should write the full file before opening it so the panel never shows a half-written plan, then overwrite or append as work progresses. The viewer renders headings, code blocks, tables, nested lists, blockquotes, links, rules and inline images in light and dark mode. The skill suggests adding a plan-display note to a project's AGENTS.md, and references cover command syntax and live-reload behavior.

When your agent uses it

  • Showing an agent plan or task list in a rendered panel next to the terminal
  • Watching documentation or a changelog update live as it is edited
  • Following notes that another process appends to progressively

Example prompts

  • “Write the migration plan to PLAN.md and open it in cmux.”
  • “Open design.md in a side panel so I can watch it update.”
  • “Add a Plan Display note to AGENTS.md so future plans open in cmux.”

Requirements

  • The cmux terminal app with its markdown command

What it can do on your machine

Read from SKILL.md and the folder at commit 6982cfc. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are bash and markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Cmux Markdown Viewer Panel loads about 527 tokens when it runs, and up to ~1.1k if it reads all its reference files. Until then it costs about 56 tokens; SKILL.md has 185 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~56
When it runs · the whole SKILL.md, loaded when a task matches
~527
With references · SKILL.md plus every file in references/, read only if the agent opens them
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from basicmachines-co/basic-memory at commit 6982cfc, republished under its AGPL-3.0 licence (© basicmachines-co). 185 words, ~527 tokens.

Download SKILL.mdSave it as .claude/skills/cmux-markdown/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
cmux-markdown
description
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).

Markdown Viewer with cmux

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.

bash
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.

Agent usage

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:

markdown
## 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.

Rendering

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.

Deep-dive references

ReferenceWhen to Use
references/commands.mdFull command syntax, options, output shape, panel behavior
references/live-reload.mdFile watching, atomic writes, unavailable-file state, performance

© basicmachines-co, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (references) in .agents/skills/cmux-markdown of basicmachines-co/basic-memory.

  • SKILL.md
  • agents/openai.yaml
  • references/commands.md
  • references/live-reload.md

Open the folder on GitHubat commit 6982cfc

Used in 2 other repositories

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 2 other GitHub owners. This page covers the copy in basicmachines-co/basic-memory, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Cmux Markdown Viewer Panel next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Cmux Markdown Viewer Panel compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Cmux Markdown Viewer Panel this skillbasicmachines-co/basic-memory4.1k2 repos~527Automated safety check: PassAGPL-3.0
Proof Markdown CollaborationEveryInc/compound-engineering-plugin25k—~1.9kAutomated safety check: NotesMIT
Clean Content FetchLeoYeAI/openclaw-master-skills2.2k—~574Automated safety check: PassMIT
X Article Publisherwshuyi/x-article-publisher-skill8682 repos~3.6kAutomated safety check: PassMIT
Markvisgeekplux/markvis1.6k—~786Automated safety check: PassMIT
URL to Markdown Fetcherjoeseesun/qiaomu-markdown-proxy508—~1.4kAutomated safety check: PassMIT

Similar skills

  • Proof Markdown Collaboration

    EveryInc/compound-engineering-plugin

    Publishes, reads, comments on, or edits shared markdown documents through the hosted Proof editor's web API.

    25k GitHub stars~1.9k tokensUpdated today
    Documents & OfficeAuto-check: notes
  • Clean Content Fetch

    LeoYeAI/openclaw-master-skills

    获取干净、可读的网页正文内容,适合现代网页、博客、新闻、公告和微信公众号文章抓取;支持网页正文提取、内容清洗、去噪、Markdown 输出,适用于普通 fetch 效果不佳、页面噪音较多或动态渲染干扰的场景。Clean content fetch for modern web pages, article extraction, WeChat article capture, content…

    2.2k GitHub stars~574 tokensUpdated 2 mo ago
    Documents & OfficeAuto-check passed
  • X Article Publisher

    wshuyi/x-article-publisher-skill

    Publish Markdown articles to X (Twitter) Articles editor with proper formatting.

    868 GitHub starsUsed in 2 repos~3.6k tokens
    Documents & OfficeAuto-check passed
  • Markvis

    geekplux/markvis

    A skill your agent uses when the user wants a chart of numbers in Markdown (bar, line, area, scatter, pie, hist, heatmap, funnel, waterfall, radar, gauge, sankey, treemap, dumbbell, bullet, boxplot…

    1.6k GitHub stars~786 tokensUpdated today
    Documents & OfficeAuto-check passed
  • URL to Markdown Fetcher

    joeseesun/qiaomu-markdown-proxy

    Converts a URL or PDF into clean Markdown, with dedicated routes for WeChat articles, Feishu docs, arXiv papers and login-gated pages, before any summary or rewrite.

    508 GitHub stars~1.4k tokensUpdated 2 mo ago
    Documents & OfficeAuto-check passed
  • React Zmage Integration

    Caldis/react-zmage

    A skill your agent uses when adding the react-zmage React image viewer to an existing React, Next.js, MDX, CMS, markdown, or rich text image surface.

    946 GitHub stars~370 tokensUpdated 4 mo ago
    Documents & OfficeAuto-check passed

More from basicmachines-co/basic-memory

All 49 skills in this repo
  • cmux Settings Editor

    basicmachines-co/basic-memory

    Views, sets, unsets and validates cmux settings in ~/.config/cmux/cmux.json with a helper script that checks keys against the schema.

    4.1k GitHub starsUsed in 1 repo~1.3k tokens
    Auto-check passed
  • cmux Window and Pane Control

    basicmachines-co/basic-memory

    End-user control of cmux topology and routing (windows, workspaces, panes/surfaces, focus, moves, reorder, identify, trigger flash). Use when automation needs…

    4.1k GitHub starsUsed in 2 repos~842 tokens
    Auto-check passed
  • cmux Workspace Scoping

    basicmachines-co/basic-memory

    Keeps agent actions scoped to the cmux workspace and terminal that invoked it, and lays out pane and surface commands that avoid disrupting the user's own focus.

    4.1k GitHub starsUsed in 2 repos~1.7k tokens
    Auto-check passed
  • Basic Memory Repo Images

    basicmachines-co/basic-memory

    Produces PR, changelog and two-week retro images for the Basic Memory repository from evidence in PR bodies, saved to fixed paths under docs/assets/infographics.

    4.1k GitHub stars~2.7k tokensUpdated today
    Auto-check passed
  • Logfire Instrumentation

    basicmachines-co/basic-memory

    Adds Pydantic Logfire tracing, logging and metrics to Python, JavaScript or TypeScript and Rust projects, with the correct setup order and library extras.

    4.1k GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Basic Memory Onboarding

    basicmachines-co/basic-memory

    Guides a newcomer to Basic Memory through designing a personal knowledge system, then teaches its use and sets up their assistant to load it each session.

    4.1k GitHub stars~3.4k tokensUpdated today
    Auto-check passed

Questions about Cmux Markdown Viewer Panel

What does Cmux Markdown Viewer Panel do?

Opens markdown files in a formatted cmux panel beside the terminal that re-renders on every change, handy for plans and task lists. md file and opens it with cmux markdown open, which splits a panel next to the current terminal. The panel re-renders whenever the file changes on disk, including atomic replacements from editor saves or sed -i.

When should I use Cmux Markdown Viewer Panel?

Cmux Markdown Viewer Panel fits situations like: showing an agent plan or task list in a rendered panel next to the terminal; watching documentation or a changelog update live as it is edited; following notes that another process appends to progressively.

How do I install Cmux Markdown Viewer Panel in Claude Code?

Run `npx skills add basicmachines-co/basic-memory --skill cmux-markdown -a claude-code`. Or copy the skill folder (.agents/skills/cmux-markdown in basicmachines-co/basic-memory) into .claude/skills/cmux-markdown in your project. Claude Code loads it when a task matches its description.

How do I install Cmux Markdown Viewer Panel in Codex?

Run `npx skills add basicmachines-co/basic-memory --skill cmux-markdown -a codex`. Or copy the skill folder (.agents/skills/cmux-markdown in basicmachines-co/basic-memory) into .agents/skills/cmux-markdown in your project. Codex loads it when a task matches its description.

Can I use Cmux Markdown Viewer Panel in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add basicmachines-co/basic-memory --skill cmux-markdown -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/cmux-markdown, .gemini/skills/cmux-markdown, .github/skills/cmux-markdown and .opencode/skills/cmux-markdown in your project.

What does Cmux Markdown Viewer Panel need to run?

SKILL.md names no scripts, command-line tools or credentials: Cmux Markdown Viewer Panel is instructions for the agent only. Our summary lists: The cmux terminal app with its markdown command.

Does Cmux Markdown Viewer Panel access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Cmux Markdown Viewer Panel safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Cmux Markdown Viewer Panel use?

Cmux Markdown Viewer Panel is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Cmux Markdown Viewer Panel use?

About 527 tokens (SKILL.md is roughly 2.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 582 tokens, read only when the agent opens those files.

What are the alternatives to Cmux Markdown Viewer Panel?

Skills that share tags, products or a category with Cmux Markdown Viewer Panel: Proof Markdown Collaboration (EveryInc/compound-engineering-plugin, 25k stars), Clean Content Fetch (LeoYeAI/openclaw-master-skills, 2.2k stars), X Article Publisher (wshuyi/x-article-publisher-skill, 868 stars) and Markvis (geekplux/markvis, 1.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Cmux Markdown Viewer Panel?

basicmachines-co (a GitHub organization) maintains it in basicmachines-co/basic-memory, which has 4,107 GitHub stars. The repository holds 49 skills in this directory. The repository was last updated on October 7, 2026.

Source: basicmachines-co/basic-memory on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.