pisa/.env.example at main · Prismer-AI/pisa · 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# ============================================================
# PISA Environment Configuration Template
# ============================================================
# Copy this file to .env and fill in your actual values
# cp .env.example .env
#
# SECURITY WARNING: Never commit your .env file to version control!
# ============================================================

# ============================================================
# OpenAI Configuration (Required)
# ============================================================

# Your OpenAI API key (required)
# Get your key at: https://platform.openai.com/api-keys
OPENAI_API_KEY=sk-your-api-key-here

# OpenAI API base URL (optional, for custom endpoints)
# Default: https://api.openai.com/v1
# Example for local proxy: http://localhost:3000/v1
OPENAI_API_BASE_URL=https://api.openai.com/v1

# Default model for agents (can be overridden in agent.md)
# Common options: gpt-4o, gpt-4o-mini, gpt-4-turbo, gpt-3.5-turbo
# Custom models: openai/gpt-oss-120b (for custom endpoints)
AGENT_DEFAULT_MODEL=gpt-4o-mini

# OpenAI API Trace Key (optional, for request tracing/debugging)
# OPENAI_API_TRACE_KEY=sk-proj-your-trace-key-here

# ============================================================
# Search Capabilities (Optional)
# ============================================================

# Serper API for web search
# Get your key at: https://serper.dev/
# Used by: search(engine="web"), crawl_tool
SERPER_API_KEY=your-serper-api-key-here
# Alternative key name (both are supported):
# SEARCH_API_KEY=your-serper-api-key-here

# Exa API for neural search
# Get your key at: https://exa.ai/
# Used by: search(engine="exa")
EXASEARCH_API_KEY=your-exa-api-key-here
# Alternative key name (both are supported):
# EXA_API_KEY=your-exa-api-key-here

# ============================================================
# Google Cloud / Gemini Configuration (Optional)
# ============================================================

# Google Cloud Project ID (for Gemini image generation)
# Get your project ID at: https://console.cloud.google.com/
# Used by: generate_image, generate_image_batch
GOOGLE_PROJECT_ID=your-google-project-id

# Google Cloud Location (optional, defaults to 'global')
# GOOGLE_LOCATION=global

# Gemini Image Model (optional, defaults to 'gemini-3-pro-image-preview')
# Available models: gemini-3-pro-image-preview, gemini-2.0-flash-exp
# GEMINI_IMAGE_MODEL=gemini-3-pro-image-preview

# ============================================================
# PISA System Configuration (Optional)
# ============================================================

# Enable debug mode (true/false, defaults to false)
# Enables verbose logging and additional diagnostics
PISA_DEBUG=false

# Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
# LOG_LEVEL=INFO

# Environment (development, staging, production)
# ENVIRONMENT=development

# ============================================================
# Notes & Best Practices
# ============================================================
#
# 1. Security:
#    - Never commit your .env file to version control
#    - Add .env to your .gitignore file
#    - Keep your API keys secure and rotate them regularly
#    - Use different keys for dev/staging/production
#
# 2. Priority:
#    - Environment variables can be overridden at runtime
#    - Agent.md settings take precedence over .env
#    - Required: OPENAI_API_KEY
#    - Optional: All other variables have sensible defaults
#
# 3. Capability-Specific Keys:
#    - Search: Only needed if using search/crawl capabilities
#    - Google Cloud: Only needed if using image generation
#    - Multiple capabilities can work without API keys
#
# 4. Testing:
#    - Use `pisa list` to verify system configuration
#    - Use `pisa validate` to check agent definitions
#    - Set PISA_DEBUG=true for troubleshooting
#
# For more information:
# - Documentation: docs/
# - Quick Start: README.md
# - Capability Guide: src/pisa/capability/README.md
#
# ============================================================