Skip to content

Screenshot docs that never go stale

docsxai

Screenshot docs that never go stale. Write a flow once, and docsxai rebuilds every screenshot from your running app on each release, byte for byte, with no agent in the run.

npm install -g docsxai@next

Needs Node 26 or newer.

What it makes

The same screenshot of the trackxai Progress page twice. The copy labelled raw is the plain capture. The copy labelled burned adds violet halos and numbered badges and, on wider screens, three callouts joined to their targets by thin lines: the bar splits every task by phase, open tasks group by epic, and a question waiting on you shows up in the task's timeline.The same screenshot of the trackxai Progress page twice. The copy labelled raw is the plain capture. The copy labelled burned adds violet halos and numbered badges and, on wider screens, three callouts joined to their targets by thin lines: the bar splits every task by phase, open tasks group by epic, and a question waiting on you shows up in the task's timeline.

One capture, raw and burned with a caption theme.

A terminal window titled docsxai run, composed from the engine's real output format and the real trackxai flow counts, not a recorded session. The command docsxai run workspace replays the screens flow in eight variants: en-US and es-ES, light and dark, desktop 1280 and mobile 390. Each variant reports 61 or 53 steps and 29 or 18 annotations. The last lines say 8 of 8 flow variants ok, with outputs in workspace/docs. On phones the lines are shortened to one per variant.A terminal window titled docsxai run, composed from the engine's real output format and the real trackxai flow counts, not a recorded session. The command docsxai run workspace replays the screens flow in eight variants: en-US and es-ES, light and dark, desktop 1280 and mobile 390. Each variant reports 61 or 53 steps and 29 or 18 annotations. The last lines say 8 of 8 flow variants ok, with outputs in workspace/docs. On phones the lines are shortened to one per variant.

One flow, eight variants. Output as docsxai run prints it.

How it works

Replay

Same flow, same bytes

A frozen clock and a pinned locale, timezone and viewport. diff --fail-on warn fails CI when a screenshot drifts from the committed baseline.

Variants

One flow, every variant

A matrix block runs the flow per locale, color scheme and viewport, up to 64 combinations.

Authoring

An agent writes it once

The Claude Code plugin writes and lints the flow. Every run after that costs no tokens.

Output

Viewer or plain PNGs

Halos and callouts in an interactive viewer, or burned into PNGs with a caption theme. Redactions mask sensitive UI before anything hits disk.

Publishing

Plugins publish it

Publishers for Confluence, GitBook, Guru, Notion and SharePoint. SharePoint is on npm as experimental. The rest are repo-only for now.

First run

  1. Step 1

    Make a workspace

    docsxai init my-docs --app-url http://localhost:3000 --auth none

    Behind a login? Drop --auth none, then run docsxai capture-auth my-docs.

    Expectcreated: flows/, docs/, auth/, .auth/, .viewer/, .gitignore, .docsxai.json, flows/example.flow.yaml.sample, README.md

  2. Step 2

    Check the setup

    docsxai doctor my-docs
    A failing line ends with its fix.

    Expectok: config: .docsxai.json fields are valid

  3. Step 3

    Add a flow with an agent

    /plugin marketplace add kalebteccom/docsxai
    /plugin install docsxai@docsxai

    Then ask Claude Code: "add a flow to my-docs: open Reports and show the export button".

    Expectnext: docsxai run my-docs (then: docsxai render my-docs)

  4. Step 4

    Run it

    docsxai run my-docs
    Replays the flow in headless Chromium.

    Expectrun: 1 of 1 flow ok, outputs in my-docs/docs

  5. Step 5

    Open the docs

    docsxai render my-docs
    Hover or tap a halo to read its callout.

    Expectrender: open /path/to/my-docs/.viewer/index.html

Made by KalebtecGitHubApache-2.0 licensed