AGENTS.db/.env.example at main · krazyjakee/AGENTS.db · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# AGENTS.db Environment Variables
# ================================
# This file documents all environment variables that can be used with AGENTS.db.
# Copy this file to .env and fill in the values you need.

# ================================
# Embedding API Keys
# ================================
# These environment variables are used for remote embedding providers.
# You only need to set the keys for the backends you plan to use.

# OpenAI Embeddings API Key
# Used when backend is set to "openai" (e.g., text-embedding-3-small, text-embedding-3-large)
# Get your key from: https://platform.openai.com/api-keys
OPENAI_API_KEY=

# Voyage AI Embeddings API Key
# Used when backend is set to "voyage" (e.g., voyage-3, voyage-3-lite)
# Get your key from: https://www.voyageai.com/
VOYAGE_API_KEY=

# Cohere Embeddings API Key
# Used when backend is set to "cohere" (e.g., embed-english-v3.0, embed-multilingual-v3.0)
# Get your key from: https://dashboard.cohere.com/api-keys
COHERE_API_KEY=

# Anthropic Embeddings API Key
# Used when backend is set to "anthropic" (e.g., claude-3-embeddings)
# Get your key from: https://console.anthropic.com/
ANTHROPIC_API_KEY=

# Google Gemini API Key
# Used when backend is set to "gemini" (e.g., text-embedding-004)
# Get your key from: https://aistudio.google.com/app/apikey
GEMINI_API_KEY=

# ================================
# AWS Bedrock Configuration
# ================================
# Required when using backend "bedrock" for AWS-hosted embedding models
# (e.g., amazon.titan-embed-text-v1, cohere.embed-english-v3)

# AWS Region (required for Bedrock)
# Examples: us-east-1, us-west-2, eu-west-1
AWS_REGION=

# Alternative to AWS_REGION (will be used if AWS_REGION is not set)
AWS_DEFAULT_REGION=

# AWS Access Key ID (required for Bedrock)
AWS_ACCESS_KEY_ID=

# AWS Secret Access Key (required for Bedrock)
AWS_SECRET_ACCESS_KEY=

# AWS Session Token (optional, used for temporary credentials)
AWS_SESSION_TOKEN=

# ================================
# Cache Configuration
# ================================
# These variables affect where embedding caches are stored.
# If not set, defaults to platform-specific cache directories.

# XDG Cache Home (Linux/Unix)
# Default embedding cache location on Linux: $XDG_CACHE_HOME/agentsdb/embeddings
# XDG_CACHE_HOME=~/.cache

# Local App Data (Windows)
# Default embedding cache location on Windows: %LOCALAPPDATA%\agentsdb\embeddings
# LOCALAPPDATA=

# Home Directory (fallback for all platforms)
# Used as fallback if platform-specific variables are not set
# HOME=

# ================================
# Custom API Key Environment Variables
# ================================
# You can configure AGENTS.db to use custom environment variable names
# for API keys by setting the 'api_key_env' option in your embedding configuration.
# This is useful if you want to use different variable names or share keys across projects.
#
# Example: If you set api_key_env="MY_CUSTOM_OPENAI_KEY" in your config,
# AGENTS.db will read from that variable instead of OPENAI_API_KEY
# MY_CUSTOM_OPENAI_KEY=

# ================================
# Notes
# ================================
# - Local backends (ort, candle, hash) do not require any API keys
# - API base URLs can be configured via CLI or config, not environment variables
# - The web server bind address is configured via CLI argument, not environment variables
# - See documentation for more details: https://github.com/anthropics/agentsdb