Skip to content
vxvx
GitHubBlueskydev.toRSS
Blog

The reference, offline

vx docs <query> searches the CLI, config and cache reference that ships inside vx. No network, no site: the sections that match print whole, with their URL.

An agent in a sandbox often cannot reach the docs site. Now the reference travels with vx: vx docs <query> searches it on disk.

Terminal window
$ vx docs frozen lock --limit 1
── cli.md § vx lock · https://vznjs.github.io/vx/cli/#vx-lock
…

It reads seven pages that ship in the npm package and the compiled binary: cli, schema, caching, execution, patterns, security and features. A section matches when it holds every word of the query, and a word in its heading ranks it first. The best three print whole; --limit changes how many.

You askYou get
vx docs cache inputshow a task’s inputs are declared
vx docs exit codeseach verb’s exit codes
vx docs sandbox allowwhat a sandboxed task may touch
vx docs ... --format json{query, hits: [{page, heading, url, text}]}

The JSON shape is schemas/docs.json. The guides stay on the site; llms.txt indexes them. See the CLI reference.

Turborepo, Nx and other product names are trademarks of their owners. vx is not affiliated with or endorsed by them.