DEV Community

Cover image for The reference, offline
VX
VX

Posted on Edited on Originally published at vznjs.github.io

The reference, offline

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

$ vx docs frozen lock --limit 1
── cli.md § vx lock · https://vznjs.github.io/vx/cli/#vx-lock
…
Enter fullscreen mode Exit fullscreen mode

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 ask You get
vx docs cache inputs how a task's inputs are declared
vx docs exit codes each verb's exit codes
vx docs sandbox allow what 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.


Originally published on the vx blog. vx is open-source (MIT) task orchestration with a build cache: vznjs.github.io/vx · GitHub.

Written with AI assistance.

Top comments (0)

Some comments may only be visible to logged-in visitors. Sign in to view all comments.