Skip to main content

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.

Prerequisites

Quick start

Launch Codex with vault run. It wraps Codex with a vault-scoped session, pre-configures HTTPS_PROXY and CA trust so outbound HTTPS routes through Agent Vault transparently, and installs the Agent Vault skill so Codex knows how to discover services and raise proposals. If you haven’t logged in yet, you’ll be guided through setup automatically.
agent-vault vault run -- codex
That’s it. Codex launches with Agent Vault access — no invite, no token pasting, no URL rewriting.
vault run also installs an Agent Vault skill at ~/.agents/skills/agent-vault/SKILL.md. This teaches Codex how to discover services, proxy requests, and raise proposals through Agent Vault. The skill persists across sessions.

Target a specific vault

agent-vault vault run --vault myproject -- codex

Try it out

Ask Codex to do something that requires an external API:
“Fetch my recent Stripe charges”
Here’s what happens — with zero pre-configuration:
  1. Codex calls https://api.stripe.com/... directly. HTTPS_PROXY routes the call through Agent Vault
  2. Agent Vault returns a 403 — Stripe isn’t configured yet
  3. Codex reads the proposal_hint and creates a proposal requesting Stripe access
  4. Codex presents you with an approval link
  5. You click the link, paste your Stripe key, and click Allow
  6. Codex retries — Agent Vault injects your Stripe credentials at the proxy boundary and the request succeeds
You didn’t pre-configure anything. The agent discovered what it needed, asked for approval, and handled the rest.

Alternative: invite-based setup

If you can’t use vault run (e.g. you’re connecting a remote or cloud-hosted Codex instance), use the invite flow instead:
agent-vault agent invite my-agent
This generates a one-time onboarding prompt and copies it to your clipboard. Paste it into Codex — it redeems the invite automatically and receives an agent token plus usage instructions inline.

Next steps

Agent protocol

Full request lifecycle end-to-end.

Services

Pre-configure services you know the agent will need.