Skip to content

Commit 23cb179

Browse files
committed
docs: fill startup options and add OS-specific install sections
1 parent cf56c88 commit 23cb179

File tree

2 files changed

+108
-28
lines changed

2 files changed

+108
-28
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ docker compose up -d
4141

4242
Need a Discord bot token first? See [Discord Bot Setup](docs/setup-discord.md).
4343

44-
For other install methods (setup script, manual), see [Installation Guide](docs/installation.md).
44+
Installment options (`auto setup script` or `manual installment`), see [Installation Guide](docs/installation.md).
4545

4646
## Documentation
4747

@@ -55,7 +55,7 @@ For other install methods (setup script, manual), see [Installation Guide](docs/
5555
| [Docker](docs/docker.md) | Docker Compose, GHCR images, Watchtower auto-updates |
5656
| [Updating](docs/updating.md) | How to update (Docker pull, git pull, version check) |
5757

58-
## Quick Model Switching
58+
## Select Newest Model Available
5959

6060
```
6161
/claude-settings action:set-model value:opus
@@ -77,4 +77,25 @@ CATEGORY_NAME=claude-code
7777
WORK_DIR=/path/to/project
7878
```
7979

80-
<img width="250" height="250" alt="image" src="https://github.com/user-attachments/assets/2fea008b-76b7-48d8-9a87-8214cc7a24ad" />
80+
## Startup Options
81+
82+
```bash
83+
# Standard start
84+
deno task start
85+
86+
# Development mode (hot reload)
87+
deno task dev
88+
89+
# Direct with environment variables
90+
deno run --allow-all index.ts
91+
92+
# With optional flags
93+
deno run --allow-all index.ts --category myproject --user-id YOUR_DISCORD_ID
94+
```
95+
96+
| Flag | Env Variable | Description |
97+
| --- | --- | --- |
98+
| `--category <name>` | `CATEGORY_NAME` | Discord category name for channels (default: `claude-code`) |
99+
| `--user-id <id>` | `USER_ID` | Your Discord user ID for mentions when tasks finish |
100+
101+
> CLI flags override environment variables. Environment variables override `.env` file values.

docs/installation.md

Lines changed: 84 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Option 1: Docker (Recommended)
44

5+
Works on all platforms with Docker installed.
6+
57
```bash
68
git clone https://github.com/zebbern/claude-code-discord.git
79
cd claude-code-discord
@@ -10,69 +12,104 @@ cp .env.example .env
1012
docker compose up -d
1113
```
1214

13-
See [Docker Guide](docker.md) for full Docker usage, commands, and GHCR image details.
15+
See [Docker Guide](docker.md) for full Docker usage, GHCR images, and auto-updates.
16+
17+
---
18+
19+
## Option 2: Setup Script
1420

15-
## Option 2: One-Command Setup
21+
### Linux / macOS
1622

17-
**Linux/macOS:**
1823
```bash
1924
git clone https://github.com/zebbern/claude-code-discord.git
2025
cd claude-code-discord
2126
chmod +x setup.sh && ./setup.sh
2227
```
2328

24-
**Windows PowerShell:**
29+
### Windows (PowerShell)
30+
2531
```powershell
2632
git clone https://github.com/zebbern/claude-code-discord.git
2733
cd claude-code-discord
2834
.\setup.ps1
2935
```
3036

31-
The setup script will:
32-
1. Install Deno (if needed)
33-
2. Install Claude CLI (if needed)
34-
3. Create `.env` file with your tokens
35-
4. Initialize git repository (if needed)
36-
5. Offer to start the bot immediately
37+
The setup script handles:
38+
39+
1. Installing Deno (if not found)
40+
2. Installing Claude CLI (if not found)
41+
3. Creating `.env` with your tokens
42+
4. Initializing git repo (if needed)
43+
5. Offering to start the bot
44+
45+
---
3746

3847
## Option 3: Manual Setup
3948

40-
**Install Deno** via [deno.com](https://deno.com/) or:
49+
### Install Deno
50+
51+
**Linux / macOS:**
52+
4153
```bash
42-
# Linux/macOS
4354
curl -fsSL https://deno.land/install.sh | sh
55+
```
4456

45-
# Windows PowerShell
57+
**Windows (PowerShell):**
58+
59+
```powershell
4660
irm https://deno.land/install.ps1 | iex
4761
```
4862

49-
**Clone and configure:**
63+
Or download from [deno.com](https://deno.com/).
64+
65+
### Install Claude CLI
66+
67+
Requires Node.js / npm:
68+
69+
```bash
70+
npm install -g @anthropic-ai/claude-code
71+
claude /login
72+
```
73+
74+
### Clone and Configure
75+
5076
```bash
5177
git clone https://github.com/zebbern/claude-code-discord.git
5278
cd claude-code-discord
5379
cp .env.example .env
54-
# Edit .env with your DISCORD_TOKEN and APPLICATION_ID
5580
```
5681

57-
**Install Claude CLI and login:**
82+
Edit `.env` with your `DISCORD_TOKEN` and `APPLICATION_ID`. See [Configuration](#configuration-env) below.
83+
84+
### Start the Bot
85+
86+
**Linux / macOS:**
87+
5888
```bash
59-
npm install -g @anthropic-ai/claude-code
60-
claude /login
89+
deno task start
6190
```
6291

63-
**Run the bot:**
92+
**Windows (PowerShell):**
93+
94+
```powershell
95+
deno task start
96+
```
97+
98+
**Development mode (hot reload):**
99+
64100
```bash
65-
deno task start # Using .env file (recommended)
66-
deno task dev # Development mode (hot reload)
67-
deno run --allow-all index.ts # Direct execution
101+
deno task dev
68102
```
69103

70-
**Optional flags:**
104+
**With optional flags:**
105+
71106
```bash
72107
deno run --allow-all index.ts --category myproject --user-id YOUR_DISCORD_ID
73108
```
74109

75-
> If you get `not a git directory`, run `git init` first.
110+
> If you get `not a git directory`, run `git init` in the project folder first.
111+
112+
---
76113

77114
## Configuration (.env)
78115

@@ -88,4 +125,26 @@ CATEGORY_NAME=claude-code # Discord category for channels
88125
WORK_DIR=/path/to/project # Working directory (default: current)
89126
```
90127

91-
Environment variables take precedence over `.env` file settings.
128+
Environment variables override `.env` file settings. CLI flags override environment variables.
129+
130+
---
131+
132+
## Platform Notes
133+
134+
### Linux / macOS
135+
136+
- Deno and Claude CLI install via shell one-liners
137+
- Use `chmod +x setup.sh` before running the setup script
138+
- `cp` works natively for `.env.example`
139+
140+
### Windows
141+
142+
- Run PowerShell as Administrator if Deno install requires it
143+
- Use `copy .env.example .env` instead of `cp` if not using Git Bash
144+
- The setup script (`setup.ps1`) handles Windows-specific paths automatically
145+
146+
### Docker (all platforms)
147+
148+
- Docker Desktop required on Windows/macOS, Docker Engine on Linux
149+
- The image bundles Deno, Node.js, and Claude CLI so no local installs needed
150+
- See [Docker Guide](docker.md) for volumes, GHCR, and Watchtower

0 commit comments

Comments
 (0)