@cc-status-line/cli 0.1.5 → 0.1.7

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 (2) hide show
  1. package/README.md.full +37 -24
  2. package/package.json +5 -5
package/README.md.full CHANGED
@@ -26,56 +26,69 @@ cc-status answers all of these in three lines and lets you switch modes with a s
26
26
 
27
27
  ## Install
28
28
 
29
- Pick the easiest path for your machine:
29
+ cc-status is a Rust binary, but you don't need a Rust toolchain — pick whichever channel suits your machine.
30
30
 
31
- ### npm / npx (recommended for Claude Code users)
31
+ > **Heads-up: `npx` is for trying it once. Don't use `npx` to install — Claude Code's `statusLine` runs on every prompt refresh, so you want the binary on PATH.** Use `npm install -g`, `curl`, or Homebrew below.
32
32
 
33
- You already have Node.js if you use Claude Code:
33
+ ### npm (recommended for Claude Code users)
34
34
 
35
- ```sh
36
- # One-shot, no install
37
- npx -y @cc-status-line/cli --version
35
+ You already have Node.js if you use Claude Code.
38
36
 
39
- # Or install globally so the binary is on PATH
37
+ ```sh
40
38
  npm install -g @cc-status-line/cli
41
39
  ccs --version
40
+ ccs setup # writes the statusLine block into ~/.claude/settings.json (with backup)
42
41
  ```
43
42
 
44
- Then in `~/.claude/settings.json`:
43
+ In China? Use a faster mirror once:
45
44
 
46
- ```json
47
- {
48
- "statusLine": {
49
- "type": "command",
50
- "command": "ccs render"
51
- }
52
- }
45
+ ```sh
46
+ npm install -g --registry=https://registry.npmmirror.com @cc-status-line/cli
47
+ ccs setup
53
48
  ```
54
49
 
55
- ### Homebrew (macOS / Linux)
50
+ To **try it without installing** (binary won't stay on PATH afterwards):
56
51
 
57
52
  ```sh
58
- brew install hankeGui/tap/ccs
53
+ npx -y @cc-status-line/cli --version
59
54
  ```
60
55
 
56
+ This is fine for kicking the tires, but for actual Claude Code use you want the global install above.
57
+
61
58
  ### curl install script
62
59
 
63
60
  ```sh
64
61
  curl -fsSL https://raw.githubusercontent.com/hankeGui/cc-status/main/install.sh | sh
62
+ ccs setup
65
63
  ```
66
64
 
67
65
  Installs to `~/.local/bin/ccs`. Pass `--bin-dir` or `--version` to customize.
68
66
 
67
+ ### Homebrew (macOS / Linux)
68
+
69
+ ```sh
70
+ brew install hankeGui/tap/ccs
71
+ ccs setup
72
+ ```
73
+
69
74
  ### Manual download
70
75
 
71
- Pick a tarball from [releases](https://github.com/hankeGui/cc-status/releases), unpack, drop `ccs` somewhere on PATH.
76
+ Pick a tarball from [releases](https://github.com/hankeGui/cc-status/releases), unpack, drop `ccs` somewhere on PATH. Then `ccs setup`.
72
77
 
73
- ### From source (requires Rust)
78
+ ### From source (requires a Rust toolchain)
74
79
 
75
80
  ```sh
76
81
  cargo install --git https://github.com/hankeGui/cc-status --locked
77
82
  ```
78
83
 
84
+ > **Note**: `cargo install` puts the binary at `~/.cargo/bin/ccs`. If `~/.cargo/bin` is not on your PATH, add it (rustup's installer normally does this for you):
85
+ >
86
+ > ```sh
87
+ > export PATH="$HOME/.cargo/bin:$PATH"
88
+ > ```
89
+ >
90
+ > `ccs setup` writes an absolute path either way, so Claude Code finds it even if your shell doesn't.
91
+
79
92
  Or clone and build:
80
93
 
81
94
  ```sh
@@ -85,17 +98,15 @@ cargo build --release
85
98
  cp target/release/ccs ~/.local/bin/
86
99
  ```
87
100
 
88
- After installing, hook it into Claude Code:
101
+ ## After installing — wire it into Claude Code
89
102
 
90
103
  ```sh
91
104
  ccs setup
92
105
  ```
93
106
 
94
- This inspects `~/.claude/settings.json`, shows the proposed `statusLine`
95
- change, asks for confirmation, and writes a backup before saving. Pass
96
- `--yes` to skip the prompt or `--check` to inspect without modifying.
107
+ This inspects `~/.claude/settings.json`, shows the proposed `statusLine` change, prompts y/N, and writes a backup before saving. Pass `--yes` to skip the prompt or `--check` to inspect without modifying. To remove the line later: `ccs setup --uninstall`.
97
108
 
98
- Or do it manually — add this to `~/.claude/settings.json`:
109
+ If you'd rather edit by hand:
99
110
 
100
111
  ```json
101
112
  {
@@ -108,6 +119,8 @@ Or do it manually — add this to `~/.claude/settings.json`:
108
119
 
109
120
  Use absolute paths — Claude Code's status-line shell does not always inherit your login `PATH`.
110
121
 
122
+ Restart Claude Code and the bar appears at the top of every prompt.
123
+
111
124
  ## Three ways to interact
112
125
 
113
126
  cc-status follows a "passive bar + on-demand panel" design. You don't need to read every metric every turn.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cc-status-line/cli",
3
- "version": "0.1.5",
3
+ "version": "0.1.7",
4
4
  "description": "Multi-line, mode-switchable status line for Claude Code (Rust binary, npm-distributed)",
5
5
  "keywords": [
6
6
  "claude-code",
@@ -35,9 +35,9 @@
35
35
  "postinstall": "node postinstall.js || true"
36
36
  },
37
37
  "optionalDependencies": {
38
- "@cc-status-line/darwin-arm64": "0.1.5",
39
- "@cc-status-line/linux-x64": "0.1.5",
40
- "@cc-status-line/linux-arm64": "0.1.5",
41
- "@cc-status-line/win32-x64": "0.1.5"
38
+ "@cc-status-line/darwin-arm64": "0.1.7",
39
+ "@cc-status-line/linux-x64": "0.1.7",
40
+ "@cc-status-line/linux-arm64": "0.1.7",
41
+ "@cc-status-line/win32-x64": "0.1.7"
42
42
  }
43
43
  }