sb-codex-tool 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/README.ko.md CHANGED
@@ -37,7 +37,7 @@ workflow/runtime scaffold입니다.
37
37
 
38
38
  ## 요구 사항
39
39
 
40
- - Node.js 25 이상
40
+ - Node.js 24 이상
41
41
  - Codex가 working tree를 읽고 쓸 수 있는 프로젝트
42
42
  - 기본 launch wrapper를 쓸 경우 `codex` 바이너리
43
43
  - 명시적 상태, handoff, verification artifact가 필요한 작업 방식
@@ -66,36 +66,30 @@ npm exec sb-codex-tool -- setup
66
66
 
67
67
  ## 빠른 시작
68
68
 
69
- repository에 scaffold를 초기화합니다.
69
+ 대부분의 팀은 아래 세 명령만 직접 실행하면 됩니다.
70
70
 
71
71
  ```bash
72
- sb-codex-tool setup
72
+ npm exec sb-codex-tool -- setup
73
+ npm exec sb-codex-tool -- doctor
74
+ npm exec sb-codex-tool -- status
73
75
  ```
74
76
 
75
- 현재 scaffold와 운영 상태를 점검합니다.
76
-
77
- ```bash
78
- sb-codex-tool doctor
79
- sb-codex-tool status
80
- ```
77
+ 전역 설치를 썼다면 `npm exec` 없이 `sb-codex-tool`를 직접 호출해도 됩니다.
81
78
 
82
- bounded work cycle을 시작합니다.
79
+ `status`까지 확인했으면 그다음부터는 `Codex-first mode`로 들어가면 됩니다.
80
+ Codex에게 hot path를 읽고, 작업 목표와 제약을 물어본 뒤, plan/state/summary
81
+ 문서를 대신 정리해 달라고 요청하면 됩니다.
83
82
 
84
- ```bash
85
- sb-codex-tool begin add-status-panel "Add Status Panel"
86
- ```
83
+ 예시 프롬프트:
87
84
 
88
- 현재 cycle을 fresh verification 준비 상태로 올립니다.
89
-
90
- ```bash
91
- sb-codex-tool prepare-verify
85
+ ```text
86
+ AGENTS.md와 sb-codex-tool hot path를 읽고 시작해줘. 작업 목표와 제약을
87
+ 먼저 물어본 뒤, plan, state, summary, verification note를 작업에 맞게 같이
88
+ 정리해줘.
92
89
  ```
93
90
 
94
- fresh verification agent가 verdict를 남긴 cycle을 닫습니다.
95
-
96
- ```bash
97
- sb-codex-tool close
98
- ```
91
+ `begin`, `prepare-verify`, `close` 같은 helper 명령은 계속 남아 있지만,
92
+ 이제 기본 사용자 경로가 아니라 고급 수동 모드로 봅니다.
99
93
 
100
94
  ## `setup`이 만드는 것
101
95
 
@@ -123,18 +117,25 @@ AGENTS.md
123
117
 
124
118
  ## 명령어
125
119
 
120
+ ### 기본 사용자 명령
121
+
126
122
  | 명령 | 목적 |
127
123
  | --- | --- |
128
124
  | `sb-codex-tool setup` | scaffold, workflow 자산, 가이드, ignore 파일을 생성합니다. |
129
125
  | `sb-codex-tool doctor` | scaffold 무결성, 현재 cycle 준비도, semantic coherence를 검사합니다. |
130
126
  | `sb-codex-tool status` | 현재 stage, next action, hot path, 최신 run, semantic issue를 보여줍니다. |
127
+ | `sb-codex-tool [codex args]` | 명시적 명령이 없으면 wrapper를 통해 Codex를 실행합니다. |
128
+
129
+ ### 고급 수동 helper 명령
130
+
131
+ | 명령 | 목적 |
132
+ | --- | --- |
131
133
  | `sb-codex-tool begin <slug> [title words]` | plan/summary/handoff/review artifact를 갖는 새 cycle을 엽니다. |
132
134
  | `sb-codex-tool prepare-verify` | 현재 cycle을 verify-ready 상태로 옮기고 handoff를 다시 씁니다. |
133
135
  | `sb-codex-tool close` | fresh verification verdict를 읽어 cycle을 최종 종료합니다. |
134
136
  | `sb-codex-tool assign <agent-name> <slug> [title words]` | subagent용 bounded assignment guide를 생성합니다. |
135
137
  | `sb-codex-tool complete-assignment <agent-name> <close\|clear\|replace> ...` | 완료된 subagent assignment의 lifecycle 처리를 기록합니다. |
136
138
  | `sb-codex-tool review-consistency <agent-name> [title words]` | active cycle에 대한 consistency review artifact를 생성합니다. |
137
- | `sb-codex-tool [codex args]` | 명시적 명령이 없으면 wrapper를 통해 Codex를 실행합니다. |
138
139
 
139
140
  ## 워크플로 모델
140
141
 
@@ -147,18 +148,25 @@ AGENTS.md
147
148
  5. `verify`
148
149
 
149
150
  최종 verification은 항상 fresh agent가 수행합니다. non-trivial 작업은
150
- 일반적으로 `prepare-verify`를 거친 fresh verification을 수행하고, 마지막에
151
- `close`로 닫습니다.
151
+ fresh verification과 verification summary/work journal 정리까지 포함하는
152
+ closure 단계로 끝납니다.
153
+
154
+ ### 기본 Codex-first cycle
155
+
156
+ 1. `setup`, `doctor`, `status`를 실행합니다.
157
+ 2. Codex에게 hot path를 읽고 작업 목표와 제약을 질문하게 합니다.
158
+ 3. Codex가 approved plan과 state 문서를 직접 정리합니다.
159
+ 4. Codex가 구현과 execution summary 갱신을 진행합니다.
160
+ 5. Codex가 단순성, 재사용성, 가독성을 기준으로 refactor합니다.
161
+ 6. Codex가 verification-ready handoff와 next-agent guidance를 정리합니다.
162
+ 7. fresh verification agent가 contract, hot path, 코드, 검증 명령을 독립적으로 확인합니다.
163
+ 8. main Codex agent가 verification summary와 work journal을 정리합니다.
152
164
 
153
- ### 일반적인 cycle
165
+ ### 고급 수동 cycle
154
166
 
155
- 1. `begin`으로 cycle을 엽니다.
156
- 2. approved plan과 scope guide를 실제 작업 내용으로 채웁니다.
157
- 3. 구현을 진행하고 execution summary를 갱신합니다.
158
- 4. 단순성, 재사용성, 가독성을 기준으로 refactor합니다.
159
- 5. `prepare-verify`를 실행해 handoff, state, verification 입력을 정렬합니다.
160
- 6. fresh verification agent가 contract, hot path, 코드, 검증 명령을 독립적으로 확인합니다.
161
- 7. fresh verifier가 verdict를 남긴 뒤 `close`를 실행합니다.
167
+ 명시적인 lifecycle 명령을 선호하면 `begin`, `prepare-verify`, `close` 같은
168
+ helper 명령을 계속 사용할 있습니다. 다만 경로는 기본 사용자 경로가
169
+ 아니라 advanced/manual 모드입니다.
162
170
 
163
171
  ## 상태 구조
164
172
 
@@ -199,6 +207,8 @@ hot-path onboarding은 다음 순서로 시작합니다.
199
207
 
200
208
  - orchestration을 소유합니다.
201
209
  - 사용자 진행 상황을 한국어로 보고합니다.
210
+ - Codex-first mode에서는 plan, summary, handoff, review, work journal을
211
+ 직접 갱신할 수 있습니다.
202
212
  - subagent에 bounded task를 배정합니다.
203
213
  - 최종 통합과 closure를 담당합니다.
204
214
 
package/README.md CHANGED
@@ -37,7 +37,7 @@ work more repeatable inside a normal repository.
37
37
 
38
38
  ## Requirements
39
39
 
40
- - Node.js 25 or newer
40
+ - Node.js 24 or newer
41
41
  - A project where Codex can read and write the working tree
42
42
  - A `codex` binary available when using the default launch wrapper
43
43
  - A workflow that benefits from explicit state, handoff, and verification
@@ -67,36 +67,31 @@ npm exec sb-codex-tool -- setup
67
67
 
68
68
  ## Quick Start
69
69
 
70
- Initialize the scaffold in a repository:
70
+ Most teams only need three direct commands:
71
71
 
72
72
  ```bash
73
- sb-codex-tool setup
73
+ npm exec sb-codex-tool -- setup
74
+ npm exec sb-codex-tool -- doctor
75
+ npm exec sb-codex-tool -- status
74
76
  ```
75
77
 
76
- Inspect the scaffold and operational state:
77
-
78
- ```bash
79
- sb-codex-tool doctor
80
- sb-codex-tool status
81
- ```
78
+ If you installed the package globally, you can drop `npm exec` and call
79
+ `sb-codex-tool` directly.
82
80
 
83
- Start a bounded work cycle:
81
+ After `status`, switch into Codex-first mode. Ask Codex to read the hot path,
82
+ ask for the task goal and constraints, and maintain the remaining plan/state
83
+ artifacts for you.
84
84
 
85
- ```bash
86
- sb-codex-tool begin add-status-panel "Add Status Panel"
87
- ```
85
+ Example prompt:
88
86
 
89
- Prepare the current cycle for fresh verification:
90
-
91
- ```bash
92
- sb-codex-tool prepare-verify
87
+ ```text
88
+ Read AGENTS.md and the sb-codex-tool hot path. Ask me for the task goal and
89
+ constraints, then update the plan, state, summaries, and verification notes as
90
+ we work.
93
91
  ```
94
92
 
95
- Close the cycle after a fresh verification agent records a verdict:
96
-
97
- ```bash
98
- sb-codex-tool close
99
- ```
93
+ The manual helper commands still exist, but they are now the advanced/manual
94
+ path rather than the default human workflow.
100
95
 
101
96
  ## What `setup` Creates
102
97
 
@@ -124,18 +119,25 @@ onboarding, fresh verification, and human-readable work journaling.
124
119
 
125
120
  ## Commands
126
121
 
122
+ ### Default human workflow
123
+
127
124
  | Command | Purpose |
128
125
  | --- | --- |
129
126
  | `sb-codex-tool setup` | Create the scaffold, workflow assets, guides, and ignore files. |
130
127
  | `sb-codex-tool doctor` | Validate scaffold integrity, current-cycle readiness, and semantic coherence. |
131
128
  | `sb-codex-tool status` | Show the current stage, next action, hot path, latest run details, and semantic issues. |
129
+ | `sb-codex-tool [codex args]` | Launch Codex through the wrapper when no explicit command is given. |
130
+
131
+ ### Advanced/manual helpers
132
+
133
+ | Command | Purpose |
134
+ | --- | --- |
132
135
  | `sb-codex-tool begin <slug> [title words]` | Open a new bounded work cycle with plan/summary/handoff/review artifacts. |
133
136
  | `sb-codex-tool prepare-verify` | Move the current cycle into verify-ready state and rewrite the handoff. |
134
137
  | `sb-codex-tool close` | Finalize the current cycle from the recorded fresh verification verdict. |
135
138
  | `sb-codex-tool assign <agent-name> <slug> [title words]` | Create a bounded assignment guide for a subagent. |
136
139
  | `sb-codex-tool complete-assignment <agent-name> <close\|clear\|replace> ...` | Record lifecycle handling for a completed subagent assignment. |
137
140
  | `sb-codex-tool review-consistency <agent-name> [title words]` | Write a bounded consistency review artifact for the active cycle. |
138
- | `sb-codex-tool [codex args]` | Launch Codex through the wrapper when no explicit command is given. |
139
141
 
140
142
  ## Workflow Model
141
143
 
@@ -148,18 +150,27 @@ onboarding, fresh verification, and human-readable work journaling.
148
150
  5. `verify`
149
151
 
150
152
  Final verification is always fresh-agent-only. Non-trivial work is expected to
151
- end with `prepare-verify` and then a fresh verification pass before `close`.
153
+ end with fresh verification and a recorded closure summary.
152
154
 
153
- ### Typical Cycle
155
+ ### Typical Codex-first cycle
154
156
 
155
- 1. Run `begin` to open a new cycle.
156
- 2. Fill the approved plan and scope guide with real work.
157
- 3. Implement the change and update the execution summary.
158
- 4. Refactor for simplicity, reuse, and readability.
159
- 5. Run `prepare-verify` to align handoff, state, and verification inputs.
157
+ 1. Run `setup`, `doctor`, and `status`.
158
+ 2. Ask Codex to read the hot path, clarify the task, and write or update the
159
+ approved plan and state files.
160
+ 3. Let Codex implement the change and keep the execution summary current.
161
+ 4. Let Codex refactor for simplicity, reuse, and readability.
162
+ 5. Let Codex prepare a verification-ready handoff and next-agent guidance.
160
163
  6. Have a fresh verification agent inspect the contracts, hot path, code, and
161
164
  checks.
162
- 7. Run `close` after the fresh verifier records a verdict.
165
+ 7. Let the main Codex agent record the verification summary and update the
166
+ human work journal.
167
+
168
+ ### Manual helper mode
169
+
170
+ If you prefer explicit lifecycle commands, `begin`, `prepare-verify`, `close`,
171
+ `assign`, and the other helper commands are still available. They are useful
172
+ for teams that want CLI-created cycle artifacts instead of asking Codex to
173
+ write those files directly.
163
174
 
164
175
  ## State Layout
165
176
 
@@ -200,6 +211,8 @@ Hot-path onboarding starts with:
200
211
 
201
212
  - Owns orchestration
202
213
  - Reports progress to the user in Korean
214
+ - Can update plans, summaries, handoffs, reviews, and work-journal entries
215
+ directly when operating in Codex-first mode
203
216
  - Assigns bounded work to subagents
204
217
  - Integrates and closes work
205
218
 
package/dist/cli.js CHANGED
@@ -222,7 +222,7 @@ function createInitialCurrentIndex() {
222
222
  return {
223
223
  version: 2,
224
224
  currentStage: "clarify",
225
- nextAction: "Review AGENTS.md and customize .sb-codex-tool/project.md.",
225
+ nextAction: "Review AGENTS.md, run status if needed, and ask Codex to organize the first task.",
226
226
  latestApprovedPlan: null,
227
227
  latestRelevantSummary: null,
228
228
  latestRun: null,
@@ -251,7 +251,8 @@ function createInitialCurrentIndex() {
251
251
  },
252
252
  assignmentGuides: {},
253
253
  notes: [
254
- "Keep this file current enough for a fresh agent to start from the hot path."
254
+ "Keep this file current enough for a fresh agent to start from the hot path.",
255
+ "Default usage is human setup/doctor/status plus Codex-managed plan, state, and summary updates."
255
256
  ]
256
257
  };
257
258
  }
@@ -323,6 +324,14 @@ Read in this order before implementation or verification:
323
324
 
324
325
  ${renderHotPath(current.hotPath)}
325
326
 
327
+ ## Default Operating Mode
328
+
329
+ - Most users run \`setup\`, \`doctor\`, and \`status\` directly.
330
+ - After that, ask Codex to read the hot path, clarify the task, and update
331
+ plans, summaries, handoffs, and state files in-session.
332
+ - Use manual helper commands only when you want explicit CLI-managed cycle
333
+ artifacts.
334
+
326
335
  ## Additional Repo Docs
327
336
 
328
337
  ${renderImplementationReference(implementationMenuPath)}
@@ -508,6 +517,8 @@ verification-friendly.
508
517
 
509
518
  - The main agent owns orchestration and user communication.
510
519
  - Main-agent progress updates to the user are always in Korean.
520
+ - Most users run \`setup\`, \`doctor\`, and \`status\` directly, then let Codex
521
+ update plans, state, summaries, handoffs, and reviews in-session.
511
522
  - Subagents are bounded workers and must be reset or replaced after completion.
512
523
  - Every new implementation agent reads \`${STATE_ROOT_NAME}/guides/code-consistency.md\` first.
513
524
  - The main agent references \`${STATE_ROOT_NAME}/guides/code-consistency.md\` before assigning new work.
@@ -533,6 +544,8 @@ verification-friendly.
533
544
 
534
545
  - Hot path starts with \`${STATE_ROOT_NAME}/project.md\` and \`${STATE_ROOT_NAME}/state.md\`.
535
546
  - Update next-agent guidance after non-trivial code changes.
547
+ - Codex may create or update plan, summary, handoff, and review artifacts
548
+ directly when the team is operating in Codex-first mode.
536
549
  - If new conventions are introduced, update \`${STATE_ROOT_NAME}/guides/code-consistency.md\`.
537
550
 
538
551
  ## Work Journal Rules
@@ -566,6 +579,8 @@ function projectTemplate(context) {
566
579
  - Follow the workflow defined in AGENTS.md.
567
580
  - Keep state inspectable through ${STATE_ROOT_NAME}/.
568
581
  - Optimize for reuse, readability, and low complexity.
582
+ - Most users will run \`setup\`, \`doctor\`, and \`status\` directly, then let
583
+ Codex maintain plans, summaries, handoffs, and reviews during normal work.
569
584
 
570
585
  ## Important Entrypoints
571
586
 
@@ -3514,27 +3529,33 @@ function printHelp() {
3514
3529
  console.log("sb-codex-tool");
3515
3530
  console.log("");
3516
3531
  console.log("Usage:");
3532
+ console.log(" sb-codex-tool setup");
3533
+ console.log(" sb-codex-tool doctor");
3534
+ console.log(" sb-codex-tool status");
3517
3535
  console.log(" sb-codex-tool assign <agent-name> <slug> [title words]");
3518
3536
  console.log(" sb-codex-tool begin <slug> [title words]");
3519
3537
  console.log(" sb-codex-tool close");
3520
3538
  console.log(" sb-codex-tool complete-assignment <agent-name> <close|clear|replace> [replacement-agent] [replacement-slug] [title words]");
3521
3539
  console.log(" sb-codex-tool prepare-verify");
3522
3540
  console.log(" sb-codex-tool review-consistency <agent-name> [title words]");
3523
- console.log(" sb-codex-tool setup");
3524
- console.log(" sb-codex-tool doctor");
3525
- console.log(" sb-codex-tool status");
3526
3541
  console.log(" sb-codex-tool [codex args]");
3527
3542
  console.log("");
3528
- console.log("Commands:");
3543
+ console.log("Default human workflow:");
3544
+ console.log(" setup Create the sb-codex-tool scaffold in the current project.");
3545
+ console.log(" doctor Validate the scaffold and required operational files.");
3546
+ console.log(" status Show current stage, next action, hot path, and git context.");
3547
+ console.log("");
3548
+ console.log("Advanced/manual helpers:");
3529
3549
  console.log(" assign Create a bounded assignment guide and update active subagents.");
3530
3550
  console.log(" begin Create the next work-cycle artifacts and update current state.");
3531
3551
  console.log(" close Finalize the current cycle from the recorded review verdict.");
3532
3552
  console.log(" complete-assignment Record close/clear/replace lifecycle handling for a bounded subagent task.");
3533
3553
  console.log(" prepare-verify Align handoff, run state, and current state for fresh verification.");
3534
3554
  console.log(" review-consistency Create a consistency review artifact and update visible review state.");
3535
- console.log(" setup Create the sb-codex-tool scaffold in the current project.");
3536
- console.log(" doctor Validate the scaffold and required operational files.");
3537
- console.log(" status Show current stage, next action, hot path, and git context.");
3555
+ console.log("");
3556
+ console.log("Codex-first mode:");
3557
+ console.log(" Run setup, doctor, and status yourself.");
3558
+ console.log(" Then ask Codex to read the hot path, clarify the task, and update the plan/state/summaries for you.");
3538
3559
  console.log(" help Show this message.");
3539
3560
  console.log("");
3540
3561
  console.log("When no command is provided, sb-codex-tool launches Codex through the wrapper.");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sb-codex-tool",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Lightweight Codex workflow and runtime scaffold for general software projects.",
5
5
  "license": "UNLICENSED",
6
6
  "publishConfig": {
@@ -45,6 +45,6 @@
45
45
  "esbuild": "^0.27.0"
46
46
  },
47
47
  "engines": {
48
- "node": ">=25.0.0"
48
+ "node": ">=24.0.0"
49
49
  }
50
50
  }