Skip to content

Commit ac5345b

Browse files
committed
docs: expand README Configuration with full env var reference table
1 parent 5097339 commit ac5345b

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,45 @@ Installment options (`auto setup script` or `manual installment`), see [Installa
7070

7171
## Configuration
7272

73+
Create a `.env` file (or copy `.env.example`):
74+
7375
```env
7476
# Required
7577
DISCORD_TOKEN=your_bot_token_here
7678
APPLICATION_ID=your_application_id_here
7779
7880
# Optional
79-
ANTHROPIC_API_KEY=your_anthropic_api_key_here
80-
USER_ID=your_discord_user_id
81-
CATEGORY_NAME=claude-code
82-
WORK_DIR=/path/to/project
81+
ANTHROPIC_API_KEY=sk-ant-... # Enables dynamic model discovery & refresh
82+
USER_ID=your_discord_user_id # @mention when Claude finishes a task
83+
CATEGORY_NAME=claude-code # Discord category for bot channels
84+
WORK_DIR=/path/to/project # Working directory (default: current dir)
85+
86+
# Access Control (RBAC) — leave blank to keep all commands open
87+
ADMIN_ROLE_IDS=123456789,987654321 # Comma-separated Discord role IDs
88+
ADMIN_USER_IDS=111111111 # Comma-separated Discord user IDs
89+
90+
# Proxy (optional — respected automatically if set)
91+
# HTTP_PROXY=http://proxy:8080
92+
# HTTPS_PROXY=http://proxy:8080
93+
# NO_PROXY=localhost,127.0.0.1
8394
```
8495

96+
| Variable | Required | Description |
97+
| --- | :---: | --- |
98+
| `DISCORD_TOKEN` | **Yes** | Bot token from the [Discord Developer Portal](https://discord.com/developers/applications) |
99+
| `APPLICATION_ID` | **Yes** | Application ID from the Developer Portal |
100+
| `ANTHROPIC_API_KEY` | No | Enables dynamic model discovery; refreshes hourly |
101+
| `USER_ID` | No | Your Discord user ID — bot @mentions you when tasks finish |
102+
| `CATEGORY_NAME` | No | Discord category name for channels (default: `claude-code`) |
103+
| `WORK_DIR` | No | Working directory for Claude operations (default: current dir) |
104+
| `ADMIN_ROLE_IDS` | No | Comma-separated role IDs for RBAC (shell, git, system, admin) |
105+
| `ADMIN_USER_IDS` | No | Comma-separated user IDs for RBAC — grants access regardless of roles |
106+
| `HTTP_PROXY` | No | HTTP proxy URL (also reads `http_proxy`) |
107+
| `HTTPS_PROXY` | No | HTTPS proxy URL (also reads `https_proxy`) |
108+
| `NO_PROXY` | No | Comma-separated hosts to bypass proxy |
109+
110+
> CLI flags override environment variables. Environment variables override `.env` file values.
111+
85112
## Startup Options
86113

87114
```bash

0 commit comments

Comments
 (0)