@agentdocumentformat/cli
The ADF CLI: run ADF (Agent Document Format) agents from a terminal, with
no desktop app. An ADF agent is a single .adf file: config, memory, files
and history in one portable document. For the desktop app, ADF Studio, see
the releases.
adf: the terminal app. Your fleet of agents in one screen: chat with any agent or any of its loops, approve tool calls, edit files, schedule inner loops (side loops), watch live events.adf web: Browser Studio, using the shared desktop renderer. Available in builds that include browser support; published npm v0.8.3 does not include it.adf <command>: one-shot commands for scripts (adf help).adf daemon: the background daemon that runs the agents.adfstarts it for you; it keeps running after you quit.
Install
Current main requires Node.js ^22.23.4 || ^24.22.1 || ^26.12.1; adf
refuses earlier releases and 23.x/25.x because of CVE-2026-111497, and 27+
until tested. Published npm v0.8.3 declares >=22 and predates this check.
See Node.js versions.
Native modules (SQLite, OS keychain) come
prebuilt for Windows, macOS (arm64, x64) and Linux (x64, arm64, glibc).
npm i -g @agentdocumentformat/cli
adf
EEXIST on install? Remove the old package first:
npm uninstall -g agent-document-format.
Upgrade: npm i -g @agentdocumentformat/cli@latest, then
adf daemon restart.
Browser Studio
With a browser-enabled CLI and daemon build:
adf web # start the local daemon if needed and open the browser
adf web --port 7485 # choose another local daemon port
adf web --no-daemon # use an already-running daemon
The browser signs in through a short-lived, one-use link. No desktop app or
manual token copying is needed. adf web is local-only; for another device,
run these commands on the daemon host:
adf daemon remote on
adf daemon remote status
adf daemon remote allow-network <network-id-or-name> # if not already allowed
adf daemon pair
Open the printed /studio/ address on the other device, enter the six-digit
code and a browser name, then approve that request in the host terminal.
Paired browsers are remembered for up to 30 days; browser sessions last eight
hours. Signing out clears the remembered credential. Revoke access with
adf daemon devices revoke <id-or-label>.
These instructions describe the browser-enabled build, not published npm
v0.8.3. From its source checkout, use npm run build:web followed by
npm run adf -- web; npm run build:npm packages the browser assets with the
CLI. See the Browser Studio guide
for source setup, network access and browser limitations.
Local models
Use Ollama, LM Studio, or any server that implements the OpenAI-compatible
chat API. Both the server and selected model need tool calling for agent
tools. Vision is needed only when the model must understand images or screenshots. Add the server with
/provider add, using its API base URL and model ID; supply a key only if
the server requires one. See
local model requirements.
Quickstart
In the terminal app (a welcome checklist opens on first run):
/identity create # your owner identity: 12 words, the same as in ADF Studio
/login chatgpt # or /login grok, /login claude, or /provider add for an API key
/new # create an agent; its chat opens
/loop new consolidator # optional: an inner loop that tidies memory nightly
Or with one-shot commands:
adf identity new
adf auth login chatgpt
adf new agent-1 --start
adf chat agent-1 "hello"
adf events agent-1
Daemon: adf daemon status | stop | restart | logs -f | token. On current
main, Studio in Local mode and the CLI share one daemon, settings and owner
identity, and can run side by side. With Inside Studio (legacy), adf
refuses to start a daemon on the same settings while Studio runs; switch
Studio to Local mode or quit it first.
Docs
- ADF CLI
- Getting started
- Browser Studio (browser-enabled build)
- Terminal app
- Reference: every command, flag, slash command and key
- Remote daemon
- Troubleshooting
- Daemon HTTP API
License
MIT