dari-docs 命令

常用示例

说明

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.

optimize _PATH_|_URL_

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

auth login / auth logout

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

--task _STRING_

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

--managed

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

--wait

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

--run-id _ID_

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

--help

Show usage for the CLI or a subcommand.