dari-docs

dari-docs command [path|url] [options]Commands: check, optimize, auth

dari-docs is a CLI for measuring whether technical documentation is clear enough for an AI agent (and, by proxy, a new developer) to complete real tasks unaided. It packages a local docs directory (or accepts a public docs URL) and submits it along with one or more --task descriptions to hosted tester agents. The agents read only the provided docs and attempt the task, reporting the exact points where they got blocked, misled, or had to guess.check stops at that diagnostic report. optimize additionally runs editor agents that propose concrete documentation edits to fix the issues, downloading them into .dari-docs/updated/ for human review before any change lands in the repo.The default --managed mode uses Dari's hosted tester and editor agents and is the fastest way to get value. Self-managed mode (configured through a dari.yml file) lets teams customize agent prompts, skills, setup scripts, and execution environment within their own dari.dev organization.

check PATH|URL

Run tester agents against the docs at PATH (local directory) or URL (public docs site) and report where they got stuck.

Run tester agents and then editor agents; download proposed doc edits into .dari-docs/updated/ without touching the repo.

Authenticate (or sign out) against the hosted dari.dev Docs service.

The developer task the agents should attempt using only the docs. Repeat the flag for multiple tasks.

Submit the run to hosted Dari Docs agents (default mode). Without it, the CLI expects a self-managed setup driven by dari.yml.

Block until the run finishes; print the report and (for optimize) download proposed edits.

Resume waiting on or fetch results for a previously submitted run.

Show usage for the CLI or a subcommand.

dari.yml

Project-level configuration for self-managed runs. Defines tester/editor agent prompts, skills, setup commands, and the docs surface to expose. Only read when --managed is not set.

Created by the CLI inside the target directory. updated/ holds proposed edits from optimize; review and copy into the repo manually.

Both managed and self-managed modes require authentication via dari-docs auth login, which stores a token in the user's config directory.

Runs are billed against a dari.dev account and require network access; --managed sends the bundled docs to Dari's hosted agents, so private documentation may need self-managed mode or a private deployment. Proposed edits are agent-generated suggestions and should be reviewed for factual accuracy before merging. Public-URL inputs are fetched by the agents themselves, so paywalled or auth-gated docs cannot be evaluated that way.

dari-docs is developed by mupt-ai and lives at github.com/mupt-ai/dari-docs, part of the broader dari.dev platform for agent-driven documentation quality. It launched as the agent-era successor to traditional docs-linting tools, shifting the measure of quality from style conformance to task completability.

vale(1), markdownlint(1), alex(1)