ccstatusline 1.1.7 โ†’ 1.2.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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +82 -12
  3. package/package.json +3 -7
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 ccstatusline contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,9 +1,34 @@
1
+ <div align="center">
2
+
1
3
  # ccstatusline
2
4
 
3
- > ๐ŸŽจ A highly customizable status line formatter for Claude Code CLI that displays model info, git branch, token usage, and other metrics in your terminal.
5
+ **๐ŸŽจ A highly customizable status line formatter for Claude Code CLI**
6
+ *Display model info, git branch, token usage, and other metrics in your terminal*
7
+
8
+ [![npm version](https://img.shields.io/npm/v/ccstatusline.svg)](https://www.npmjs.com/package/ccstatusline)
9
+ [![npm downloads](https://img.shields.io/npm/dm/ccstatusline.svg)](https://www.npmjs.com/package/ccstatusline)
10
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/sirmalloc/ccstatusline/blob/main/LICENSE)
11
+ [![Node.js Version](https://img.shields.io/node/v/ccstatusline.svg)](https://nodejs.org)
12
+ [![install size](https://packagephobia.com/badge?p=ccstatusline)](https://packagephobia.com/result?p=ccstatusline)
13
+ [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/sirmalloc/ccstatusline/graphs/commit-activity)
4
14
 
5
15
  ![Demo](https://raw.githubusercontent.com/sirmalloc/ccstatusline/main/screenshots/demo.gif)
6
16
 
17
+ </div>
18
+
19
+ ## ๐Ÿ“š Table of Contents
20
+
21
+ - [Recent Updates](#-recent-updates)
22
+ - [Features](#-features)
23
+ - [Quick Start](#-quick-start)
24
+ - [Usage](#-usage)
25
+ - [Development](#๏ธ-development)
26
+ - [Contributing](#-contributing)
27
+ - [License](#-license)
28
+ - [Related Projects](#-related-projects)
29
+
30
+ ---
31
+
7
32
  ## ๐Ÿ†• Recent Updates
8
33
 
9
34
  ### v1.1.0 - Enhanced Customization
@@ -11,6 +36,8 @@
11
36
  - **๐Ÿ”ค Bold Text Styling** - Toggle bold formatting for individual items in Color Configuration menu
12
37
  - **โš™๏ธ Global Options Menu** - New menu for global formatting preferences including padding, separators, color inheritance, and overrides
13
38
 
39
+ ---
40
+
14
41
  ## โœจ Features
15
42
 
16
43
  - **๐Ÿ“Š Real-time Metrics** - Display model name, git branch, token usage, session duration, and more
@@ -22,6 +49,8 @@
22
49
  - **๐Ÿ“ Smart Width Detection** - Automatically adapts to terminal width with flex separators
23
50
  - **โšก Zero Config** - Sensible defaults that work out of the box
24
51
 
52
+ ---
53
+
25
54
  ## ๐Ÿš€ Quick Start
26
55
 
27
56
  ### No installation needed! Use directly with npx:
@@ -44,6 +73,8 @@ The interactive configuration tool provides a terminal UI where you can:
44
73
 
45
74
  > ๐Ÿ’ก **Tip:** Your settings are automatically saved to `~/.config/ccstatusline/settings.json`
46
75
 
76
+ ---
77
+
47
78
  ## ๐Ÿ“– Usage
48
79
 
49
80
  Once configured, ccstatusline automatically formats your Claude Code status line. The status line appears at the bottom of your terminal during Claude Code sessions.
@@ -68,6 +99,8 @@ Once configured, ccstatusline automatically formats your Claude Code status line
68
99
  - **Separator** - Visual divider between items (customizable: |, -, comma, space)
69
100
  - **Flex Separator** - Expands to fill available space
70
101
 
102
+ ---
103
+
71
104
  ### โŒจ๏ธ TUI Controls
72
105
 
73
106
  #### Main Menu
@@ -103,6 +136,8 @@ Configure how flex separators calculate available width:
103
136
  - **Full width minus 40** - Leaves space for auto-compact message (default)
104
137
  - **Full width until compact** - Switches based on context percentage threshold
105
138
 
139
+ ---
140
+
106
141
  ### โš™๏ธ Global Options
107
142
 
108
143
  Configure global formatting preferences that apply to all status items:
@@ -115,7 +150,9 @@ Configure global formatting preferences that apply to all status items:
115
150
  - Press **(p)** to edit padding
116
151
  - Press **(s)** to edit separator
117
152
 
118
- #### Global Formatting
153
+ <details>
154
+ <summary><b>Global Formatting Options</b></summary>
155
+
119
156
  - **Inherit Colors** - Default separators inherit foreground and background colors from the preceding widget
120
157
  - Press **(i)** to toggle
121
158
  - **Global Bold** - Apply bold formatting to all text regardless of individual item settings
@@ -127,6 +164,8 @@ Configure global formatting preferences that apply to all status items:
127
164
  - Press **(b)** to cycle through colors
128
165
  - Press **(c)** to clear override
129
166
 
167
+ </details>
168
+
130
169
  > ๐Ÿ’ก **Note:** These settings are applied during rendering and don't add items to your widget list. They provide a consistent look across your entire status line without modifying individual item configurations.
131
170
 
132
171
  > โš ๏ธ **VSCode Users:** If colors appear incorrect in the VSCode integrated terminal, the "Terminal โ€บ Integrated: Minimum Contrast Ratio" (`terminal.integrated.minimumContrastRatio`) setting is forcing a minimum contrast between foreground and background colors. You can adjust this setting to 1 to disable the contrast enforcement, or use a standalone terminal for accurate colors.
@@ -138,6 +177,8 @@ Some items support "raw value" mode which displays just the value without a labe
138
177
  - Normal: `Session: 2hr 15m` โ†’ Raw: `2hr 15m`
139
178
  - Normal: `Ctx: 18.6k` โ†’ Raw: `18.6k`
140
179
 
180
+ ---
181
+
141
182
  ### ๐Ÿ”ง Custom Widgets
142
183
 
143
184
  #### Custom Text Widget
@@ -160,10 +201,12 @@ Execute shell commands and display their output dynamically:
160
201
  - `curl -s wttr.in?format="%t"` - Show current temperature
161
202
  - `npx -y ccusage statusline` - Display Claude usage metrics (set timeout: 5000ms)
162
203
 
163
- > โš ๏ธ **Note:** Commands should complete quickly to avoid delays. Long-running commands will be killed after the configured timeout. If you're not seeing output from your custom command, try increasing the timeout value (press 't' in the editor).
204
+ > โš ๏ธ **Important:** Commands should complete quickly to avoid delays. Long-running commands will be killed after the configured timeout. If you're not seeing output from your custom command, try increasing the timeout value (press 't' in the editor).
164
205
 
165
206
  > ๐Ÿ’ก **Tip:** Custom commands can be other Claude Code compatible status line formatters! They receive the same JSON via stdin that ccstatusline receives from Claude Code, allowing you to chain or combine multiple status line tools.
166
207
 
208
+ ---
209
+
167
210
  ### ๐Ÿ”— Integration Example: ccusage
168
211
 
169
212
  [ccusage](https://github.com/samuelint/ccusage) is a tool that tracks and displays Claude Code usage metrics. You can integrate it directly into your status line:
@@ -175,12 +218,14 @@ Execute shell commands and display their output dynamically:
175
218
 
176
219
  ![ccusage integration](https://raw.githubusercontent.com/sirmalloc/ccstatusline/main/screenshots/ccusage.png)
177
220
 
178
- The command receives Claude Code's JSON data via stdin, allowing ccusage to access session information, model details, and transcript data for accurate usage tracking.
221
+ > ๐Ÿ“„ **How it works:** The command receives Claude Code's JSON data via stdin, allowing ccusage to access session information, model details, and transcript data for accurate usage tracking.
179
222
 
180
223
  ### โœ‚๏ธ Smart Truncation
181
224
 
182
225
  When terminal width is detected, status lines automatically truncate with ellipsis (...) if they exceed the available width, preventing line wrapping.
183
226
 
227
+ ---
228
+
184
229
  ## ๐Ÿ› ๏ธ Development
185
230
 
186
231
  ### Prerequisites
@@ -234,19 +279,28 @@ Contributions are welcome! Please feel free to submit a Pull Request.
234
279
  4. Push to the branch (`git push origin feature/amazing-feature`)
235
280
  5. Open a Pull Request
236
281
 
282
+ ---
283
+
237
284
  ## ๐Ÿ“„ License
238
285
 
239
286
  [MIT](LICENSE) ยฉ Matthew Breedlove
240
287
 
288
+ ---
289
+
241
290
  ## ๐Ÿ‘ค Author
242
291
 
243
292
  **Matthew Breedlove**
244
293
 
245
294
  - GitHub: [@sirmalloc](https://github.com/sirmalloc)
246
295
 
296
+ ---
297
+
247
298
  ## ๐Ÿ”— Related Projects
248
299
 
249
300
  - [tweakcc](https://github.com/Piebald-AI/tweakcc) - Customize Claude Code themes, thinking verbs, and more.
301
+ - [ccusage](https://github.com/samuelint/ccusage) - Track and display Claude Code usage metrics.
302
+
303
+ ---
250
304
 
251
305
  ## ๐Ÿ™ Acknowledgments
252
306
 
@@ -256,11 +310,27 @@ Contributions are welcome! Please feel free to submit a Pull Request.
256
310
 
257
311
  ---
258
312
 
259
- <p align="center">
260
- <a href="https://www.npmjs.com/package/ccstatusline">
261
- <img src="https://img.shields.io/npm/v/ccstatusline.svg" alt="npm version">
262
- </a>
263
- <a href="https://github.com/sirmalloc/ccstatusline/blob/main/LICENSE">
264
- <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
265
- </a>
266
- </p>
313
+ <div align="center">
314
+
315
+ ### ๐ŸŒŸ Show Your Support
316
+
317
+ Give a โญ if this project helped you!
318
+
319
+ [![GitHub stars](https://img.shields.io/github/stars/sirmalloc/ccstatusline?style=social)](https://github.com/sirmalloc/ccstatusline/stargazers)
320
+ [![GitHub forks](https://img.shields.io/github/forks/sirmalloc/ccstatusline?style=social)](https://github.com/sirmalloc/ccstatusline/network/members)
321
+ [![GitHub watchers](https://img.shields.io/github/watchers/sirmalloc/ccstatusline?style=social)](https://github.com/sirmalloc/ccstatusline/watchers)
322
+
323
+ [![npm version](https://img.shields.io/npm/v/ccstatusline.svg)](https://www.npmjs.com/package/ccstatusline)
324
+ [![npm downloads](https://img.shields.io/npm/dm/ccstatusline.svg)](https://www.npmjs.com/package/ccstatusline)
325
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/sirmalloc/ccstatusline/blob/main/LICENSE)
326
+ [![Made with Bun](https://img.shields.io/badge/Made%20with-Bun-000000.svg?logo=bun)](https://bun.sh)
327
+
328
+ [![Issues](https://img.shields.io/github/issues/sirmalloc/ccstatusline)](https://github.com/sirmalloc/ccstatusline/issues)
329
+ [![Pull Requests](https://img.shields.io/github/issues-pr/sirmalloc/ccstatusline)](https://github.com/sirmalloc/ccstatusline/pulls)
330
+ [![Contributors](https://img.shields.io/github/contributors/sirmalloc/ccstatusline)](https://github.com/sirmalloc/ccstatusline/graphs/contributors)
331
+
332
+ ### ๐Ÿ’ฌ Connect
333
+
334
+ [Report Bug](https://github.com/sirmalloc/ccstatusline/issues) ยท [Request Feature](https://github.com/sirmalloc/ccstatusline/issues) ยท [Discussions](https://github.com/sirmalloc/ccstatusline/discussions)
335
+
336
+ </div>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ccstatusline",
3
- "version": "1.1.7",
3
+ "version": "1.2.0",
4
4
  "description": "A customizable status line formatter for Claude Code CLI",
5
5
  "module": "src/ccstatusline.ts",
6
6
  "type": "module",
@@ -20,16 +20,12 @@
20
20
  "devDependencies": {
21
21
  "@types/bun": "latest",
22
22
  "@types/react": "^19.1.9",
23
- "patch-package": "^8.0.0"
24
- },
25
- "peerDependencies": {
26
- "typescript": "^5"
27
- },
28
- "dependencies": {
23
+ "typescript": "^5",
29
24
  "chalk": "^5.5.0",
30
25
  "ink": "^6.1.0",
31
26
  "ink-gradient": "^3.0.0",
32
27
  "ink-select-input": "^6.2.0",
28
+ "patch-package": "^8.0.0",
33
29
  "react": "^19.1.1"
34
30
  },
35
31
  "keywords": [