docsxai
v0.2.0
Published
Deterministic screenshot docs for web apps — the batteries-included CLI. Meta-package over @docsxai/engine (the docsxai CLI + library) and @docsxai/viewer (the renderer `docsxai render` spawns).
Maintainers
Readme
docsxai
The batteries-included install of docsxai — deterministic screenshot docs for web apps.
pnpm add -g docsxai # or: npm install -g docsxai
docsxai --helpOne global install gives you the whole CLI surface. This package is a thin meta-package: its bin resolves @docsxai/engine's CLI entry and runs it in-process, and it depends on @docsxai/viewer so the docsxai-viewer bin lands on your path too — docsxai render works out of the box (the engine locates the viewer through its layered resolution: DOCSX_VIEWER_BIN, the installed @docsxai/viewer package, then PATH).
Chromium is a one-shot explicit install — never an install-time lifecycle script:
npx playwright-core install chromiumWhich package do I want?
docsxai(this package) — you want the CLI:init,capture-auth,calibrate,run,render,lint,diff,doctor, … One install, everything wired.@docsxai/engine— you want the library (flow-file parser, deterministic runtime, exporters, backend client) as a dependency. This package re-exports the engine's library surface (import { parseFlowFile } from "docsxai"works), but depending on the engine directly keeps your tree minimal and skips the viewer.
Docs: https://docsxai.com · Source + issues: https://github.com/kalebteccom/docsxai
