koan/env.example at main · bluetoothbot/koan · 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
# KOAN_ROOT — Path to the koan repository root (required)
# This is auto-set by Makefile targets, but you can override it here.
# Uncomment and set to your actual path:
# KOAN_ROOT=/Users/yourname/koan

# Git identity for koan's commits (optional but recommended)
# KOAN_EMAIL="koan@yourdomain.com"

# =========================================================================
# MESSAGING PROVIDER (optional — defaults to Telegram)
# =========================================================================
# Which messaging platform Kōan uses for communication.
# Options: "telegram" (default), "slack"
# Can also be set in config.yaml (env var takes priority)
# KOAN_MESSAGING_PROVIDER=telegram

# =========================================================================
# TELEGRAM CONFIGURATION (required if messaging provider is "telegram")
# =========================================================================
# Get these from @BotFather on Telegram — see INSTALL.md for instructions.

# Your bot token from BotFather (format: 123456789:ABC-DEF1234...)
# KOAN_TELEGRAM_TOKEN=

# Your chat ID (find it via the getUpdates API call — see INSTALL.md)
# KOAN_TELEGRAM_CHAT_ID=

# =========================================================================
# SLACK CONFIGURATION (required if messaging provider is "slack")
# =========================================================================
# Get these from api.slack.com/apps — see docs/messaging-slack.md

# Bot User OAuth Token (starts with xoxb-)
# KOAN_SLACK_BOT_TOKEN=

# App-Level Token for Socket Mode (starts with xapp-)
# KOAN_SLACK_APP_TOKEN=

# Channel ID where Kōan will listen and respond (format: C01234ABCD)
# Find it via: Right-click channel → View channel details
# KOAN_SLACK_CHANNEL_ID=

# =========================================================================
# PROJECT CONFIGURATION
# =========================================================================
# Projects are configured in projects.yaml (see projects.example.yaml).
# Legacy: KOAN_PROJECTS env var is still supported as a fallback.

# =========================================================================
# OPTIONAL: Advanced settings
# =========================================================================

# CLI Provider — which AI CLI to use as the backend
# Options: "claude" (default), "copilot" (GitHub Copilot CLI), "local" (local LLM)
# Can also be set in config.yaml (env var takes priority)
# KOAN_CLI_PROVIDER=claude
# Note: CLI_PROVIDER (without KOAN_ prefix) is also supported for backward compatibility

# GitHub CLI identity
# If set, gh CLI commands will run as this user (via gh auth token --user).
# The user must be pre-authenticated with: gh auth login --user <username>
# GITHUB_USER=your-bot-name

# KOAN_BRIDGE_INTERVAL=3     # Telegram poll interval in seconds (default: 3)

# Note: max_runs_per_day and interval_seconds are configured in config.yaml