Skip to content

Commit 1e1a931

Browse files
committed
Polish README command section
1 parent 4de677d commit 1e1a931

1 file changed

Lines changed: 24 additions & 31 deletions

File tree

README.md

Lines changed: 24 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,29 @@ in a failed or incomplete response.
1212

1313
![Codex Blackbox dashboard demo](demo.png)
1414

15+
## Install
16+
17+
Install a published release:
18+
19+
```bash
20+
curl -fsSL https://raw.githubusercontent.com/softcane/codex-blackbox/main/install.sh | sh
21+
```
22+
23+
Install from source when you want the current checkout:
24+
25+
```bash
26+
git clone https://github.com/softcane/codex-blackbox.git
27+
cd codex-blackbox
28+
cargo install --path codex-blackbox-cli
29+
```
30+
31+
Requirements:
32+
33+
- Docker Desktop or Docker Engine.
34+
- Docker Compose v2, or `docker-compose`.
35+
- Codex CLI.
36+
- A Codex ChatGPT login for subscription mode.
37+
1538
## Start With Your Own Session
1639

1740
Use this when you want to visualize a live Codex session:
@@ -50,29 +73,6 @@ evidence still lives in SQLite and in postmortems.
5073
Tool-call panels show model-side intent only. They do not prove a local tool ran
5174
or completed.
5275

53-
## Install
54-
55-
Install a published release:
56-
57-
```bash
58-
curl -fsSL https://raw.githubusercontent.com/softcane/codex-blackbox/main/install.sh | sh
59-
```
60-
61-
Install from source when you want the current checkout:
62-
63-
```bash
64-
git clone https://github.com/softcane/codex-blackbox.git
65-
cd codex-blackbox
66-
cargo install --path codex-blackbox-cli
67-
```
68-
69-
Requirements:
70-
71-
- Docker Desktop or Docker Engine.
72-
- Docker Compose v2, or `docker-compose`.
73-
- Codex CLI.
74-
- A Codex ChatGPT login for subscription mode.
75-
7676
## Confirm The Machine
7777

7878
```bash
@@ -243,11 +243,7 @@ Token accounting follows the Codex Responses rules:
243243
- reasoning output is output-side detail
244244
- local total tokens are `input + output`
245245

246-
Dollar estimates are intentionally not graphed on the dashboard. Redacted
247-
postmortems label local estimates and whether they are trusted for budget
248-
enforcement.
249-
250-
## Confirmed Command Surface
246+
## Commands
251247

252248
These are the enabled commands documented here:
253249

@@ -263,8 +259,5 @@ codex-blackbox guard
263259
codex-blackbox postmortem last
264260
```
265261

266-
Disabled or unverified surfaces are intentionally not documented as user
267-
features.
268-
269262
Architecture and development notes live in [ARCHITECTURE.md](ARCHITECTURE.md)
270263
and [docs/index.md](docs/index.md).

0 commit comments

Comments
 (0)