donobu
v6.0.1
Published
Set a project up for Donobu (@donobu/test) with `npx donobu init`, then run its CLI.
Readme
donobu
The public entry point for Donobu, the AI-powered
browser-testing library. The library itself, @donobu/test, is served from
Donobu's private npm registry, so a fresh project needs a little setup before
it can install the package or the coding-agent skill that ships inside it.
This package is that setup:
npx donobu@latest initThe @latest matters: a bare npx donobu reuses whatever the npx cache or a
global install already has, which may be the legacy 5.x library.
What init does
Idempotent, so re-run it whenever something is off.
- Writes the two
.npmrclines that route@donobu/*to the private registry. The auth line reads the key fromDONOBU_API_KEYin the form the project's package manager understands: pnpm gets a:-unsetfallback, because pnpm discards the whole file when the variable is missing, while npm, bun, and yarn get plain${DONOBU_API_KEY}, because they do not expand the fallback form and would send it literally as the token. - Makes sure
.gitignorecovers.env. - Finds your Donobu API key in the environment or the project's
.env. Without one it stops here, with instructions, and exits with code 2. Keys are created at https://www.donobu.com/home/keys. - Installs
@donobu/testas a devDependency with the project's package manager (detected from thepackageManagerfield or the lockfile). - Sets
"prepare": "donobu skills install || exit 0"so the agent skill refreshes on every install. An existing prepare script is left alone and reported. - Hands off to the installed CLI:
donobu skills installwrites the skill to.claude/skills/donobuand.agents/skills/donobu, anddonobu statusconfirms the cloud identity behind the key.
Your key is written to .env (git-ignored) for the Donobu CLI to read. Note
that package managers read .npmrc substitutions from the shell environment,
not from .env, so export DONOBU_API_KEY before pnpm install and add it as
a secret in CI.
Every other command
donobu <anything else> runs the @donobu/test CLI installed in the project:
donobu test, donobu heal, donobu status, and the rest. Once the library is
installed, npx donobu resolves to it directly.
Do not add this package to a project's dependencies. It is meant for npx,
pnpm dlx, or a global install, and it shares the donobu bin name with the
library.
For coding agents
Paste this into Claude Code, Codex, or any other agent working in the project:
Set up Donobu in this project by running `npx donobu@latest init` and
following its output. If it stops for an API key, tell me and wait; do not search for a key
or ask me to paste one into this conversation. When init finishes, read the
installed skill at .claude/skills/donobu/SKILL.md before writing or running
tests. Use no other installation method.