docs

A command that displays a project's README in the terminal, with formatting when used interactively.

In plain words
What is it for?
Use it to view setup and usage instructions, or give a coding agent the project's documentation so it can configure workmux.
Why use it?
It lets developers read project documentation without leaving the terminal or opening another application.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/raine/workmux/docs
Clone the repo
git clone --depth 1 https://github.com/raine/workmux
Per session 6 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 240 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00006 $0.00240
Opus 5 $0.00003 $0.00120
Sonnet 5 $0.00001 $0.00048
Haiku 4.5 $0.00001 $0.00024

Measured yesterday against content hash c8de90fd38fa, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

docs/src/content/docs/reference/commands/docs.md · 36 lines

What it actually says

Displays the README with terminal formatting. Useful for quick reference without leaving the terminal.

workmux docs

When run interactively, renders markdown with colors and uses a pager (less). When piped (e.g., to an LLM), outputs raw markdown for clean context.

Using with AI agents

You can ask an agent to read the docs and configure workmux for you:

> run `workmux docs` and configure workmux so that on the left pane
  there is claude as agent, and on the right side neovim and empty
  shell on top of each other

⏺ Bash(workmux docs)
  ⎿  <p align="center">
       <picture>
     … +923 lines

⏺ Write(.workmux.yaml)
  ⎿  Wrote 9 lines to .workmux.yaml

⏺ Created .workmux.yaml with the layout:
  - Left: claude agent (focused)
  - Right top: neovim
  - Right bottom: empty shell
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 36 lines · 6 tokens per session scan A c8de90fd38fa

Subscribe to this mod's changes

docs is a command published in the GitHub repository raine/workmux (2,284 stars, last pushed 2d ago), licensed MIT. It adds 6 tokens to every session and 240 once invoked, about $0.0000 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.