Skip to content
vxvx
GitHubBlueskydev.toRSS

vx docs

vx docs <query> searches vx’s reference as this version wrote it: every page of packages/vx/docs at this vx’s release tag on GitHub (v<version>; a source checkout reads main), read online each time, so nothing ships inside vx. Each page is cut at its headings; a section that holds every word of the query matches, and a word in its heading ranks it above any count in its text; a one-word query that titles a section, an error code (vx docs VX_E_CYCLE), prints that section alone. The best --limit sections (default 3) print whole, each under its page, heading and URL on the site. --format json prints {query, hits: [{page, heading, url, text}]} (schemas/docs.json). The guides live on the site: https://vznjs.github.io/vx/llms.txt indexes them.

Exit codes: 0 the search ran, a search with no match included (it names the tag searched); 1 a missing query or a bad flag (VX_E_USAGE), or the pages could not be read (VX_E_NETWORK, which names the site).

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