@chongdashu/cc-statusline 1.2.0 → 1.2.2
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 +44 -35
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
<div align="center">
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**A beautiful, informative statusline for Claude Code**
|
|
6
6
|
|
|
7
|
-
<img src="docs/images/cc-statusline
|
|
7
|
+
<img src="docs/images/cc-statusline.png" alt="cc-statusline in action" width="600">
|
|
8
8
|
|
|
9
9
|
*Real-time directory, git branch, model info, costs, and session time tracking*
|
|
10
10
|
|
|
@@ -16,58 +16,65 @@
|
|
|
16
16
|
|
|
17
17
|
## ⚡ Quick Start
|
|
18
18
|
|
|
19
|
-
**One command. Two questions.
|
|
19
|
+
**One command. Two questions. Custom statusline.**
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
npx @chongdashu/cc-statusline init
|
|
22
|
+
npx @chongdashu/cc-statusline@latest init
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
That's it! Answer 2 simple questions, restart Claude Code, and enjoy your new statusline.
|
|
26
26
|
|
|
27
|
-
## 🎯 Setup
|
|
27
|
+
## 🎯 Simple Setup
|
|
28
28
|
|
|
29
29
|
<img src="docs/images/cc-statusline-init.gif" alt="Demo of cc-statusline setup" width="500">
|
|
30
30
|
|
|
31
31
|
## ✨ What You Get
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
Enhance your Claude Code terminal with useful information:
|
|
34
34
|
|
|
35
|
-
- **📁
|
|
36
|
-
- **🌿 Git Integration** - Current branch name
|
|
37
|
-
- **🤖 Model
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
35
|
+
- **📁 Directory Display** - Current folder with `~` abbreviation
|
|
36
|
+
- **🌿 Git Integration** - Current branch name
|
|
37
|
+
- **🤖 Model Info** - Shows which Claude model you're using plus Claude Code version
|
|
38
|
+
- **🧠 Context Usage** - Real-time context window usage with progress bars
|
|
39
|
+
- **💰 Cost Tracking** - Live cost monitoring with burn rates via ccusage
|
|
40
|
+
- **⌛ Session Timer** - Time remaining until usage limit resets
|
|
41
|
+
- **📊 Token Analytics** - Token consumption and burn rate metrics
|
|
42
|
+
- **🎨 Color Support** - 256-color palette for Claude Code terminals
|
|
43
|
+
- **⚡ Fast Execution** - Optimized bash script with <100ms execution time
|
|
43
44
|
|
|
44
45
|
## 🎛️ Features Overview
|
|
45
46
|
|
|
46
|
-
### 🔥 Default Features (Pre-selected)
|
|
47
|
+
### 🔥 Default Features (All Pre-selected in v1.2.2+)
|
|
47
48
|
| Feature | Description | Example |
|
|
48
49
|
|---------|-------------|---------|
|
|
49
50
|
| 📁 **Directory** | Current working directory | `~/my-project` |
|
|
50
|
-
| 🌿 **Git Branch** | Active git branch | `
|
|
51
|
-
| 🤖 **Model** | Claude model name & version | `
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
55
|
-
|
|
51
|
+
| 🌿 **Git Branch** | Active git branch | `feature/statusline` |
|
|
52
|
+
| 🤖 **Model** | Claude model name & version | `Sonnet 4` |
|
|
53
|
+
| 📟 **Claude Code** | Claude Code version | `v1.0.85` |
|
|
54
|
+
| 🎨 **Output Style** | Current output style setting | `default` |
|
|
55
|
+
| 🧠 **Context** | Remaining context with progress bar | `83% [========--]` |
|
|
56
|
+
| 💰 **Cost** | Live costs with highlighted burn rate | `$49.00 ($16.55/h)` |
|
|
57
|
+
| ⌛ **Session** | Time until reset with progress | `3h 7m until reset at 01:00 (37%) [===-------]` |
|
|
58
|
+
|
|
59
|
+
### 🚀 Power Features (Also Pre-selected)
|
|
56
60
|
| Feature | Description | Example |
|
|
57
61
|
|---------|-------------|---------|
|
|
58
|
-
| 📊 **
|
|
59
|
-
| ⚡ **Burn Rate** | Tokens per minute | `847 tpm` |
|
|
62
|
+
| 📊 **Tokens** | Token consumption with burn rate | `14638846 tok (279900 tpm)` |
|
|
60
63
|
|
|
61
64
|
### 🎨 Example Outputs
|
|
62
65
|
|
|
63
|
-
**
|
|
66
|
+
**New 3-Line Modern Layout (v1.2.2+):**
|
|
64
67
|
```
|
|
65
|
-
📁 ~/
|
|
68
|
+
📁 ~/Projects/cc-statusline 🌿 feature/context-usage-output-styles 🤖 Sonnet 4 📟 v1.0.85 🎨 default
|
|
69
|
+
🧠 Context Remaining: 83% [========--] ⌛ 3h 7m until reset at 01:00 (37%) [===-------]
|
|
70
|
+
💰 $49.00 ($16.55/h) 📊 14638846 tok (279900 tpm)
|
|
66
71
|
```
|
|
67
72
|
|
|
68
|
-
**
|
|
73
|
+
**Compact Mode:**
|
|
69
74
|
```
|
|
70
|
-
📁 ~/
|
|
75
|
+
📁 ~/my-app 🌿 main 🤖 Claude Sonnet 📟 v1.0.85
|
|
76
|
+
🧠 Context Remaining: 95% [=========-]
|
|
77
|
+
💰 $2.48 ($12.50/h)
|
|
71
78
|
```
|
|
72
79
|
|
|
73
80
|
## 🛠️ Advanced Usage
|
|
@@ -99,18 +106,18 @@ npm install -g @chongdashu/cc-statusline
|
|
|
99
106
|
|
|
100
107
|
## 🔧 How It Works
|
|
101
108
|
|
|
102
|
-
###
|
|
109
|
+
### How It Works
|
|
103
110
|
|
|
104
|
-
1. **🎯
|
|
105
|
-
2. **🏗️
|
|
106
|
-
3. **⚙️
|
|
107
|
-
4. **🔄
|
|
111
|
+
1. **🎯 Configuration** - Two questions configure your preferences
|
|
112
|
+
2. **🏗️ Generation** - Creates optimized bash script tailored to your needs
|
|
113
|
+
3. **⚙️ Installation** - Integrates with Claude Code settings
|
|
114
|
+
4. **🔄 Updates** - Connects to ccusage for live usage statistics
|
|
108
115
|
|
|
109
116
|
### Technical Architecture
|
|
110
117
|
|
|
111
118
|
- **⚡ Bash-First** - Native shell execution for maximum speed
|
|
112
|
-
- **🎨
|
|
113
|
-
- **🌍 Environment Respect** - Honors `NO_COLOR` and other conventions
|
|
119
|
+
- **🎨 Claude Code Optimized** - Forces colors for Claude Code terminals (respects NO_COLOR)
|
|
120
|
+
- **🌍 Environment Respect** - Honors `NO_COLOR` and other terminal conventions
|
|
114
121
|
- **📦 Zero Dependencies** - Self-contained script with graceful fallbacks
|
|
115
122
|
- **🔒 Secure** - No network requests except ccusage integration
|
|
116
123
|
|
|
@@ -169,6 +176,8 @@ If auto-configuration fails, simply add this to `.claude/settings.json`:
|
|
|
169
176
|
- **Install jq**: `brew install jq` (macOS) or `apt install jq` (Ubuntu)
|
|
170
177
|
- **ccusage setup**: Works automatically via `npx ccusage@latest`
|
|
171
178
|
- **Git not found**: Install git for branch display
|
|
179
|
+
- **Context not showing**: Ensure you're in an active Claude Code session with context usage
|
|
180
|
+
- **Colors not working**: Check that NO_COLOR environment variable is not set
|
|
172
181
|
|
|
173
182
|
## 🚀 Performance
|
|
174
183
|
|
|
@@ -183,7 +192,7 @@ If auto-configuration fails, simply add this to `.claude/settings.json`:
|
|
|
183
192
|
|
|
184
193
|
## 🤝 Contributing
|
|
185
194
|
|
|
186
|
-
|
|
195
|
+
Contributions are welcome!
|
|
187
196
|
|
|
188
197
|
**Quick Start:**
|
|
189
198
|
```bash
|