@dockydoo/cli
v0.2.0
Published
DockyDoo CLI - living product documentation compiled from your code.
Maintainers
Readme
@dockydoo/cli
The DockyDoo CLI: docky compiles your code into a living, verified
documentation graph, on your machine, free and offline.
This is the public distribution package. The DockyDoo source is private; only the prebuilt
dockybinaries are published here and to npm.
Install
npm install -g @dockydoo/cli
docky --helpThen in a project:
docky build # compile .docky/graph.json (offline, zero tokens)
docky review # graph-aware check of your change (deterministic gates)
docky mcp # serve the graph to your AI over MCP (docky://context + tools)
docky attest [symbol] # confirm a @docky note matches its code now
docky resolve <id> --as .. # account for a removed authored itemOptional cloud (a hosted dashboard, history, and team sign-off):
docky login # browser login; scoped token stored in the OS keychain
docky login --device # headless / SSH: enter a code in any browser
docky login --token <t> # CI: use a scoped token minted in the dashboard
docky init # link this repo to a cloud org/team/project
docky push # send the built graph to the dashboard
docky logout # clear the stored tokenFor a team, push from CI (via the DockyDoo GitHub App), not a laptop: a local
push reflects your working tree, so a shared dashboard would flip to whoever
pushed last. docky login defaults to the production cloud; set DOCKY_CLOUD_URL
for a different endpoint.
Prefer a raw binary? Grab one from the Releases page.
How distribution works
@dockydoo/cli is a thin launcher. The actual binary is delivered by a
per-platform optional dependency, and npm installs only the one that matches
your machine:
| Platform | Package | Rust target |
| --------------- | ---------------------------- | ------------------------- |
| macOS (Apple) | @dockydoo/cli-darwin-arm64 | aarch64-apple-darwin |
| macOS (Intel) | @dockydoo/cli-darwin-x64 | x86_64-apple-darwin |
| Linux x64 | @dockydoo/cli-linux-x64 | x86_64-unknown-linux-gnu|
| Linux arm64 | @dockydoo/cli-linux-arm64 | aarch64-unknown-linux-gnu|
| Windows x64 | @dockydoo/cli-win32-x64 | x86_64-pc-windows-msvc |
No postinstall download, no network at install time: each platform package
carries its binary and declares os/cpu so npm picks the right one. The
bin/docky.js launcher resolves that package and execs the binary.
Releasing (maintainers)
Releases are cut from the private monorepo's release-cli workflow, which
cross-compiles docky for every target, then runs:
cd cli
node scripts/build-platform-packages.mjs <artifacts-dir> <version>
# publishes dist/* (platform packages) then the main wrapperSee cli/scripts/targets.mjs for the target table.
