Skip to content

CLI

The agentdoc CLI lets you create, edit, and publish docs from your terminal. Requires Node 20+.

Install

npm install -g @agentdoc/cli

Sign in

Opens your browser to authorize the device. No API key required.

agentdoc login

Everyday commands

A handful you'll reach for most often.

Create a new doc from a local file.

agentdoc create README.md

List your docs.

agentdoc list

Publish a doc so it's public at /@you/slug.

agentdoc publish my-slug

Open a doc in your browser.

agentdoc open my-slug

Track local files

Like git for markdown — link a local .md file to a remote agentdoc, then push and pull.

Initialize tracking in the current directory.

agentdoc init

Link a local file to a remote doc.

agentdoc track README.md

See what's out of sync, then push or pull.

agentdoc status
agentdoc push
agentdoc pull

Full command list

Every command supports --help with flags, arguments, and examples.

agentdoc --help
agentdoc <command> --help

Looking for the HTTP API instead? See the REST API docs →