Skip to content

Commit 276f310

Browse files
Rename binary from sessions to cc-session, add install script, extract SSOT
- Rename cmd/sessions/ to cmd/cc-session/ so go install produces correct binary name - Update all usage/error messages, goreleaser config, benchmark script - Move SKILL.md from skill/ to project root, update all references - Rename skill directory from skills/sessions to skills/cc-session everywhere - Extract skillpath package as single source of truth for skill directory name - Add install.sh with --with-skill flag and interactive PATH setup - Update all test fixtures and assertions to match new names Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0192twUPgNxmFCpvpsBk5uqg
1 parent c30c64f commit 276f310

27 files changed

Lines changed: 230 additions & 106 deletions

‎.goreleaser.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 2
22

33
builds:
4-
- main: ./cmd/sessions/
4+
- main: ./cmd/cc-session/
55
binary: cc-session
66
env:
77
- CGO_ENABLED=0

‎README.md‎

Lines changed: 38 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,43 @@ curl -fsSL https://raw.githubusercontent.com/Mapleeeeeeeeeee/cc-session-reader/m
1818
腳本會自動下載對應平台的 binary 並放到 `~/.local/bin/cc-session`(可透過 `INSTALL_DIR` 環境變數覆蓋),
1919
安裝完成後也會詢問是否一併安裝 Claude Code Skill。
2020

21-
### go install(替代方案)
21+
非互動模式下加 `--with-skill` 自動安裝 Skill:
22+
```bash
23+
curl -fsSL https://raw.githubusercontent.com/Mapleeeeeeeeeee/cc-session-reader/main/install.sh | bash -s -- --with-skill
24+
```
25+
26+
### 下載 Binary(不需 Go 環境)
27+
28+
從 [GitHub Releases](https://github.com/Mapleeeeeeeeeee/cc-session-reader/releases) 下載對應平台的 binary,解壓後放到 PATH:
29+
30+
```bash
31+
# macOS ARM64 範例
32+
curl -L https://github.com/Mapleeeeeeeeeee/cc-session-reader/releases/latest/download/cc-session-reader_darwin_arm64.tar.gz | tar xz
33+
mv cc-session /usr/local/bin/
34+
```
35+
36+
### go install
2237

2338
```bash
24-
go install github.com/Mapleeeeeeeeeee/cc-session-reader/cmd/sessions@latest
39+
go install github.com/Mapleeeeeeeeeee/cc-session-reader/cmd/cc-session@latest
2540
```
2641

27-
> 注意:`go install` 依照目錄名稱命名 binary,安裝的 binary 名稱為 `sessions`(而非 `cc-session`)。
28-
> 建議使用安裝腳本或手動下載 release binary 以取得正確的 `cc-session` binary 名稱。
42+
安裝後 `cc-session` binary 會放在 `$GOPATH/bin`(確保該路徑在 PATH 中)。
43+
2944
> 如果 `@latest` 遇到 module path 衝突,用 `GOPROXY=direct go install ...@latest`。
3045
31-
### 作為 Claude Code Skill 使用
46+
### 作為 Claude Code / Agent Skill 使用
3247

33-
安裝腳本執行時會詢問是否安裝 Skill,選擇是即可自動完成設定。
34-
也可以手動將 SKILL.md 放到 `~/.claude/skills/cc-session/` 目錄下:
48+
將 `SKILL.md` 放到 `~/.claude/skills/cc-session/` (或 `~/.gemini/config/skills/cc-session/`) 目錄下:
3549

3650
```bash
51+
# 建立目錄並下載 SKILL.md
3752
mkdir -p ~/.claude/skills/cc-session
3853
curl -o ~/.claude/skills/cc-session/SKILL.md \
39-
https://raw.githubusercontent.com/Mapleeeeeeeeeee/cc-session-reader/main/skill/SKILL.md
54+
https://raw.githubusercontent.com/Mapleeeeeeeeeee/cc-session-reader/main/SKILL.md
4055
```
4156

42-
之後在 Claude Code 中輸入 `/cc-session` 即可觸發。
57+
之後即可在 Agent 工具中自動載入與使用。
4358

4459
## 子命令
4560

@@ -166,24 +181,34 @@ CLI 對特定 injection 類型做額外壓縮,減少 context 噪音:
166181

167182
## Config 設定
168183

169-
`~/.claude/skills/cc-session/config.json` 支援以下欄位:
184+
> 💡 **提示**:此設定檔為**選擇性(Optional)**。若未配置,僅會影響 `stats` 子命令的精確 Token 計算(會自動改用字元估算),其他讀取、過濾與注入等核心功能均不受影響。
185+
186+
若需要精確 Token 統計,可在 `~/.claude/skills/cc-session/config.json` 進行配置。您可以使用專案根目錄的 `config.json.template` 作為範本建立設定:
187+
188+
```bash
189+
mkdir -p ~/.claude/skills/cc-session
190+
curl -o ~/.claude/skills/cc-session/config.json \
191+
https://raw.githubusercontent.com/Mapleeeeeeeeeee/cc-session-reader/main/config.json.template
192+
```
193+
194+
該設定檔支援以下欄位:
170195

171196
```json
172197
{
173-
"anthropic_api_key_file": "/path/to/api-key-file",
198+
"anthropic_api_key_file": "~/.config/anthropic/.env",
174199
"integration_test_session": "<session-id>"
175200
}
176201
```
177202

178203
| 欄位 | 用途 |
179204
|------|------|
180-
| `anthropic_api_key_file` | 指向含 ANTHROPIC_API_KEY 的檔案路徑,啟用精確 token 計算 |
205+
| `anthropic_api_key_file` | 指向含 `ANTHROPIC_API_KEY` 的檔案路徑,啟用精確 token 計算 |
181206
| `integration_test_session` | 本地 integration test 使用的 session ID |
182207

183208
## 架構
184209

185210
```
186-
cmd/sessions/ CLI 入口,子命令路由(binary 名稱為 cc-session)
211+
cmd/cc-session/ CLI 入口,子命令路由
187212
internal/
188213
claudecodec/ JSONL 讀取、noise 過濾、raw→event 解析(TranscriptReader / HeaderScanner 介面)
189214
session/ Domain model(Event, ToolUse, ToolResult, ToolInput)

skill/SKILL.md renamed to SKILL.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ allowed-tools:
99
- Read
1010
---
1111

12+
## 前置檢查
13+
14+
先執行 `cc-session --help` 確認 CLI 可用。如果 command not found,提示使用者安裝:
15+
```bash
16+
curl -fsSL https://raw.githubusercontent.com/Mapleeeeeeeeeee/cc-session-reader/main/install.sh | bash
17+
```
18+
1219
# Session Reader
1320

1421
## 前置檢查

0 commit comments

Comments
 (0)