Skip to content

docs

Read the documentation embedded in every fcheap binary. From a file.cheap source checkout, you can also serve and build the VitePress site.

Usage

bash
fcheap docs <subcommand> [flags]

Subcommands

CommandDescription
serveStart a local VitePress dev server (source checkout required)
buildBuild the docs site for production (source checkout required)
previewPreview the built docs site locally (source checkout required)
listList all embedded doc pages
show <page>Print an embedded doc page to stdout
openOpen the online docs site in a browser

Examples

Serve docs locally

bash
fcheap docs serve
fcheap docs serve --port 8080 --open

Build docs for production

bash
fcheap docs build
fcheap docs build --output /tmp/dist

Preview the built docs

bash
fcheap docs build
fcheap docs preview --open

List available doc pages

bash
fcheap docs list
fcheap docs list --json

Read a doc page to stdout

bash
fcheap docs show guide/getting-started
fcheap docs show cli/save
fcheap docs show mcp/overview

Open the online docs site

bash
fcheap docs open

Flags

serve

FlagTypeDefaultDescription
--portint5173Port for the dev server
--openboolfalseOpen browser on start

build

FlagTypeDefaultDescription
--outputstringdocs/.vitepress/distOutput directory

preview

FlagTypeDefaultDescription
--portint4173Port for the preview server
--openboolfalseOpen browser on start

MCP Tool

The fcheap_docs MCP tool provides the read-only embedded subset for AI agents:

ActionDescription
listList all available doc pages
showRead a specific doc page (requires page argument)
siteGet the docs site URL and local serve command
json
{"action": "list"}
{"action": "show", "page": "cli/save"}
{"action": "site"}

Requirements

list, show, and open work from an installed release and do not require Node.js. The Markdown pages are embedded in the binary.

serve, build, and preview require a file.cheap source checkout plus Node.js and npm because the VitePress project and its build dependencies are not bundled in release packages. When node_modules is absent, fcheap runs npm ci from the committed docs/package-lock.json before starting the command.

Released under the MIT License.