Skip to content

Commit 00fd3f2

Browse files
committed
docs: restructure README with 4-step installation guide
Step 1: VS Code + GitHub Copilot setup - Download VS Code - Install GitHub Copilot extension - Pricing comparison (Free/Pro/Pro+ at $39) - Author recommendation for Claude Opus 4.5 + GPT-5.2 Codex Step 2: Install VSMONSTER Extension (VSIX) Step 3: Install Gateway - git clone, pnpm install - Copy .env.example to .env Step 4: Configure social platform (LINE/Telegram/Discord) - Security warnings for token handling - Direct .env file editing - Links to setup guides Also added: - .env.example with detailed comments - Security warnings in Chinese - Updated version to 0.2.0
1 parent ad66e1f commit 00fd3f2

2 files changed

Lines changed: 192 additions & 64 deletions

File tree

.env.example

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# ╔══════════════════════════════════════════════════════════════════════════════╗
2+
# ║ ║
3+
# ║ 🔐 VSMONSTER 環境變數設定 ║
4+
# ║ ║
5+
# ║ ⚠️ 警告:此檔案包含敏感資訊,請勿外洩! ║
6+
# ║ ⚠️ WARNING: This file contains sensitive data. DO NOT share or commit! ║
7+
# ║ ║
8+
# ║ 使用方式: ║
9+
# ║ 1. 複製此檔案為 .env ║
10+
# ║ 2. 填入你的 Token(從各平台開發者後台取得) ║
11+
# ║ 3. 確保 .env 已加入 .gitignore(預設已加入) ║
12+
# ║ ║
13+
# ╚══════════════════════════════════════════════════════════════════════════════╝
14+
15+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
16+
# 🌐 Gateway 設定
17+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
18+
VSMONSTER_PORT=3000
19+
20+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
21+
# 💚 LINE 設定(選擇使用)
22+
#
23+
# 取得方式:https://developers.line.biz/console/
24+
# 教學文件:docs/setup-line.md
25+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
26+
LINE_CHANNEL_ACCESS_TOKEN=
27+
LINE_CHANNEL_SECRET=
28+
29+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
30+
# 🔵 Telegram 設定(選擇使用)
31+
#
32+
# 取得方式:與 @BotFather 對話,輸入 /newbot
33+
# 教學文件:docs/setup-telegram.md
34+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
35+
TELEGRAM_BOT_TOKEN=
36+
TELEGRAM_WEBHOOK_URL=
37+
38+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
39+
# 🟣 Discord 設定(選擇使用)
40+
#
41+
# 取得方式:https://discord.com/developers/applications
42+
# 教學文件:docs/setup-discord.md
43+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
44+
DISCORD_BOT_TOKEN=
45+
DISCORD_APPLICATION_ID=
46+
DISCORD_PUBLIC_KEY=
47+
48+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
49+
# 🚇 Tunnel 設定(可選)
50+
#
51+
# ngrok: https://dashboard.ngrok.com/get-started/your-authtoken
52+
# Cloudflare Tunnel: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/
53+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
54+
NGROK_AUTHTOKEN=
55+
NGROK_ENABLED=false
56+
NGROK_REGION=ap
57+
58+
# Cloudflare Tunnel(進階用戶)
59+
CLOUDFLARE_TUNNEL_TOKEN=
60+
61+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
62+
# 📊 Mission Control 設定(可選)
63+
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
64+
MISSION_CONTROL_PORT=3001
65+
MONGODB_URI=mongodb://localhost:27017/vsmonster

README.md

Lines changed: 127 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> 把 LINE / Telegram / Discord 的訊息帶進 VS Code Copilot 的本地橋接平台
44
5-
**Version**: 0.0.1 (Preview)
5+
**Version**: 0.2.0 | [CHANGELOG](CHANGELOG.md)
66

77
VSMONSTER 讓你在社群軟體中下指令、追蹤任務進度,所有執行都在你的 VS Code 本機環境完成。
88
專案以 🦞 Moltbot 作為社群連接層,VSMONSTER 專注於 Copilot 與任務流程。
@@ -18,104 +18,167 @@ VSMONSTER 讓你在社群軟體中下指令、追蹤任務進度,所有執行
1818
- **MCP 擴充**:可選的 MCP 服務整合(Email / Browser / File 等)
1919
- **隧道支援**:可用 ngrok 產生公開預覽連結
2020

21-
## 📣 支援平台
21+
---
2222

23-
| 平台 | 說明 | 設定指南 |
24-
|------|------|----------|
25-
| LINE | 適合台灣/日本用戶 | `docs/setup-line.md` |
26-
| Telegram | 設定最簡單 | `docs/setup-telegram.md` |
27-
| Discord | 團隊協作首選 | `docs/setup-discord.md` |
23+
## 🚀 快速開始
2824

29-
## 🧠 工作原理
25+
### Step 1️⃣ 安裝 VS Code 與設定 GitHub Copilot
3026

31-
```
32-
User → 社群平台 → Moltbot → VSMONSTER Gateway → VS Code Extension → Copilot Chat
33-
↘ 任務更新 / 進度回報 / 預覽連結 ←───────────────────────────────────────────↗
34-
```
27+
#### 下載 VS Code
3528

36-
VSMONSTER 將社群訊息轉成任務,交給 VS Code Copilot 執行,並回傳進度與結果到原平台。
29+
前往 [code.visualstudio.com](https://code.visualstudio.com/) 下載並安裝。
30+
31+
#### 設定 GitHub Copilot
32+
33+
在 VS Code 中安裝 **GitHub Copilot** 擴充功能:
34+
1. 開啟 Extensions(`Cmd+Shift+X` / `Ctrl+Shift+X`
35+
2. 搜尋 "GitHub Copilot"
36+
3. 點擊 Install
37+
38+
#### 💰 免費 vs 付費方案
39+
40+
| 方案 | 價格 | 模型 | 適合對象 |
41+
|------|------|------|----------|
42+
| **Free** | $0 | GPT-4o mini, Claude 3.5 Sonnet | 學生、輕度使用者 |
43+
| **Pro** | $10/月 | GPT-4o, Claude 3.5 Sonnet | 一般開發者 |
44+
| **Pro+** | $39/月 | **Claude Opus 4.5**, **GPT-5.2 Codex** | 專業開發者 ⭐ |
45+
| **Business** | $19/用戶/月 | 同 Pro,含管理功能 | 團隊 |
46+
47+
> 💡 **作者推薦**:我個人使用 **$39 Pro+** 方案,因為 **Claude Opus 4.5****GPT-5.2 Codex** 是目前最能勝任複雜編程任務的模型組合。在處理大型專案重構、跨文件修改、架構設計時,這兩個模型的表現遠超其他選項。
3748
3849
---
3950

40-
## 🚀 快速開始(本地開發)
51+
### Step 2️⃣ 安裝 VSMONSTER VS Code 擴充功能
52+
53+
目前擴展尚未發布到 Marketplace,請手動安裝:
54+
55+
```bash
56+
# 先完成 Step 3 的安裝,再執行此指令
57+
pnpm extension:build
58+
```
59+
60+
在 VS Code 中:
61+
1. `Cmd+Shift+P` / `Ctrl+Shift+P`
62+
2. 選擇 **Install from VSIX**
63+
3. 選取 `packages/vscode-extension/vsmonster-*.vsix`
64+
65+
---
4166

42-
### 1) 複製專案與安裝依賴
67+
### Step 3️⃣ 安裝 VSMONSTER Gateway
4368

4469
```bash
45-
git clone https://github.com/your-username/vsmonster.git
70+
# 1. 複製專案
71+
git clone https://github.com/akaiHuang/vsmonster.git
4672
cd vsmonster
73+
74+
# 2. 安裝依賴
4775
pnpm install
76+
77+
# 3. 複製環境變數範本
78+
cp .env.example .env
79+
80+
# 4. 啟動 Gateway
81+
pnpm dev
4882
```
4983

50-
### 2) 設定社群平台
84+
啟動後可驗證狀態:
85+
```
86+
http://localhost:3000/health
87+
```
5188

52-
- **推薦方式**:使用 Moltbot 設定向導
53-
```bash
54-
moltbot onboard
55-
```
89+
---
5690

57-
- **或手動建立設定檔**:放在 `configs/config.json`
91+
### Step 4️⃣ 設定社群平台(擇一)
5892

59-
### 3) 啟動 Gateway
93+
> ⚠️ **安全警告**:以下取得的 Token 是高度敏感資料,請:
94+
> -**絕對不要**分享給任何人
95+
> -**絕對不要**上傳到 GitHub
96+
> -**絕對不要**截圖傳到群組
97+
> - ✅ 只存放在本機的 `.env` 檔案中
98+
99+
#### 選擇你的平台:
100+
101+
| 平台 | 難易度 | 適合對象 | 設定教學 |
102+
|------|--------|----------|----------|
103+
| 💚 **LINE** | ⭐⭐ | 台灣/日本用戶 | [📖 docs/setup-line.md](docs/setup-line.md) |
104+
| 🔵 **Telegram** || 最簡單,推薦新手 | [📖 docs/setup-telegram.md](docs/setup-telegram.md) |
105+
| 🟣 **Discord** | ⭐⭐⭐ | 團隊協作 | [📖 docs/setup-discord.md](docs/setup-discord.md) |
106+
107+
#### 設定方式
108+
109+
1. 依照上方教學取得你的平台 Token
110+
2. 編輯 `.env` 檔案,填入對應的 Token:
60111

61112
```bash
62-
pnpm dev
113+
# 編輯環境變數
114+
nano .env # 或用你喜歡的編輯器
63115
```
64116

65-
啟動後可用以下 API 驗證狀態:
117+
```env
118+
# 💚 LINE(擇一填寫)
119+
LINE_CHANNEL_ACCESS_TOKEN=你的_LINE_Token
120+
LINE_CHANNEL_SECRET=你的_LINE_Secret
66121
122+
# 🔵 Telegram(擇一填寫)
123+
TELEGRAM_BOT_TOKEN=你的_Telegram_Token
124+
125+
# 🟣 Discord(擇一填寫)
126+
DISCORD_BOT_TOKEN=你的_Discord_Token
127+
DISCORD_APPLICATION_ID=你的_Application_ID
67128
```
68-
http://localhost:3000/health
129+
130+
3. 重新啟動 Gateway:
131+
```bash
132+
pnpm dev
69133
```
70134

71-
### 4) 安裝 VS Code Extension
135+
---
72136

73-
目前擴展尚未發布到 Marketplace,請手動安裝:
137+
## 📣 支援平台
138+
139+
| 平台 | 說明 | 設定指南 |
140+
|------|------|----------|
141+
| 💚 LINE | 適合台灣/日本用戶 | [docs/setup-line.md](docs/setup-line.md) |
142+
| 🔵 Telegram | 設定最簡單 | [docs/setup-telegram.md](docs/setup-telegram.md) |
143+
| 🟣 Discord | 團隊協作首選 | [docs/setup-discord.md](docs/setup-discord.md) |
144+
145+
---
146+
147+
## 🧠 工作原理
74148

75-
```bash
76-
pnpm extension:build
149+
```
150+
User → 社群平台 → Moltbot → VSMONSTER Gateway → VS Code Extension → Copilot Chat
151+
↘ 任務更新 / 進度回報 / 預覽連結 ←───────────────────────────────────────────↗
77152
```
78153

79-
在 VS Code 中:
80-
1. `Cmd+Shift+P` / `Ctrl+Shift+P`
81-
2. 選擇 **Install from VSIX**
82-
3. 選取 `packages/vscode-extension/vsmonster-*.vsix`
154+
VSMONSTER 將社群訊息轉成任務,交給 VS Code Copilot 執行,並回傳進度與結果到原平台。
83155

84156
---
85157

86-
## ⚙️ 設定檔與環境變數
87-
88-
VSMONSTER 會依序搜尋以下位置:
89-
90-
1. `configs/config.json`
91-
2. `./config.json`
92-
3. `~/.vsmonster/config.json`
93-
94-
### 範例設定檔
95-
96-
```json
97-
{
98-
"port": 3000,
99-
"channels": {
100-
"telegram": {
101-
"botToken": "YOUR_BOT_TOKEN"
102-
}
103-
},
104-
"tunnel": {
105-
"enabled": false,
106-
"authtoken": "YOUR_NGROK_TOKEN",
107-
"region": "ap"
108-
}
109-
}
158+
## ⚙️ 環境變數設定
159+
160+
所有敏感設定都放在 `.env` 檔案中(已加入 `.gitignore`,不會上傳)。
161+
162+
### 快速設定
163+
164+
```bash
165+
cp .env.example .env # 複製範本
166+
nano .env # 編輯並填入你的 Token
110167
```
111168

112-
### 環境變數
169+
### 環境變數說明
113170

114-
- `VSMONSTER_PORT`
115-
- `LINE_CHANNEL_ACCESS_TOKEN`, `LINE_CHANNEL_SECRET`
116-
- `TELEGRAM_BOT_TOKEN`, `TELEGRAM_WEBHOOK_URL`
117-
- `DISCORD_BOT_TOKEN`, `DISCORD_APPLICATION_ID`, `DISCORD_PUBLIC_KEY`
118-
- `NGROK_AUTHTOKEN`, `NGROK_ENABLED`, `NGROK_REGION`
171+
| 變數 | 說明 | 必填 |
172+
|------|------|------|
173+
| `VSMONSTER_PORT` | Gateway 埠號(預設 3000) ||
174+
| `LINE_CHANNEL_ACCESS_TOKEN` | LINE Bot Token | LINE 用戶 |
175+
| `LINE_CHANNEL_SECRET` | LINE Channel Secret | LINE 用戶 |
176+
| `TELEGRAM_BOT_TOKEN` | Telegram Bot Token | Telegram 用戶 |
177+
| `DISCORD_BOT_TOKEN` | Discord Bot Token | Discord 用戶 |
178+
| `DISCORD_APPLICATION_ID` | Discord App ID | Discord 用戶 |
179+
| `NGROK_AUTHTOKEN` | ngrok 認證 Token | ❌ 可選 |
180+
181+
> 💡 詳細範本請參考 [.env.example](.env.example)
119182
120183
---
121184

0 commit comments

Comments
 (0)