cmdocs

The CLI for cmdocs — a modern documentation platform. Transform docs.json + MDX into a beautiful documentation site, then deploy to decentralized hosting on Walrus Sites (Sui).

Install

npm install -g @cmdoss/cmdocs

Or run directly with npx:

npx @cmdoss/cmdocs init my-docs

Commands

cmdocs init [name]

Scaffold a new documentation project with starter content, configuration, and assets.

cmdocs init my-docs
cd my-docs

cmdocs dev

Start a local development server with hot-reload.

cmdocs dev
cmdocs dev --port 4000
cmdocs dev --source ./docs

cmdocs check

Validate your docs before deploying. Checks docs.json schema, navigation references, MDX frontmatter, and asset paths.

cmdocs check
cmdocs check --source ./docs

Use in CI to catch errors before they hit the build pipeline:

- run: npx @cmdoss/cmdocs check --source ./docs

Deploy

Production builds are handled by the cmdocs Dashboard. Connect your GitHub repo and every push triggers a build automatically.

Decentralized hosting (Walrus Sites)

cmdocs can publish your built site to Walrus Sites — decentralized storage and hosting on the Sui blockchain. Content is stored as blobs on the Walrus network, ownership is recorded in an on-chain site object, and requests are served through Walrus aggregators. Unlike traditional CDN hosting, your docs live on a public, verifiable network with no single point of failure.

Enable it per-project from the Dashboard: pick a storage duration (3–53 epochs), and every deploy writes a new version of the site to Walrus. Storage fees are paid by cmdocs (Enoki-sponsored) on eligible plans — no wallet setup required. Your docs are reachable at <slug>.cmdocs.app (gateway) and through the underlying Walrus site object directly.

Requirements

• Node.js 20+
• Git (optional, for cmdocs init)

Documentation

Full docs at docs.cmdocs.sh

License

See LICENSE