BioClaw/.env.example at main · nicoxia/BioClaw · 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
# ──────────────────────────────────────────────
# BioClaw Environment Configuration
# Copy this file to .env and fill in your values
# ──────────────────────────────────────────────

# ─── Model Provider (choose one) ───────────────

# Option A: Anthropic (default) — Claude models
ANTHROPIC_API_KEY=sk-ant-api03-your-key-here

# Option B: OpenRouter — access Gemini, DeepSeek, Claude, GPT, etc. via one API
# Get key at https://openrouter.ai/keys
# MODEL_PROVIDER=openrouter
# OPENROUTER_API_KEY=sk-or-v1-your-key
# OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
# OPENROUTER_MODEL=deepseek/deepseek-chat-v3.1

# Popular OpenRouter model IDs:
#   deepseek/deepseek-chat-v3.1    DeepSeek V3.1
#   deepseek/deepseek-v3.2         DeepSeek V3.2
#   google/gemini-2.5-flash       Gemini 2.5 Flash
#   google/gemini-3-flash-preview Gemini 3 Flash
#   anthropic/claude-3.5-sonnet   Claude 3.5 Sonnet
# Full list: https://openrouter.ai/models

# ─── WhatsApp ─────────────────────────────────

# WhatsApp uses QR code authentication via Baileys.
# No credentials needed here — run `npm start` and scan the QR code
# with your WhatsApp app. Auth state is persisted in store/auth/.
# Debug-only: allow the same WhatsApp account used by the bot to send
# test messages to itself. Bot replies are still filtered to avoid loops.
# ALLOW_WHATSAPP_SELF_MESSAGES=true

# ─── WeCom (企业微信) — Optional ─────────────

# To enable WeCom bot, create a Smart Robot (智能机器人) in WeCom admin console,
# select API mode with long connection, then fill in BotID and Secret below.
WECOM_BOT_ID=your-bot-id
WECOM_SECRET=your-secret

# Optional: self-built app for sending images/files (requires IP whitelist on server)
# WECOM_CORP_ID=your-corp-id
# WECOM_AGENT_ID=your-agent-id
# WECOM_CORP_SECRET=your-corp-secret

# ─── QQ Official Bot — Optional ───────────

# Current QQ support covers official QQ Bot text receive/reply over WebSocket.
# Supported inbound events: private chat messages and group @bot messages.
# QQ_APP_ID=your-app-id
# QQ_CLIENT_SECRET=your-client-secret
# QQ_SANDBOX=false

# ─── Feishu (Lark) — Optional ───────────────

# Current Feishu support covers text receive/reply.
# WebSocket mode is simplest if your bot app allows long connections.
# FEISHU_APP_ID=cli_xxx
# FEISHU_APP_SECRET=your-app-secret
# FEISHU_CONNECTION_MODE=websocket

# Only needed for webhook mode or encrypted event delivery:
# FEISHU_VERIFICATION_TOKEN=
# FEISHU_ENCRYPT_KEY=
# FEISHU_HOST=0.0.0.0
# FEISHU_PORT=8080
# FEISHU_PATH=/feishu/events

# ─── WeChat (个人号) — Optional ──────────────
# Uses weixin-agent-sdk (based on Tencent OpenClaw WeChat channel).
# QR code login in terminal, long-polling for messages.
# ENABLE_WECHAT=true

# ─── Discord — Optional ──────────────────────

# To enable Discord bot:
# 1. Create an application at https://discord.com/developers/applications
# 2. Add a Bot, copy the token
# 3. Enable "Message Content Intent" under Privileged Gateway Intents
# 4. Invite the bot to your server with Send Messages + Attach Files permissions
# DISCORD_BOT_TOKEN=your-bot-token

# ─── Slack — Optional (Socket Mode) ──────────

# BioClaw uses Slack Socket Mode (no public Request URL required).
# 1. Create an app at https://api.slack.com/apps
# 2. Enable Socket Mode → create an App-Level Token with scope connections:write (xapp-...)
# 3. Install the app to your workspace; copy Bot User OAuth Token (xoxb-...)
# 4. Event Subscriptions → subscribe to bot events: message.channels, message.groups,
#    message.im, message.mpim (or legacy "message" where available)
# 5. OAuth & Permissions → Bot Token Scopes: channels:history, groups:history, im:history,
#    mpim:history, chat:write, files:write (for images), users:read, channels:read
# SLACK_BOT_TOKEN=xoxb-your-bot-token
# SLACK_APP_TOKEN=xapp-your-app-token

# ─── Container Runtime ──────────────────────────
# Default: docker. Set to "apptainer" for HPC clusters without Docker.
# See docs/APPTAINER.md for setup instructions.
# CONTAINER_RUNTIME=docker
# CONTAINER_IMAGE=bioclaw-agent:latest      # Docker tag or path to .sif file

# ─── Trace API auth (optional) ────────────────
# If set, trace/workspace API routes require Bearer token or ?token= query param.
# DASHBOARD_TOKEN=