Skip to content

Commit 7fcd6af

Browse files
praisonai-triage-agent[bot]CopilotMervinPraison
authored
fix(claw): add .env.example and document TAVILY_API_KEY requirement (#1649)
* fix(claw): add .env.example and document TAVILY_API_KEY requirement (fixes #1648) - Add comprehensive .env.example at repository root with all required and optional environment variables - Document TAVILY_API_KEY requirement in README.md Claw section with link to get free API key - Fixes silent failures on first run by providing clear variable reference template - Improves developer onboarding experience for new Claw users Co-authored-by: praisonai-triage-agent[bot] <praisonai-triage-agent[bot]@users.noreply.github.com> * fix(env): use LOGLEVEL key in root .env.example Agent-Logs-Url: https://github.com/MervinPraison/PraisonAI/sessions/7fe15070-18b9-4586-ba5e-a70c271db412 Co-authored-by: MervinPraison <454862+MervinPraison@users.noreply.github.com> --------- Co-authored-by: praisonai-triage-agent[bot] <272766704+praisonai-triage-agent[bot]@users.noreply.github.com> Co-authored-by: praisonai-triage-agent[bot] <praisonai-triage-agent[bot]@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: MervinPraison <454862+MervinPraison@users.noreply.github.com>
1 parent 1fb71c4 commit 7fcd6af

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

.env.example

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# PraisonAI Environment Variables
2+
# Copy this file to .env and update with your actual values
3+
4+
# === Required ===
5+
OPENAI_API_KEY=sk-... # OpenAI key for LLM calls. Get yours at https://platform.openai.com
6+
7+
# === Required for Claw web-search tool ===
8+
TAVILY_API_KEY=tvly-... # Get yours at https://app.tavily.com (free tier available)
9+
10+
# === Optional: Claw dashboard security ===
11+
PRAISONAI_ALLOW_LOCAL_TOOLS=0 # Set to 1 to enable local shell tools (security risk)
12+
13+
# === Optional: Alternative LLM Providers ===
14+
ANTHROPIC_API_KEY=sk-ant-... # Anthropic Claude models
15+
GOOGLE_API_KEY=... # Google Gemini models
16+
GROQ_API_KEY=gsk_... # Groq (fast inference)
17+
COHERE_API_KEY=... # Cohere models
18+
AZURE_OPENAI_API_KEY=... # Azure OpenAI
19+
AZURE_OPENAI_ENDPOINT=... # Azure OpenAI endpoint
20+
21+
# === Optional: Memory backends ===
22+
MEM0_API_KEY=... # Mem0 memory service
23+
REDIS_URL=redis://localhost:6379 # Redis for state management
24+
25+
# === Optional: Observability ===
26+
LANGFUSE_SECRET_KEY=sk-lf-... # Langfuse tracing
27+
LANGFUSE_PUBLIC_KEY=pk-lf-... # Langfuse public key
28+
29+
# === Optional: Bot platforms ===
30+
TELEGRAM_BOT_TOKEN=... # Telegram bot token
31+
DISCORD_BOT_TOKEN=... # Discord bot token
32+
SLACK_BOT_TOKEN=xoxb-... # Slack bot token
33+
SLACK_APP_TOKEN=xapp-... # Slack app token
34+
WHATSAPP_ACCESS_TOKEN=... # WhatsApp bot access token
35+
WHATSAPP_PHONE_NUMBER_ID=... # WhatsApp phone number ID
36+
37+
# === Optional: Database ===
38+
DATABASE_URL=sqlite:///~/.praison/database.sqlite # Database connection string
39+
40+
# === Optional: Development ===
41+
LOGLEVEL=INFO # Logging level (DEBUG, INFO, WARNING, ERROR)
42+
CHAINLIT_AUTH_SECRET=... # Chainlit authentication secret
43+
DEBUG=false # Enable debug mode

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,15 @@ pip install "praisonai[claw]"
358358
praisonai claw
359359
```
360360

361+
#### Required Environment Variables
362+
363+
Copy `.env.example` to `.env` and configure the following variables:
364+
365+
| Variable | Required | Description |
366+
|----------|----------|-------------|
367+
| `OPENAI_API_KEY` | Yes | OpenAI API key for all LLM calls |
368+
| `TAVILY_API_KEY` | Yes (Claw) | Tavily key for the built-in web-search tool. Get one free at https://app.tavily.com |
369+
361370
Open **http://localhost:8082** — the dashboard comes with 13 built-in pages: Chat, Agents, Memory, Knowledge, Channels, Guardrails, Cron, and more. Add messaging channels directly from the UI.
362371

363372
> 📖 [Full Claw docs](https://docs.praison.ai/docs/concepts/claw) — platform tokens, CLI options, Docker, and YAML agent mode

0 commit comments

Comments
 (0)