Skip to content

Tools

docsxai

User guides that stay current automatically.

Who it is for

Engineers who keep user guides for a web app whose UI changes often.

docsxai walks the app through flows you describe in plain files and rebuilds the guide with annotated screenshots, on demand or in CI.

Proof

What it does today

0
model calls on replay
4
output targets
7
npm packages
  • Taught once, replayed headlessly

    Teach a flow once, usually with Claude Code or Codex over MCP. Replays run on demand or in CI, with no model calls and no agent in the loop.

  • Annotated screenshots

    Halos, numbered badges, callouts and captions are burned into clean screenshots. Captions take preset themes or a design-tokens file.

  • Where the guides go

    An Astro Starlight site, a single-file interactive viewer, or pages pushed to Confluence Cloud and SharePoint.

  • Open source

    Apache-2.0, published as seven npm packages. The stable release is on npm and a release candidate is on the next tag.

How to start

Get going

  1. 01

    Install

    Install it from npm. The default is the stable release, and docsxai@next is the release candidate.

  2. 02

    Teach a flow once

    Describe the flow in plain files, with Claude Code or Codex over MCP if you like.

  3. 03

    Replay it in CI

    Run the replay on demand or in CI and publish where your readers are.

Install

npm install -g docsxai

Prompt for your agent

Install docsxai from npm with npm install -g docsxai. Then help me teach it one flow of this web app, described in plain files, and set up a replay that runs in CI.

The details

Licence
Apache-2.0
Status
Open source, release candidate

docsxai walks a web app through flows you describe in plain files and writes step-by-step guides with annotated screenshots. You teach a flow once, usually with an AI coding agent. After that it replays on demand or in CI, with no model calls. Guides publish as a Starlight site or a single-file viewer, or go to Confluence Cloud and SharePoint.