@jiawang1209/codex-hud 0.1.0 → 0.1.1
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/CHANGELOG.md +5 -0
- package/README.md +12 -25
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.1.1
|
|
4
|
+
|
|
5
|
+
- Clarify npm, source, and Marketplace installation paths in the README.
|
|
6
|
+
- Normalize the npm binary path generated during publish.
|
|
7
|
+
|
|
3
8
|
## 0.1.0
|
|
4
9
|
|
|
5
10
|
- Add Codex HUD CLI with `status`, `watch`, `doctor`, `config`, `setup`, `run`, `native`, and shim commands.
|
package/README.md
CHANGED
|
@@ -9,33 +9,33 @@ The first version ships with two layers:
|
|
|
9
9
|
|
|
10
10
|
Codex HUD reads local Codex configuration, git metadata, and safe session-log metadata. It uses session event types, tool names, token counters, rate-limit counters, and plan status only; it does not need to display private message bodies.
|
|
11
11
|
|
|
12
|
-
## Install
|
|
12
|
+
## Install
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Install the published package from npm:
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
|
|
18
|
-
cd codex-hud
|
|
19
|
-
npm install
|
|
20
|
-
npm run build
|
|
21
|
-
npm link
|
|
17
|
+
npm install -g @jiawang1209/codex-hud
|
|
22
18
|
codex-hud install
|
|
23
19
|
codex
|
|
24
20
|
```
|
|
25
21
|
|
|
26
|
-
In this flow, `npm install` installs the project's development dependencies and `npm run build` compiles the TypeScript source into `dist/`. `npm link` makes the local `codex-hud` command available globally on your machine.
|
|
27
|
-
|
|
28
22
|
`codex-hud install` prepares the native Codex HUD bundle and installs a reversible `codex` shim, so you can keep launching Codex with the normal `codex` command.
|
|
29
23
|
|
|
30
|
-
## Install From
|
|
24
|
+
## Install From Source
|
|
25
|
+
|
|
26
|
+
Use this when you want to test the latest GitHub version:
|
|
31
27
|
|
|
32
28
|
```bash
|
|
33
|
-
|
|
29
|
+
git clone https://github.com/Jiawang1209/codex-hud.git
|
|
30
|
+
cd codex-hud
|
|
31
|
+
npm install
|
|
32
|
+
npm run build
|
|
33
|
+
npm link
|
|
34
34
|
codex-hud install
|
|
35
35
|
codex
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
In this flow, `npm install` installs the project's development dependencies and `npm run build` compiles the TypeScript source into `dist/`. `npm link` makes the local `codex-hud` command available globally on your machine.
|
|
39
39
|
|
|
40
40
|
## Development Usage
|
|
41
41
|
|
|
@@ -164,19 +164,6 @@ That native launcher starts the patched Codex binary with:
|
|
|
164
164
|
-c 'tui.status_line=["command: codex-hud status"]'
|
|
165
165
|
```
|
|
166
166
|
|
|
167
|
-
For this development machine, the current patched binary is:
|
|
168
|
-
|
|
169
|
-
```bash
|
|
170
|
-
/Users/liuyue/Desktop/Github_repos/openai-codex/codex-rs/target/debug/codex
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
Install the local shim with:
|
|
174
|
-
|
|
175
|
-
```bash
|
|
176
|
-
codex-hud install-shim \
|
|
177
|
-
--codex /Users/liuyue/Desktop/Github_repos/openai-codex/codex-rs/target/debug/codex
|
|
178
|
-
```
|
|
179
|
-
|
|
180
167
|
Remove it and return to the official `codex` command with:
|
|
181
168
|
|
|
182
169
|
```bash
|
package/package.json
CHANGED