← Back to Docs

🚀 Getting Started with AVP

Get up and running with Agent Vault Protocol in under 5 minutes.

Installation

Python
TypeScript
Rust
Go
# Install the SDK
pip install avp-sdk

# With keychain support (macOS/Linux/Windows)
pip install avp-sdk[keychain]

# Install CLI tool
pip install avp-cli
# Install the SDK
npm install avp-ts-sdk

# With keychain support
npm install avp-ts-sdk keytar
# Add to Cargo.toml
[dependencies]
avp = "0.1"
# Install the SDK
go get github.com/avp-protocol/avp-go

Quick Start

1. Store a Credential

from avp import AVPClient
from avp.backends import FileBackend

# Create a file-based vault (encrypted with your password)
backend = FileBackend("~/.avp/vault.enc", "your-secure-password")
client = AVPClient(backend)

# Authenticate to a workspace
session = client.authenticate(workspace="my-agent")

# Store an API key
client.store(session.session_id, "openai_api_key", b"sk-...")
print("✓ Credential stored!")

2. Retrieve a Credential

# Retrieve the credential
result = client.retrieve(session.session_id, "openai_api_key")
api_key = result.value.decode()

# Use it in your agent
from openai import OpenAI
client = OpenAI(api_key=api_key)

3. List All Credentials

# List all stored credentials
secrets = client.list_secrets(session.session_id)
for secret in secrets.secrets:
    print(f"  - {secret.name} (v{secret.metadata.version})")

Using the CLI

# Initialize a new vault
avp init

# Store a credential
avp store anthropic_api_key "sk-ant-..."

# Retrieve a credential
avp get anthropic_api_key

# List all credentials
avp list

# Rotate a credential
avp rotate anthropic_api_key "sk-ant-new-..."
💡 Tip: Use avp get mykey --quiet to output only the value, perfect for scripts: export API_KEY=$(avp get mykey -q)

Backend Options

Backend Security Level Best For
Memory Testing only Unit tests, development
File Good (AES-256) Personal projects, CI/CD
Keychain Better (OS-protected) Production apps, multi-user
Hardware Best (FIPS 140-3) Enterprise, regulated industries

Next Steps