claudecode-dashboard 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,106 @@
1
+ # ClaudeCode Dashboard
2
+
3
+ CLI dashboard for viewing Claude Code configurations.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ # npm
9
+ npm install -g claudecode-dashboard
10
+
11
+ # bun
12
+ bun add -g claudecode-dashboard
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ ```bash
18
+ # Interactive TUI
19
+ claudecode-dashboard
20
+ ccd # short alias
21
+
22
+ # JSON output (all configs)
23
+ ccd --json
24
+
25
+ # Specific category
26
+ ccd skills
27
+ ccd agents --json
28
+ ccd mcp
29
+
30
+ # Pipe to jq
31
+ ccd skills --json | jq '.[].name'
32
+ ```
33
+
34
+ ## Keyboard Shortcuts
35
+
36
+ | Key | Action |
37
+ |-----|--------|
38
+ | ↑↓ / jk | Navigate items |
39
+ | ←→ / hl | Switch panels |
40
+ | PgUp / u | Page up (10 items) |
41
+ | PgDn / d | Page down (10 items) |
42
+ | Enter | Select/expand |
43
+ | r | Refresh |
44
+ | q | Quit |
45
+
46
+ ## Config Locations
47
+
48
+ | Config | Path |
49
+ |--------|------|
50
+ | Settings | `~/.claude/settings.json` |
51
+ | Skills | `~/.claude/skills/` |
52
+ | Agents | `~/.claude/agents/` |
53
+ | Commands | `~/.claude/commands/` |
54
+ | Hooks | `~/.claude/settings.json` → `hooks` |
55
+ | MCP Servers | `~/.mcp.json` + `./.mcp.json` |
56
+ | Plugins | `~/.claude/plugins/` |
57
+
58
+ ## AI Summaries (Optional)
59
+
60
+ The dashboard shows a 30-line preview of skill/agent/command files by default.
61
+ For AI-generated summaries, set one of these environment variables:
62
+
63
+ ```bash
64
+ # Option 1: Anthropic Claude (recommended)
65
+ export ANTHROPIC_API_KEY=sk-ant-...
66
+
67
+ # Option 2: OpenAI
68
+ export OPENAI_API_KEY=sk-...
69
+ ```
70
+
71
+ **Models Used:**
72
+ - Anthropic: `claude-haiku-4-5-latest` (fast, efficient)
73
+ - OpenAI: `gpt-5.2-mini` (fast, cheap)
74
+
75
+ **Features:**
76
+ - Summaries are cached in `~/.claude/claudecode-dashboard/cache.json`
77
+ - Cache invalidates automatically when files change
78
+ - Status bar shows current provider and model
79
+ - Without API key: shows `Preview` (first 30 lines of markdown)
80
+
81
+ **Privacy:** Your API key is used locally only. No data is sent anywhere except to the LLM provider you configure.
82
+
83
+ ## Requirements
84
+
85
+ - Terminal width: 80+ columns
86
+ - Node.js 20+ or Bun 1.2+
87
+
88
+ ## Development
89
+
90
+ ```bash
91
+ # Install dependencies
92
+ bun install
93
+
94
+ # Run in development
95
+ bun run dev
96
+
97
+ # Build
98
+ bun run build
99
+
100
+ # Type check
101
+ bun run type-check
102
+ ```
103
+
104
+ ## License
105
+
106
+ MIT