Skip to main content
A Vault is a secure logical container for credentials with services that define how agents can proxy requests through it. Each vault contains:
  • Credentials: API keys, database credentials, and other sensitive material that cannot be extracted from the vault.
  • Services: Definitions of which upstreams (scoped by a single host pattern that may carry an inline path glob, e.g. api.stripe.com or slack.com/api/apps.connections.*) can be accessed through the vault along with which and how credential(s) must be attached onto each proxy request.
  • Members: Users and agents that can access the vault under specific roles (admin, member, proxy).
  • Proposals: Requests from agents to set credential(s) and/or add service(s) that use those credentials.
Note that a default vault is created automatically for the first user of Agent Vault (called the instance owner).

​
Create a vault

Vault names must be unique across the Agent Vault instance and use slug format: lowercase letters, numbers, and hyphens only.

​
Bind a project to a vault

Run vault init inside your project directory to create an agent-vault.json file that binds the project to a specific vault:
This file is meant to be committed to version control. When present, all team members and agents running in that directory will automatically target the bound vault without needing --vault flags or per-user context. Vault resolution priority: --vault flag > AGENT_VAULT_VAULT env var > agent-vault.json > user context > "default".

​
Add an agent to a vault

For any agent that lives outside vault run (cloud-hosted, CI pipelines, always-on assistants), create a named agent and supply its token via AGENT_VAULT_TOKEN.
1

Create the agent

Prints the agent token (and copies it to your clipboard). The --vault flag pre-assigns vault access (format: name:role).
2

Supply the token to the agent's runtime

Set AGENT_VAULT_TOKEN and AGENT_VAULT_ADDR wherever the agent runs (env vars, secrets store, container config).
If the agent already exists, grant it access to additional vaults with:

​
Invite users to a vault

1

Send the invite

If SMTP is configured, the invitee receives an HTML email with a browser acceptance link. The invite link is also printed to CLI output.
2

Invitee accepts

The invitee clicks the link and lands on a browser acceptance page.
  • New users set their password on acceptance and their account is created automatically.
  • Existing users get the vault grant applied immediately.
3

Verify membership

​
Manage members and agents

​
Delete a vault

Vault admins can delete the vaults they manage. Instance owners can also delete any vault.
The default vault cannot be deleted. Use --yes to skip the confirmation prompt.
Deleting a vault permanently removes all its services, credentials, agents, and proposals. This cannot be undone.

​
Owner-level vault management

Instance owners can see and manage all vaults across the instance, regardless of vault membership.
Owners see every vault in their vault list. Vaults they have not joined appear in a separate “Other Vaults” section with a Join button. Joining grants the owner admin access, letting them manage credentials, approve proposals, and configure services.
If a user is deleted and their vaults become orphaned (no remaining members), an instance owner can always join those vaults to recover access. User deletion only removes the user and their vault grants — vaults and their data stay intact.