firstbitelabsllc/claudux

<img src="docs/public/claudux-cover.png" alt="Claudux — Update the docs. Keep your words." width="1280" /

Claudux

Update the docs. Keep your words.

Turn code changes into documentation with Claude Code or Codex. Pin the sections you wrote. Review what changed.

Claudux builds VitePress documentation using the CLI you are logged into. Commit a manifest to choose which sections may change and which must stay byte-for-byte intact. Review the resulting diff before you commit.

Try it with your coding agent · Read the guide · Report a problem

Try it with your coding agent

Clone the repository, open it in Claude Code or Codex, and send this prompt:

Run examples/agent-demo/run.sh. In two bullets, 35 words maximum: state the API change, then whether source, pinned Quick start, and original fixture stayed unchanged.

The helper creates a retained temporary Git project, asks your authenticated configured coding CLI to document the API section, and proves the source, pinned Quick start, and original fixture stayed unchanged. It uses your model allowance. Watch Claude Code run Claudux with Codex or read the example details.

For a deterministic local patcher example with no model call, run:

git clone https://github.com/firstbitelabsllc/claudux.git
cd claudux
python3 examples/demo.py

Reproduce the authenticated capture

Use it in your project

Install with Node 18+ and a Claude Code or Codex CLI you are logged into. Tell your coding agent what changed and what readers need to understand; Claudux uses the authenticated CLI to prepare the bounded documentation patch.

curl -fsSL https://raw.githubusercontent.com/firstbitelabsllc/claudux/main/install.sh | sh
cd your-project
claudux check
claudux update -m "Document the API changes in this branch."
claudux serve

For a complete, committed example where the configured Codex CLI updates an API section while a human paragraph remains pinned, see examples/agent-demo. The command reference below is useful when you need a specific CLI option.

update uses your model allowance. serve opens a local preview. Before your first update, read the manifest guide if you want to protect handwritten sections. Without a manifest, the backend writes documentation directly; it does not infer which paragraphs you meant to keep.