@fbincon/claude-code-statusline 3.0.0-beta.1 → 3.1.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 +389 -59
- package/candidate.json +169 -144
- package/node_modules/@fbincon/statusline-cli/dist/src/config/arguments.js +9 -2
- package/node_modules/@fbincon/statusline-cli/dist/src/config/arguments.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/config/commands.js +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/config/preferences.js +8 -7
- package/node_modules/@fbincon/statusline-cli/dist/src/config/preferences.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/help.js +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/help.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/integration/doctor.js +2 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/integration/doctor.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/integration/mod-ownership.js +2 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/integration/mod-ownership.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/integration/model.js +2 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/integration/model.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/main.js +4 -4
- package/node_modules/@fbincon/statusline-cli/dist/src/main.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/recovery/journal.js +6 -5
- package/node_modules/@fbincon/statusline-cli/dist/src/recovery/journal.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/rendering/environment.js +2 -2
- package/node_modules/@fbincon/statusline-cli/dist/src/rendering/environment.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/rendering/preview.js +2 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/rendering/preview.js.map +1 -1
- package/node_modules/@fbincon/statusline-cli/dist/src/ui/protocol.d.ts +1 -1
- package/node_modules/@fbincon/statusline-cli/resources/statusline-native/.claude-plugin/plugin.json +1 -1
- package/node_modules/@fbincon/statusline-cli/resources/statusline-native/lib/generated-contracts.ts +4 -4
- package/node_modules/@fbincon/statusline-cli/resources/statusline-native/lib/i18n/generated-locales.ts +1779 -407
- package/node_modules/@fbincon/statusline-cli/resources/statusline-native/lib/i18n/index.ts +3 -3
- package/node_modules/@fbincon/statusline-cli/resources/statusline-native/resource-manifest.json +7 -7
- package/node_modules/@fbincon/statusline-cli/resources/statusline-runtime/.claude-plugin/plugin.json +1 -1
- package/node_modules/@fbincon/statusline-cli/resources/statusline-runtime/resource-manifest.json +3 -3
- package/node_modules/@fbincon/statusline-core/dist/src/config/backend-preferences.js +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/config/backend-preferences.js.map +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/config/display.js +2 -2
- package/node_modules/@fbincon/statusline-core/dist/src/config/display.js.map +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/config/editor-fields.js +3 -0
- package/node_modules/@fbincon/statusline-core/dist/src/config/editor-fields.js.map +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/contracts/ui.d.ts +3 -3
- package/node_modules/@fbincon/statusline-core/dist/src/contracts/ui.js +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/generated-locales.d.ts +1775 -406
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/generated-locales.js +1779 -407
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/generated-locales.js.map +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/messages.d.ts +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/messages.js +3 -3
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/messages.js.map +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/registry.d.ts +3 -1
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/registry.js +7 -2
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/registry.js.map +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/statusline/{zh-Hant.d.ts → zh-HK.d.ts} +19 -19
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/statusline/{zh-Hant.js → zh-HK.js} +20 -20
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/statusline/zh-HK.js.map +1 -0
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/statusline/zh-TW.d.ts +222 -0
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/statusline/zh-TW.js +224 -0
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/statusline/zh-TW.js.map +1 -0
- package/node_modules/@fbincon/statusline-core/dist/src/node-runtime.d.ts +6 -0
- package/node_modules/@fbincon/statusline-core/dist/src/node-runtime.js +15 -0
- package/node_modules/@fbincon/statusline-core/dist/src/node-runtime.js.map +1 -0
- package/node_modules/@fbincon/statusline-core/dist/src/release.d.ts +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/release.js +1 -1
- package/node_modules/@fbincon/statusline-core/dist/src/release.js.map +1 -1
- package/node_modules/@fbincon/statusline-core/resources/i18n/languages.json +24 -5
- package/node_modules/@fbincon/statusline-core/resources/i18n/locales/en.json +1 -1
- package/node_modules/@fbincon/statusline-core/resources/i18n/locales/ja.json +1 -1
- package/node_modules/@fbincon/statusline-core/resources/i18n/locales/ko.json +1 -1
- package/node_modules/@fbincon/statusline-core/resources/i18n/locales/zh-CN.json +1 -1
- package/node_modules/@fbincon/statusline-core/resources/i18n/locales/{zh-Hant.json → zh-HK.json} +400 -400
- package/node_modules/@fbincon/statusline-core/resources/i18n/locales/zh-TW.json +1367 -0
- package/node_modules/@fbincon/statusline-platform/dist/src/files.d.ts +9 -0
- package/node_modules/@fbincon/statusline-platform/dist/src/files.js +34 -1
- package/node_modules/@fbincon/statusline-platform/dist/src/files.js.map +1 -1
- package/node_modules/@fbincon/statusline-tui/dist/src/drawing.d.ts +2 -4
- package/node_modules/@fbincon/statusline-tui/dist/src/drawing.js +34 -17
- package/node_modules/@fbincon/statusline-tui/dist/src/drawing.js.map +1 -1
- package/node_modules/@fbincon/statusline-tui/dist/src/theme.d.ts +7 -0
- package/node_modules/@fbincon/statusline-tui/dist/src/theme.js +5 -0
- package/node_modules/@fbincon/statusline-tui/dist/src/theme.js.map +1 -0
- package/package.json +3 -3
- package/node_modules/@fbincon/statusline-core/dist/src/i18n/statusline/zh-Hant.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,91 +1,421 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Claude Code Statusline
|
|
2
2
|
|
|
3
|
-
**English** | [简体中文](https://github.com/fbincon/claude-code-statusline/blob/v3.
|
|
3
|
+
**English** | [简体中文](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/README.zh-CN.md)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[](https://github.com/fbincon/claude-code-statusline/actions/workflows/ci.yml)
|
|
6
|
+
[npm](https://www.npmjs.com/package/@fbincon/claude-code-statusline)
|
|
7
|
+
[MIT License](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/LICENSE)
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
A Claude Code status line for Linux, WSL, Windows, and macOS. See model and reasoning effort, directory, Git, context, usage limits, tokens, and task timing at a glance. Configure the main line and individual subagent rows through an in-session editor, a terminal UI, a wizard, or the CLI.
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
[Features](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/README.md#features) · [Screenshots](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/README.md#screenshots) · [Quick installation](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/README.md#quick-installation) · [Common configuration](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/README.md#common-configuration) · [User guide](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md) · [Troubleshooting](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#troubleshooting)
|
|
10
12
|
|
|
11
|
-
|
|
13
|
+
<a id="phase-4-in-stable-v150"></a>
|
|
14
|
+
<a id="phase-5-in-stable-v160"></a>
|
|
15
|
+
<a id="v161-clearer-external-tui-sections"></a>
|
|
12
16
|
|
|
13
|
-
|
|
17
|
+
## Features
|
|
14
18
|
|
|
15
|
-
|
|
19
|
+
- **Compose your statusline:** add, copy and arrange independent components, literal text and left/right alignment in either editor. [Composition guide](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/COMPOSITION.md).
|
|
20
|
+
- **Control visibility and appearance:** hide confirmed empty/clean states, set usage thresholds, choose per-item foreground/background colors and themes, and opt into basic [Powerline](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/APPEARANCE.md).
|
|
21
|
+
- **Choose your languages:** English, 简体中文, 繁體中文, 日本語 and 한국어 for interfaces and actual statusline output, independently; interface changes save immediately, output language saves with display settings. See [language examples](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/languages/README.md).
|
|
22
|
+
- **Find what to show:** 60 main metrics and 14 subagent metrics, plus text and flexible spacers, with ranked multilingual search, category filters and source/requirement guidance.
|
|
23
|
+
- **Track the right scope:** session token totals, per-task subagent rows, and total task time covering queueing, agents and main-agent wrap-up; optional execution time excludes verified user waits.
|
|
24
|
+
- **Adjust presentation:** model and number formats, labels, built-in icons, colors, directory styles, and automatic or explicit rows with priorities and width limits.
|
|
25
|
+
- **Keep Unicode intact:** joined emoji, combining marks and CJK text stay together when rows wrap, clip or appear in previews.
|
|
26
|
+
- **Review configuration changes:** six editable presets and portable JSON, with import differences and candidate previews before accepting a draft and saving.
|
|
27
|
+
- **Choose an editor:** Main, Subagents, Settings, and Layout pages share the same configuration. Claude appearance and behavior preferences use a separate Apply action.
|
|
28
|
+
- **Follow Claude themes:** the in-session editor adapts text, keys and selection to the applied theme; sample previews retain production colors on a separately chosen light/dark background.
|
|
29
|
+
- **Follow terminal colors:** external TUI text and bold keys use terminal defaults, with cyan headings; previews show the selected palette on the current terminal background.
|
|
30
|
+
- **Enable optional live metrics:** runtime state, agent count, tool progress, request timing, and per-task usage are opt-in. Missing or partial observations stay distinguishable.
|
|
16
31
|
|
|
17
|
-
|
|
32
|
+
Rendering uses Claude Code input and local state without making network requests or using model tokens. The question-and-answer wizard uses Claude model turns. See [field definitions](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/DISPLAY_ITEMS.md) for data sources and availability.
|
|
18
33
|
|
|
19
|
-
|
|
34
|
+
<a id="界面预览"></a>
|
|
20
35
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
36
|
+
## Screenshots
|
|
37
|
+
|
|
38
|
+
[Component instances, copies and left/right layout captures](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/composition/README.md).
|
|
39
|
+
|
|
40
|
+
[Search, categories, source guidance and import review captures](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/README.md#discovery-and-import-review).
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
The main status line at the bottom of session screenshots shows actual data; configuration Preview regions use fixed samples. Fonts, colors and widths depend on terminal settings. [Image sources and archive](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/README.md).
|
|
44
|
+
|
|
45
|
+
<details>
|
|
46
|
+
<summary>English / 简体中文 configuration</summary>
|
|
47
|
+
|
|
48
|
+
Linux terminal captures show the shared language selector and Chinese interface. These are reconstructions of actual PTY cells with sample previews; [sources and all pages](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/README.md#bilingual-terminal-captures).
|
|
49
|
+
|
|
50
|
+

|
|
51
|
+
|
|
52
|
+

|
|
53
|
+
|
|
54
|
+

|
|
55
|
+
|
|
56
|
+
</details>
|
|
57
|
+
|
|
58
|
+
### In-session TUI
|
|
59
|
+
|
|
60
|
+
Run `/statusline-configure-native` inside the current Claude Code session, then click the Client region once before using the keyboard. The editor follows the Claude theme; choose the preview background to match the terminal and compare the selected palette. [Compare terminal/theme combinations](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/development/native.md#terminal-background-previews).
|
|
61
|
+
|
|
62
|
+
**Linux: Main and the status line**
|
|
63
|
+
|
|
64
|
+

|
|
65
|
+
|
|
66
|
+
<details>
|
|
67
|
+
<summary>Linux: Subagents, Settings, Layout</summary>
|
|
68
|
+
|
|
69
|
+
**Subagents: choose items and ordering for individual agent rows.**
|
|
70
|
+
|
|
71
|
+

|
|
72
|
+
|
|
73
|
+
**Settings: adjust appearance, refresh behavior and formatting.**
|
|
74
|
+
|
|
75
|
+

|
|
76
|
+
|
|
77
|
+
**Layout: set rows, item priorities and maximum widths.**
|
|
78
|
+
|
|
79
|
+

|
|
80
|
+
|
|
81
|
+
</details>
|
|
82
|
+
|
|
83
|
+
<details>
|
|
84
|
+
<summary>Linux: light and dark themes</summary>
|
|
85
|
+
|
|
86
|
+
Earlier theme captures used a dark preview surface; the current editor offers a separate light/dark preview choice. These images reconstruct real terminal cells. [Capture provenance](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/README.md#theme-terminal-captures).
|
|
87
|
+
|
|
88
|
+

|
|
89
|
+
|
|
90
|
+

|
|
91
|
+
|
|
92
|
+
</details>
|
|
93
|
+
|
|
94
|
+
<details>
|
|
95
|
+
<summary>Windows: Main, Subagents, Settings, Layout</summary>
|
|
96
|
+
|
|
97
|
+
**Main: select and reorder main status line items.**
|
|
98
|
+
|
|
99
|
+

|
|
100
|
+
|
|
101
|
+
**Subagents: choose items and ordering for individual agent rows.**
|
|
102
|
+
|
|
103
|
+

|
|
104
|
+
|
|
105
|
+
**Settings: adjust appearance, refresh behavior and formatting.**
|
|
106
|
+
|
|
107
|
+

|
|
108
|
+
|
|
109
|
+
**Layout: set rows, item priorities and maximum widths.**
|
|
110
|
+
|
|
111
|
+

|
|
112
|
+
|
|
113
|
+
</details>
|
|
114
|
+
|
|
115
|
+
<details>
|
|
116
|
+
<summary>macOS: Main</summary>
|
|
117
|
+
|
|
118
|
+
Only Main was supplied for this batch. The existing interaction limitation and checks are documented in [macOS mouse reporting and Client focus](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#macos-mouse-reporting-and-client-focus).
|
|
119
|
+
|
|
120
|
+
**Main: select and reorder main status line items.**
|
|
121
|
+
|
|
122
|
+

|
|
123
|
+
|
|
124
|
+
</details>
|
|
125
|
+
|
|
126
|
+
### External TUI
|
|
127
|
+
|
|
128
|
+
Run `/statusline-configure` in Claude Code, or `claude-statusline configure` in a standalone terminal.
|
|
129
|
+
|
|
130
|
+
<details>
|
|
131
|
+
<summary>Linux: light/dark backgrounds and palette comparison</summary>
|
|
132
|
+
|
|
133
|
+
Previews use the current terminal background and selected palette. Compare `ansi` in Settings when `default` looks faint. These are terminal-output reconstructions from dedicated GNOME profiles; [capture sources](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/README.md#external-terminal-color-captures).
|
|
134
|
+
|
|
135
|
+
**Light background, Palette: default**
|
|
136
|
+
|
|
137
|
+

|
|
138
|
+
|
|
139
|
+
**Light background, Palette: ansi**
|
|
140
|
+
|
|
141
|
+

|
|
142
|
+
|
|
143
|
+
**Dark background, Palette: default**
|
|
144
|
+
|
|
145
|
+

|
|
146
|
+
|
|
147
|
+
</details>
|
|
148
|
+
|
|
149
|
+
<details>
|
|
150
|
+
<summary>Linux: Main, Subagents, Settings, Layout</summary>
|
|
151
|
+
|
|
152
|
+
**Main: select and reorder main status line items.**
|
|
153
|
+
|
|
154
|
+

|
|
155
|
+
|
|
156
|
+
**Subagents: choose items and ordering for individual agent rows.**
|
|
157
|
+
|
|
158
|
+

|
|
159
|
+
|
|
160
|
+
**Settings: adjust appearance, refresh behavior and formatting.**
|
|
161
|
+
|
|
162
|
+

|
|
163
|
+
|
|
164
|
+
**Layout: set rows, item priorities and maximum widths.**
|
|
165
|
+
|
|
166
|
+

|
|
167
|
+
|
|
168
|
+
</details>
|
|
169
|
+
|
|
170
|
+
<details>
|
|
171
|
+
<summary>Windows: Main, Subagents, Settings, Layout</summary>
|
|
172
|
+
|
|
173
|
+
**Main: select and reorder main status line items.**
|
|
174
|
+
|
|
175
|
+

|
|
176
|
+
|
|
177
|
+
**Subagents: choose items and ordering for individual agent rows.**
|
|
178
|
+
|
|
179
|
+

|
|
180
|
+
|
|
181
|
+
**Settings: adjust appearance, refresh behavior and formatting.**
|
|
182
|
+
|
|
183
|
+

|
|
184
|
+
|
|
185
|
+
**Layout: set rows, item priorities and maximum widths.**
|
|
186
|
+
|
|
187
|
+

|
|
188
|
+
|
|
189
|
+
</details>
|
|
190
|
+
|
|
191
|
+
<details>
|
|
192
|
+
<summary>macOS: Main, Subagents, Settings, Layout</summary>
|
|
193
|
+
|
|
194
|
+
**Main: select and reorder main status line items.**
|
|
195
|
+
|
|
196
|
+

|
|
197
|
+
|
|
198
|
+
**Subagents: choose items and ordering for individual agent rows.**
|
|
199
|
+
|
|
200
|
+

|
|
201
|
+
|
|
202
|
+
**Settings: adjust appearance, refresh behavior and formatting.**
|
|
203
|
+
|
|
204
|
+

|
|
205
|
+
|
|
206
|
+
**Layout: set rows, item priorities and maximum widths.**
|
|
207
|
+
|
|
208
|
+

|
|
209
|
+
|
|
210
|
+
</details>
|
|
211
|
+
|
|
212
|
+
Earlier screenshots and terminal reconstructions remain in the [archive](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/archive/README.md).
|
|
213
|
+
|
|
214
|
+
## Supported platforms
|
|
215
|
+
|
|
216
|
+
| Platform | Supported environment |
|
|
217
|
+
| --- | --- |
|
|
218
|
+
| Linux / WSL | Node 22.x or 24.x, x64 |
|
|
219
|
+
| Windows 10/11 | Node 22.x or 24.x, x64 |
|
|
220
|
+
| macOS 14+ | Node 22.x or 24.x, Intel / Apple Silicon |
|
|
221
|
+
|
|
222
|
+
Windows ARM devices use x64 Node under emulation; native Windows ARM64 and 32-bit runtimes are outside the current support contract. Git information requires `git`.
|
|
223
|
+
|
|
224
|
+
Claude Code feature requirements: subagent rows 2.1.205+; local argument-based configuration and external TUI entry 2.1.258+; in-session Client 2.1.287+; native timing and advanced live-metrics collection 2.1.289+. Unsupported or unknown host versions suspend the corresponding integration. See [requirements](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#requirements).
|
|
225
|
+
|
|
226
|
+
<a id="install-current-source"></a>
|
|
227
|
+
<a id="install-from-a-release-recommended"></a>
|
|
228
|
+
<a id="install-source-at-a-fixed-tag"></a>
|
|
229
|
+
<a id="从-release-安装推荐"></a>
|
|
230
|
+
<a id="从固定标签源码安装"></a>
|
|
231
|
+
<a id="从当前源码安装"></a>
|
|
232
|
+
<a id="升级与卸载"></a>
|
|
233
|
+
<a id="常用配置"></a>
|
|
234
|
+
<a id="快速安装"></a>
|
|
235
|
+
<a id="接入-claude-code"></a>
|
|
236
|
+
<a id="支持范围"></a>
|
|
237
|
+
<a id="文档与帮助"></a>
|
|
238
|
+
<a id="许可证"></a>
|
|
239
|
+
|
|
240
|
+
## Quick installation
|
|
241
|
+
|
|
242
|
+
Install Node 22.x or 24.x with npm and Claude Code CLI. One npm package includes the supported native dependencies and needs no Python or compiler. [Existing Python installation and rollback](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#upgrading).
|
|
243
|
+
|
|
244
|
+
### Install the package
|
|
245
|
+
|
|
246
|
+
Bash, Zsh, and PowerShell:
|
|
247
|
+
|
|
248
|
+
```text
|
|
249
|
+
npm install --global --ignore-scripts @fbincon/claude-code-statusline
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Integrate with Claude Code
|
|
253
|
+
|
|
254
|
+
Ensure the npm command directory is on PATH, then run:
|
|
255
|
+
|
|
256
|
+
```text
|
|
257
|
+
claude-statusline --version
|
|
258
|
+
claude-statusline install --dry-run
|
|
259
|
+
claude-statusline install
|
|
260
|
+
claude-statusline doctor
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
On Windows, use `claude-statusline.cmd`, or invoke the installed JavaScript entry with Node. Restart Claude Code in a trusted terminal after integration.
|
|
264
|
+
|
|
265
|
+
Both editors default on for compatible hosts, respecting saved disablement preferences. Native timing and advanced live metrics both require explicit opt-in on compatible hosts; saved choices are preserved. Package installation and Claude integration are separate steps; `install` does not open an editor. Existing conflicting resources require [explicit handling](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#handle-an-existing-status-line-or-skill-with-the-same-name).
|
|
266
|
+
|
|
267
|
+
<details>
|
|
268
|
+
<summary>Other installation methods</summary>
|
|
269
|
+
|
|
270
|
+
Source development on main uses Node and TypeScript; follow the [source development guide](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/development/README.md#build-and-install-from-source). Release attachments support offline npm installation; the installation guide covers fixed versions and Python recovery.
|
|
271
|
+
|
|
272
|
+
Download checksums and platform-specific instructions are in the [installation guide](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#installation-and-integration); source builds are in the [development guide](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/development/README.md#build-and-install-from-source).
|
|
273
|
+
|
|
274
|
+
</details>
|
|
275
|
+
|
|
276
|
+
## Common configuration
|
|
277
|
+
|
|
278
|
+
[Find items, understand their sources, and review imports](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#item-discovery-import-review).
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
| Entry point | Use |
|
|
282
|
+
| --- | --- |
|
|
283
|
+
| `/statusline-configure-native` | Client TUI in the current session; see [native editor](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#native-configuration-editor) |
|
|
284
|
+
| `/statusline-configure` | TUI in a supported external terminal; see [external entry](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#external-terminal-statusline-configure) |
|
|
285
|
+
| `claude-statusline configure` | Full TUI in the current standalone terminal |
|
|
286
|
+
| `/statusline-config` | Claude question-and-answer wizard; supported argument-based commands execute locally on compatible hosts |
|
|
287
|
+
| `claude-statusline config ...` | Inspect settings, set exact ordering, or configure from scripts |
|
|
288
|
+
|
|
289
|
+
<a id="v130a2-external-tui-and-in-session-client"></a>
|
|
290
|
+
|
|
291
|
+
### Interface language
|
|
292
|
+
|
|
293
|
+
Both editors have **Interface language (saved immediately)** in Settings, with choices **English / 简体中文 / 繁體中文(台灣) / 繁體中文(香港) / 日本語 / 한국어**. The default is English. Switching keeps your page, selection, search and unsaved display edits; cancelling display changes keeps the language choice. Other open windows read it when reopened or reloaded.
|
|
294
|
+
|
|
295
|
+
```text
|
|
296
|
+
claude-statusline config language set ja
|
|
297
|
+
claude-statusline config language show
|
|
298
|
+
claude-statusline config language reset
|
|
299
|
+
claude-statusline --language en --help
|
|
31
300
|
```
|
|
32
301
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
node "$previewEntry" install --config-dir "$previewConfig"
|
|
43
|
-
node "$previewEntry" doctor --config-dir "$previewConfig"
|
|
44
|
-
node "$previewEntry" configure --config-dir "$previewConfig"
|
|
302
|
+
`--language en|zh-CN|zh-TW|zh-HK|ja|ko` precedes the command and affects only that invocation; for `configure` it sets the initial language. Commands, IDs, configuration values and custom text retain their values. Interface language does not change output language. See [language settings](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#interface-language).
|
|
303
|
+
|
|
304
|
+
### Statusline language
|
|
305
|
+
|
|
306
|
+
Choose **Statusline language (save with display settings)** → **English / 简体中文 / 繁體中文(台灣) / 繁體中文(香港) / 日本語 / 한국어** in either editor. Preview switches immediately; Save changes the actual main and subagent output on the next refresh, while Cancel discards the draft. English is the default.
|
|
307
|
+
|
|
308
|
+
```text
|
|
309
|
+
claude-statusline config set statusline-language zh-TW
|
|
310
|
+
claude-statusline config set statusline-language en
|
|
45
311
|
```
|
|
46
312
|
|
|
47
|
-
|
|
313
|
+

|
|
48
314
|
|
|
49
|
-
|
|
315
|
+

|
|
50
316
|
|
|
51
|
-
|
|
317
|
+
These are [real CLI terminal captures with fixed input](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/images/README.md#statusline-language-captures).
|
|
52
318
|
|
|
53
|
-
|
|
319
|
+
Built-in labels and known states are translated. Technical units, model names, branches, paths and custom text are preserved. See [output language](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#statusline-language).
|
|
54
320
|
|
|
55
|
-
|
|
56
|
-
- `claude-code-statusline-3.0.0-beta.1-source.tar.gz`
|
|
57
|
-
- `build-manifest.json`
|
|
58
|
-
- `SHA256SUMS`
|
|
321
|
+
### Native configuration editor
|
|
59
322
|
|
|
60
|
-
|
|
323
|
+
Click the Client region once. Use Tab to change pages, Space to toggle, arrows to select or reorder, Ctrl+E for item formatting and source guidance, `/` to search, and Ctrl+F for categories. Clear filters before reordering. `S` saves and stays, `F` saves and closes, and `Q` discards unsaved changes; lowercase letters work too. Footer controls follow the current page or input mode. Ctrl+G cancels input. Claude preferences apply separately.
|
|
61
324
|
|
|
62
|
-
|
|
325
|
+
### External and standalone terminal TUI
|
|
63
326
|
|
|
64
|
-
|
|
65
|
-
2. Check dry-run, install, doctor, reinstall and explicit editor disablement; inspect before-image backups.
|
|
66
|
-
3. Test `claude-statusline configure` through the explicit entry, then `/statusline-configure` and `/statusline-configure-native` in the selected Claude configuration. Verify keyboard/mouse focus, resize, Unicode, themes, save/cancel and terminal restoration.
|
|
67
|
-
4. Check main/subagent rendering with existing or captured sessions, independent UI/output languages, display edits and portable import/export. Do not treat sample previews as live-data evidence.
|
|
68
|
-
5. Test explicit recovery and rollback below. Report pass/fail/unverified for each applicable item; no screenshot or CI run alone proves sleep/resume correctness.
|
|
327
|
+
Use Tab to change pages, Space to toggle, and arrows to select or reorder. Ctrl+S saves after field input is finished; Enter saves on item and original settings rows, or edits/confirms advanced fields. Esc cancels input first, then cancels the editor; Ctrl+C interrupts without saving. The minimum terminal size is 64×18.
|
|
69
328
|
|
|
70
|
-
|
|
329
|
+
The external entry uses tmux or GNOME Terminal on Linux, tmux or Terminal.app on macOS, and the system's new-console launcher on Windows. For SSH or unavailable launchers, run `claude-statusline configure` in the current terminal.
|
|
71
330
|
|
|
72
|
-
|
|
331
|
+
Define a compact main line:
|
|
73
332
|
|
|
74
|
-
|
|
333
|
+
```text
|
|
334
|
+
claude-statusline config set-items model-with-effort current-dir git context-remaining task-timer
|
|
335
|
+
claude-statusline config set directory-style home
|
|
336
|
+
claude-statusline config show
|
|
337
|
+
```
|
|
75
338
|
|
|
76
|
-
|
|
339
|
+
Configuration is per user. `set-items` replaces the enabled set; `enable` and `disable` make incremental changes. See [recipes](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#configuration-recipes), [formatting and layouts](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#formatting-layout-presets), and the [CLI reference](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/reference/cli.md).
|
|
77
340
|
|
|
78
|
-
|
|
341
|
+
<a id="upgrade-to-v161"></a>
|
|
79
342
|
|
|
80
|
-
|
|
343
|
+
## Upgrading and uninstalling
|
|
81
344
|
|
|
82
|
-
|
|
345
|
+
Upgrade the package, synchronize integration, then restart Claude Code:
|
|
83
346
|
|
|
84
347
|
```text
|
|
85
|
-
npm
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
npm run acceptance:terminal -- launch --mode direct --output NEW_DIRECTORY --artifact ABSOLUTE_TGZ --commit FULL_SHA --installed-root INSTALLED_PACKAGE_ROOT
|
|
348
|
+
npm install --global --ignore-scripts @fbincon/claude-code-statusline
|
|
349
|
+
claude-statusline install
|
|
350
|
+
claude-statusline doctor
|
|
89
351
|
```
|
|
90
352
|
|
|
91
|
-
|
|
353
|
+
Existing Python installations should first follow the [migration and rollback procedure](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#migrate-the-previous-distribution-name). Saved display settings, runtime state, and integration preferences remain. For older display schemas or package downgrade, follow [version compatibility](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#version-compatibility).
|
|
354
|
+
|
|
355
|
+
Remove Claude integration before uninstalling the package:
|
|
356
|
+
|
|
357
|
+
```text
|
|
358
|
+
claude-statusline uninstall --dry-run
|
|
359
|
+
claude-statusline uninstall
|
|
360
|
+
npm uninstall --global @fbincon/claude-code-statusline
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
Display settings and backups remain available; see [uninstalling](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md#uninstalling).
|
|
364
|
+
|
|
365
|
+
## Project structure
|
|
366
|
+
|
|
367
|
+
```text
|
|
368
|
+
claude-code-statusline/
|
|
369
|
+
├── .github/workflows/
|
|
370
|
+
│ ├── ci.yml # Candidate build, eight installations and thirteen hosts
|
|
371
|
+
│ └── reference.yml # Manual historical Python verification
|
|
372
|
+
├── packages/ # Four business packages
|
|
373
|
+
│ ├── core/src/ # Configuration, protocols, pure state, rendering and Unicode
|
|
374
|
+
│ │ └── i18n/ # Registry-generated languages; sources in core/resources
|
|
375
|
+
│ ├── platform/src/ # Files, locks, processes, clocks and terminal adapters
|
|
376
|
+
│ ├── cli/ # Commands, integration, runtime and recovery
|
|
377
|
+
│ │ ├── src/ # Installation and editor protocols
|
|
378
|
+
│ │ └── resources/ # Two configuration skill templates
|
|
379
|
+
│ └── tui/src/ # Standalone terminal editor
|
|
380
|
+
├── mods/
|
|
381
|
+
│ ├── statusline-native/ # In-session editor: hooks, lib, ui, tests
|
|
382
|
+
│ └── statusline-runtime/ # Timing and optional live metrics
|
|
383
|
+
├── tests/fixtures/ # Shared contracts, Unicode and frozen reference data
|
|
384
|
+
├── tools/
|
|
385
|
+
│ ├── generation/ # Shared resource generation
|
|
386
|
+
│ ├── checks/ # Documentation, archive and aggregate checks
|
|
387
|
+
│ ├── build/ # Fixed sources, universal offline packaging and digests
|
|
388
|
+
│ ├── acceptance/ # Installation, Mods, terminals, power and budgeted acceptance
|
|
389
|
+
│ ├── benchmarks/ # Functional fixtures and optional descriptive measurement
|
|
390
|
+
│ ├── release/ # Candidate evidence and release-note preparation
|
|
391
|
+
│ ├── migration/ # Stage ledgers, frozen references and compatibility tests
|
|
392
|
+
│ ├── testing/ # Development-only test support package
|
|
393
|
+
│ ├── typescript/ # Runtime constraints and test entry points
|
|
394
|
+
│ └── unicode/ # Pinned data, provenance and licenses
|
|
395
|
+
├── archive/python/ # Frozen Python implementation, tests, tools and publishing workflows
|
|
396
|
+
├── docs/ # Usage, development, migration and historical releases
|
|
397
|
+
│ ├── reference/ # CLI and configuration reference
|
|
398
|
+
│ ├── development/ # Architecture, testing and stage records
|
|
399
|
+
│ ├── images/ # UI screenshots and historical captures
|
|
400
|
+
│ └── releases/ # Historical release notes
|
|
401
|
+
├── package.json / package-lock.json
|
|
402
|
+
├── tsconfig*.json / .node-version
|
|
403
|
+
├── README.md / README.zh-CN.md
|
|
404
|
+
├── CHANGELOG.md / CHANGELOG.zh-CN.md
|
|
405
|
+
└── LICENSE
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
## Documentation and help
|
|
409
|
+
|
|
410
|
+
- [User guide](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/USER_GUIDE.md): installation, editors, recipes, upgrades, and troubleshooting.
|
|
411
|
+
- [CLI reference](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/reference/cli.md): commands, options, fields, files, and exit codes.
|
|
412
|
+
- [Display items and metric definitions](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/DISPLAY_ITEMS.md): scope, sources, and availability.
|
|
413
|
+
- [Development guide](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/development/README.md) · [Release process](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/docs/RELEASING.md).
|
|
414
|
+
- [Changelog](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/CHANGELOG.md) · [GitHub Releases](https://github.com/fbincon/claude-code-statusline/releases).
|
|
415
|
+
- [GitHub Issues](https://github.com/fbincon/claude-code-statusline/issues): include versions, reproduction steps, and diagnostic results; remove private paths and session content.
|
|
416
|
+
|
|
417
|
+
## License
|
|
418
|
+
|
|
419
|
+
[MIT License](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/LICENSE). Copyright (c) 2026 [fbincon](https://github.com/fbincon).
|
|
420
|
+
|
|
421
|
+
Bundled Unicode data retains the [Unicode License v3](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/tools/unicode/UNICODE-LICENSE.txt) and the [wcwidth MIT notice](https://github.com/fbincon/claude-code-statusline/blob/v3.1.0/tools/unicode/WCWIDTH-LICENSE.txt).
|