codex-sidecar 0.1.2 → 0.1.3
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 +32 -60
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,86 +1,58 @@
|
|
|
1
1
|
# codex-sidecar
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[English](README.md) | [日本語](README_ja.md)
|
|
4
|
+
|
|
5
|
+
A sidecar CLI that lets Claude Code keep talking to the same Codex thread.
|
|
6
|
+
|
|
7
|
+
Claude Code is the primary executor. Codex Sidecar is the reviewer / design partner sitting next to it. Repeated `ask` calls from the same project directory continue the same Codex-side context.
|
|
4
8
|
|
|
5
9
|
## Install
|
|
6
10
|
|
|
7
11
|
```bash
|
|
8
12
|
npm install -g codex-sidecar
|
|
9
|
-
npx skills add
|
|
13
|
+
npx skills add nora/codex-sidecar
|
|
10
14
|
```
|
|
11
15
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
- Node.js 22+
|
|
15
|
-
- `codex` CLI が使えること
|
|
16
|
-
- `codex app-server --listen stdio://` が動くこと
|
|
17
|
-
|
|
18
|
-
## Why
|
|
16
|
+
Run `npx skills add` from the project root where you want the skill installed. Add `--global` only if you want a global install.
|
|
19
17
|
|
|
20
|
-
|
|
21
|
-
- Codex を senior engineer / reviewer として横に置く
|
|
22
|
-
- broker や Claude Channel を入れず、小さい構成で長いラリーを回せるようにする
|
|
18
|
+
Requirements: Node.js 22+ and OpenAI Codex CLI.
|
|
23
19
|
|
|
24
|
-
##
|
|
20
|
+
## Use from Claude Code
|
|
25
21
|
|
|
26
|
-
|
|
27
|
-
-
|
|
28
|
-
|
|
29
|
-
- Claude Code 側は Bash または plugin からこの CLI を叩く
|
|
30
|
-
- 既定モデルは `gpt-5.4`、既定 reasoning effort は `high`
|
|
31
|
-
- 現状は state file が `.agents/state/codex-sidecar.json` 固定なので、`1 cwd = 1 sidecar session`
|
|
32
|
-
- thread state は各プロジェクト配下の `.agents/state/codex-sidecar.json` に保存する
|
|
22
|
+
```text
|
|
23
|
+
Use $codex-sidecar to review this design and list the top 3 risks.
|
|
24
|
+
```
|
|
33
25
|
|
|
34
|
-
|
|
35
|
-
|
|
26
|
+
```text
|
|
27
|
+
Use $codex-sidecar to focus on the second risk and suggest the smallest safe fix.
|
|
28
|
+
```
|
|
36
29
|
|
|
37
|
-
|
|
30
|
+
The skill calls `codex-sidecar status/start/ask/reset/stop` under the hood.
|
|
38
31
|
|
|
39
|
-
|
|
32
|
+
## CLI
|
|
40
33
|
|
|
41
34
|
```bash
|
|
42
35
|
codex-sidecar start
|
|
43
|
-
codex-sidecar ask "
|
|
44
|
-
codex-sidecar ask "
|
|
36
|
+
codex-sidecar ask "Review this implementation and point out likely regressions."
|
|
37
|
+
codex-sidecar ask "Continue from your previous answer and propose a minimal fix."
|
|
45
38
|
codex-sidecar status
|
|
46
39
|
codex-sidecar reset
|
|
47
|
-
codex-sidecar ask "
|
|
40
|
+
codex-sidecar ask "Start fresh under this new assumption: ..."
|
|
48
41
|
codex-sidecar stop
|
|
49
42
|
```
|
|
50
43
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
pnpm dev -- help
|
|
57
|
-
pnpm dev -- start
|
|
58
|
-
pnpm dev -- ask "この設計の弱点を挙げて"
|
|
59
|
-
pnpm dev -- status
|
|
60
|
-
pnpm dev -- reset
|
|
61
|
-
pnpm dev -- stop
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## Recovery
|
|
65
|
-
|
|
66
|
-
- `codex-sidecar status` で現在の thread / state を確認する
|
|
67
|
-
- `ask` が resume/state エラーなら `codex-sidecar reset`
|
|
68
|
-
- state file を強制的に消したいなら `codex-sidecar stop`
|
|
69
|
-
|
|
70
|
-
## Quality
|
|
71
|
-
|
|
72
|
-
ローカル CI の入口は `pnpm qc`。
|
|
73
|
-
|
|
74
|
-
- `pnpm lint`
|
|
75
|
-
- `pnpm fmt:check`
|
|
76
|
-
- `pnpm typecheck`
|
|
77
|
-
- `pnpm test`
|
|
78
|
-
- `pnpm build`
|
|
44
|
+
- `start`: create and save a new Codex thread
|
|
45
|
+
- `ask <message>`: send a message to the active thread and print Codex's reply
|
|
46
|
+
- `status`: show the saved thread state and default model settings
|
|
47
|
+
- `reset`: archive the current thread and switch to a new one
|
|
48
|
+
- `stop`: archive the current thread and delete local state
|
|
79
49
|
|
|
80
|
-
|
|
50
|
+
## Session model
|
|
81
51
|
|
|
82
|
-
|
|
52
|
+
- State file: `.agents/state/codex-sidecar.json` under each project directory
|
|
53
|
+
- Current limit: 1 directory = 1 sidecar session
|
|
54
|
+
- Default model: `gpt-5.4`
|
|
55
|
+
- Default reasoning effort: `high`
|
|
56
|
+
- No daemon: each command launches `codex app-server`, resumes the saved thread, runs one operation, and exits
|
|
83
57
|
|
|
84
|
-
-
|
|
85
|
-
- [tasks/progress.md](tasks/progress.md): 軽量ロードマップと進捗チェックリスト
|
|
86
|
-
- [AGENTS.md](AGENTS.md): リポジトリ運用ルール
|
|
58
|
+
If `ask` fails with a state/resume error, run `codex-sidecar status`, then `codex-sidecar reset` if needed. Use `codex-sidecar stop` for a hard cleanup.
|