Documentation Index
Fetch the complete documentation index at: https://docs.agent-vault.dev/llms.txt
Use this file to discover all available pages before exploring further.
Install
Auto-detects your OS and architecture, downloads the latest release, and installs. Works for both fresh installs and upgrades.The install script sends an anonymous beacon (OS, architecture, version). Set
AGENT_VAULT_NO_TELEMETRY=1 in front of sh to opt out.Build from source
Prerequisites: Go 1.25+, Node.js 22+Start the server
AGENT_VAULT_MASTER_PASSWORD environment variable or pass --password-stdin instead. Omit it entirely for passwordless mode. See environment variables for all options.
To run in the background:
Register and log in
The first user to register becomes the instance owner with full admin privileges and is automatically granted admin on the default vault. Any CLI command that needs authentication will walk you through registration and login automatically — just run the command you want and follow the prompts. You can also register explicitly:- CLI
- Web UI
agent-vault auth register, the web registration page, or be invited to a vault by a vault admin.
Transparent proxy
Agent Vault exposes a transparentHTTPS_PROXY listener on port 14322 — the canonical ingress agents use. Any standard HTTP client that honors HTTPS_PROXY (curl, fetch, requests, axios, the Go stdlib, SDKs, CLIs) transparently routes through the broker. The listener is TLS-encrypted (cert signed by the MITM CA) so the CONNECT handshake carrying session tokens is protected.
~/.agent-vault/ca/ (private key encrypted with the DEK). Clients must trust this root before the proxied TLS handshake will succeed. agent-vault vault run handles this automatically for child processes — only fetch the CA manually when configuring agents outside of vault run (containers, CI, invited agents).
Fetch the root certificate from any machine that can reach the server:
agent-vault ca fetch flags.
Upgrade
Re-run the same install command — the script detects your existing installation, stops the running server, backs up your database, and installs the latest version:The upgrade sends the same anonymous beacon as install. Set
AGENT_VAULT_NO_TELEMETRY=1 in front of sh to opt out.