@duypham93/openkit 0.2.0 → 0.2.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/.opencode/README.md +1 -1
- package/AGENTS.md +1 -1
- package/README.md +4 -4
- package/context/core/project-config.md +3 -3
- package/docs/maintainer/README.md +1 -1
- package/docs/operations/README.md +1 -1
- package/docs/operations/internal-records/2026-03-24-release-checklist.md +8 -8
- package/docs/operations/internal-records/2026-03-24-simplified-install-ux.md +3 -3
- package/docs/operations/runbooks/openkit-daily-usage.md +2 -2
- package/docs/operations/runbooks/workflow-state-smoke-tests.md +2 -2
- package/docs/operator/README.md +2 -2
- package/docs/plans/2026-03-23-openkit-global-install-runtime.md +2 -2
- package/package.json +1 -1
- package/src/cli/commands/help.js +1 -1
- package/tests/cli/openkit-cli.test.js +1 -1
package/.opencode/README.md
CHANGED
package/AGENTS.md
CHANGED
|
@@ -40,7 +40,7 @@ Current repository facts:
|
|
|
40
40
|
- The current workflow contract is the hard-split design described in `context/core/workflow.md`
|
|
41
41
|
- `context/core/workflow.md` is the canonical workflow-semantics document for lane behavior, stages, escalation, approvals, and quick-lane artifact expectations
|
|
42
42
|
- Historical planning and example docs have been intentionally pruned from the working tree; prefer current runtime docs and git history when older rationale is needed
|
|
43
|
-
- `npm install -g openkit`, `openkit run`, `openkit doctor`, `openkit upgrade`, and `openkit uninstall` now define the preferred operator path for the global OpenKit kit
|
|
43
|
+
- `npm install -g @duypham93/openkit`, `openkit run`, `openkit doctor`, `openkit upgrade`, and `openkit uninstall` now define the preferred operator path for the global OpenKit kit
|
|
44
44
|
- `.opencode/opencode.json` is present as the runtime manifest for this kit
|
|
45
45
|
- `.opencode/workflow-state.json` is present as the active external compatibility mirror for the active work item
|
|
46
46
|
- `.opencode/work-items/` is present as the internal per-item workflow backing store for managed runtime state
|
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ This repository currently contains two active surface types:
|
|
|
28
28
|
|
|
29
29
|
1. **Global managed kit path**
|
|
30
30
|
- the `openkit` CLI now installs the kit into the OpenCode home directory
|
|
31
|
-
- install the CLI with `npm install -g openkit`, then use `openkit run` and `openkit doctor` as the intended operator path
|
|
31
|
+
- install the CLI with `npm install -g @duypham93/openkit`, then use `openkit run` and `openkit doctor` as the intended operator path
|
|
32
32
|
- global workspace state is created per project under the OpenCode home directory instead of copying the kit into each repository
|
|
33
33
|
|
|
34
34
|
2. **Checked-in authoring and compatibility runtime**
|
|
@@ -79,7 +79,7 @@ The preferred product path is now the globally installed OpenKit kit. This repos
|
|
|
79
79
|
|
|
80
80
|
Preferred global path:
|
|
81
81
|
|
|
82
|
-
1. Run `npm install -g openkit` to install the CLI once on the machine.
|
|
82
|
+
1. Run `npm install -g @duypham93/openkit` to install the CLI once on the machine.
|
|
83
83
|
2. Run `openkit run <args>` to launch `opencode --profile openkit`; on first run, OpenKit materializes the global kit into the OpenCode home directory automatically.
|
|
84
84
|
3. Run `openkit doctor` to confirm the global install and current workspace are healthy.
|
|
85
85
|
4. Run `openkit upgrade` to refresh the installed global kit when a newer package version is available.
|
|
@@ -114,7 +114,7 @@ Install-direction guardrails:
|
|
|
114
114
|
|
|
115
115
|
Repository-internal vs global-kit summary:
|
|
116
116
|
|
|
117
|
-
- Global-kit user path: `npm install -g openkit`, `openkit run`, `openkit doctor`, `openkit upgrade`, and `openkit uninstall`
|
|
117
|
+
- Global-kit user path: `npm install -g @duypham93/openkit`, `openkit run`, `openkit doctor`, `openkit upgrade`, and `openkit uninstall`
|
|
118
118
|
- Global kit lives under the OpenCode home directory, not inside each project
|
|
119
119
|
- Repository-internal authoring surface remains: `.opencode/opencode.json`, workflow-state files, the workflow-state CLI, hooks, agents, skills, commands, context, and maintained docs
|
|
120
120
|
- The checked-in runtime remains useful for maintainers and compatibility testing even though end-user installation is now global-first
|
|
@@ -282,7 +282,7 @@ The command surface above is the current live interface. The live contract keeps
|
|
|
282
282
|
|
|
283
283
|
For normal day-to-day use:
|
|
284
284
|
|
|
285
|
-
- prefer `npm install -g openkit`, then `openkit run`, `openkit doctor`, `openkit upgrade`, and `openkit uninstall`
|
|
285
|
+
- prefer `npm install -g @duypham93/openkit`, then `openkit run`, `openkit doctor`, `openkit upgrade`, and `openkit uninstall`
|
|
286
286
|
- use the lower-level checked-in runtime path below when you are maintaining or validating this repository itself
|
|
287
287
|
|
|
288
288
|
1. Run `node .opencode/workflow-state.js status` to see whether work is already in progress.
|
|
@@ -12,7 +12,7 @@ For the canonical workflow contract, including lane semantics, stage order, esca
|
|
|
12
12
|
- There is no single canonical package manager or language toolchain for future applications yet.
|
|
13
13
|
- OpenKit uses the mode-aware workflow documented in `context/core/workflow.md`; keep tooling and command guidance here aligned with that live contract instead of re-stating lane policy in full.
|
|
14
14
|
- The active compatibility mirror uses a mode-aware schema and `.opencode/workflow-state.js` supports that workflow model.
|
|
15
|
-
- The preferred operator install path is now global: `npm install -g openkit`, then `openkit run` and `openkit doctor`.
|
|
15
|
+
- The preferred operator install path is now global: `npm install -g @duypham93/openkit`, then `openkit run` and `openkit doctor`.
|
|
16
16
|
- The checked-in repository-local runtime still exists as the authoring and compatibility surface under `.opencode/`.
|
|
17
17
|
- `registry.json` and `.opencode/install-manifest.json` are additive local metadata surfaces; they do not imply destructive install or plugin-only packaging.
|
|
18
18
|
- Repository-internal runtime surfaces still include workflow state, workflow-state CLI, hooks, agents, skills, commands, context, and maintained docs.
|
|
@@ -37,7 +37,7 @@ For the canonical workflow contract, including lane semantics, stage order, esca
|
|
|
37
37
|
|
|
38
38
|
These are repository workflow commands, not application build/lint/test commands:
|
|
39
39
|
|
|
40
|
-
- `npm install -g openkit`
|
|
40
|
+
- `npm install -g @duypham93/openkit`
|
|
41
41
|
- `openkit install-global`
|
|
42
42
|
- `openkit doctor`
|
|
43
43
|
- `openkit run [args]`
|
|
@@ -78,7 +78,7 @@ These are repository workflow commands, not application build/lint/test commands
|
|
|
78
78
|
Current workflow-state behavior:
|
|
79
79
|
|
|
80
80
|
- The CLI understands the current mode-aware workflow model.
|
|
81
|
-
- `npm install -g openkit` installs the OpenKit CLI globally.
|
|
81
|
+
- `npm install -g @duypham93/openkit` installs the OpenKit CLI globally.
|
|
82
82
|
- `openkit run` materializes the globally managed kit into the OpenCode home directory on first use when needed.
|
|
83
83
|
- `openkit doctor` checks the global install and the current workspace bootstrap.
|
|
84
84
|
- `openkit install-global` remains available as a manual or compatibility setup path.
|
|
@@ -38,7 +38,7 @@ Use it to find canonical repository docs and upkeep surfaces quickly. Do not tre
|
|
|
38
38
|
|
|
39
39
|
## Global Install Notes
|
|
40
40
|
|
|
41
|
-
- The preferred end-user onboarding path is `npm install -g openkit` followed by `openkit run`.
|
|
41
|
+
- The preferred end-user onboarding path is `npm install -g @duypham93/openkit` followed by `openkit run`.
|
|
42
42
|
- The first `openkit run` materializes the managed kit into the OpenCode home directory automatically.
|
|
43
43
|
- `openkit doctor` is the read-only check for the global install and workspace bootstrap state.
|
|
44
44
|
- `openkit install-global`, `openkit install`, and `openkit init` remain available as manual or compatibility commands.
|
|
@@ -27,7 +27,7 @@ Prefer the global install path first for everyday use. Use the checked-in reposi
|
|
|
27
27
|
|
|
28
28
|
When OpenKit is installed globally, start with:
|
|
29
29
|
|
|
30
|
-
- `npm install -g openkit`
|
|
30
|
+
- `npm install -g @duypham93/openkit`
|
|
31
31
|
- `openkit run`
|
|
32
32
|
- `openkit doctor` for global install readiness, drift, and missing-prerequisite checks
|
|
33
33
|
- `openkit run <args>` for the supported global launcher path and first-time setup
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
# OpenKit 0.2.
|
|
1
|
+
# OpenKit 0.2.1 Release Checklist
|
|
2
2
|
|
|
3
3
|
Date: 2026-03-24
|
|
4
4
|
|
|
5
5
|
## Scope
|
|
6
6
|
|
|
7
|
-
- simplified onboarding with `npm install -g openkit` followed by `openkit run`
|
|
7
|
+
- simplified onboarding with `npm install -g @duypham93/openkit` followed by `openkit run`
|
|
8
8
|
- automatic first-run global kit setup when the install is missing
|
|
9
9
|
- doctor guidance with `Next:` and `Recommended command:` output
|
|
10
10
|
- manual and compatibility retention for `openkit install-global`, `openkit install`, and `openkit init`
|
|
11
11
|
|
|
12
12
|
## Pre-Publish
|
|
13
13
|
|
|
14
|
-
- confirm `package.json` version is `0.2.
|
|
15
|
-
- confirm docs describe `npm install -g openkit` and `openkit run` as the preferred path
|
|
14
|
+
- confirm `package.json` version is `0.2.1`
|
|
15
|
+
- confirm docs describe `npm install -g @duypham93/openkit` and `openkit run` as the preferred path
|
|
16
16
|
- confirm release note draft is up to date in `docs/operations/internal-records/2026-03-24-simplified-install-ux.md`
|
|
17
17
|
- run:
|
|
18
18
|
|
|
@@ -26,7 +26,7 @@ node --test tests/cli/openkit-cli.test.js tests/global/*.test.js tests/runtime/*
|
|
|
26
26
|
npm pack
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
- verify the tarball name is `openkit-0.2.
|
|
29
|
+
- verify the tarball name is `duypham93-openkit-0.2.1.tgz`
|
|
30
30
|
|
|
31
31
|
## Local Smoke Test
|
|
32
32
|
|
|
@@ -50,13 +50,13 @@ npm publish
|
|
|
50
50
|
- verify the published version:
|
|
51
51
|
|
|
52
52
|
```bash
|
|
53
|
-
npm view openkit version
|
|
53
|
+
npm view @duypham93/openkit version
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
- install globally on a clean machine or temporary prefix:
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
|
-
npm install -g openkit
|
|
59
|
+
npm install -g @duypham93/openkit
|
|
60
60
|
```
|
|
61
61
|
|
|
62
62
|
- verify:
|
|
@@ -75,5 +75,5 @@ openkit doctor
|
|
|
75
75
|
```text
|
|
76
76
|
simplify global OpenKit onboarding
|
|
77
77
|
|
|
78
|
-
Make `openkit run` perform first-time global setup automatically so users can start with `npm install -g openkit` and launch immediately. Update doctor guidance, command help, docs, and tests to support the new onboarding flow while keeping manual install commands for compatibility.
|
|
78
|
+
Make `openkit run` perform first-time global setup automatically so users can start with `npm install -g @duypham93/openkit` and launch immediately. Update doctor guidance, command help, docs, and tests to support the new onboarding flow while keeping manual install commands for compatibility.
|
|
79
79
|
```
|
|
@@ -4,7 +4,7 @@ Date: 2026-03-24
|
|
|
4
4
|
|
|
5
5
|
## Change Summary
|
|
6
6
|
|
|
7
|
-
- the preferred onboarding flow is now `npm install -g openkit` followed by `openkit run`
|
|
7
|
+
- the preferred onboarding flow is now `npm install -g @duypham93/openkit` followed by `openkit run`
|
|
8
8
|
- `openkit run` performs first-time global kit setup automatically when the install is missing
|
|
9
9
|
- `openkit doctor` now reports next-step guidance and recommended commands
|
|
10
10
|
- `openkit install-global`, `openkit install`, and `openkit init` remain available as manual or compatibility commands
|
|
@@ -20,7 +20,7 @@ Date: 2026-03-24
|
|
|
20
20
|
- new-user quickstart:
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
npm install -g openkit
|
|
23
|
+
npm install -g @duypham93/openkit
|
|
24
24
|
openkit run
|
|
25
25
|
openkit doctor
|
|
26
26
|
```
|
|
@@ -30,7 +30,7 @@ openkit doctor
|
|
|
30
30
|
|
|
31
31
|
## Release Notes Draft
|
|
32
32
|
|
|
33
|
-
- Simplified onboarding so users can install the CLI with `npm install -g openkit` and start with `openkit run`
|
|
33
|
+
- Simplified onboarding so users can install the CLI with `npm install -g @duypham93/openkit` and start with `openkit run`
|
|
34
34
|
- Added automatic first-run global kit setup when the managed install is missing
|
|
35
35
|
- Added doctor guidance with `Next:` and `Recommended command:` output for missing, invalid, healthy, and workspace-issue states
|
|
36
36
|
- Kept `openkit install-global`, `openkit install`, and `openkit init` for manual and compatibility workflows
|
|
@@ -16,7 +16,7 @@ Use this runbook when you want the practical step-by-step path for working with
|
|
|
16
16
|
For normal day-to-day use on a machine with OpenKit installed globally:
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
|
-
npm install -g openkit
|
|
19
|
+
npm install -g @duypham93/openkit
|
|
20
20
|
openkit run
|
|
21
21
|
openkit doctor
|
|
22
22
|
```
|
|
@@ -267,7 +267,7 @@ Use the output to confirm the active stage, linked artifacts, and any task-board
|
|
|
267
267
|
The preferred top-level path is now:
|
|
268
268
|
|
|
269
269
|
```bash
|
|
270
|
-
npm install -g openkit
|
|
270
|
+
npm install -g @duypham93/openkit
|
|
271
271
|
openkit run <args>
|
|
272
272
|
openkit doctor
|
|
273
273
|
openkit upgrade
|
|
@@ -32,7 +32,7 @@ These checks validate OpenKit's supported wrapper operator path plus the workflo
|
|
|
32
32
|
|
|
33
33
|
When you are validating operator-facing behavior, treat this order as primary:
|
|
34
34
|
|
|
35
|
-
1. `npm install -g openkit`
|
|
35
|
+
1. `npm install -g @duypham93/openkit`
|
|
36
36
|
2. `openkit run`
|
|
37
37
|
3. `openkit doctor`
|
|
38
38
|
4. `node .opencode/workflow-state.js ...` only when you need raw repository/runtime inspection
|
|
@@ -126,7 +126,7 @@ Run the manual checks below only in a throwaway repo or temporary project copy u
|
|
|
126
126
|
On a fresh machine or temporary OpenCode home:
|
|
127
127
|
|
|
128
128
|
```bash
|
|
129
|
-
npm install -g openkit
|
|
129
|
+
npm install -g @duypham93/openkit
|
|
130
130
|
openkit run
|
|
131
131
|
openkit doctor
|
|
132
132
|
```
|
package/docs/operator/README.md
CHANGED
|
@@ -16,7 +16,7 @@ Use it to find the right live docs quickly. Do not treat it as a canonical repla
|
|
|
16
16
|
|
|
17
17
|
- Read `README.md` for the top-level product and runtime boundary summary
|
|
18
18
|
- Read `docs/operations/runbooks/openkit-daily-usage.md` for the detailed day-to-day usage path in this repository
|
|
19
|
-
- Install the CLI with `npm install -g openkit`, then run `openkit run` for first-time setup and `openkit doctor` to verify readiness
|
|
19
|
+
- Install the CLI with `npm install -g @duypham93/openkit`, then run `openkit run` for first-time setup and `openkit doctor` to verify readiness
|
|
20
20
|
- Use `/task` unless you already know the work must start in `Quick Task`, `Migration`, or `Full Delivery`
|
|
21
21
|
- Use `context/navigation.md` when you need to locate deeper workflow or standards references
|
|
22
22
|
|
|
@@ -36,7 +36,7 @@ Use it to find the right live docs quickly. Do not treat it as a canonical repla
|
|
|
36
36
|
- Slash commands: `/task`, `/quick-task`, `/migrate`, `/delivery`, `/brainstorm`, `/write-plan`, `/execute-plan`
|
|
37
37
|
- Global diagnostics: `openkit doctor`
|
|
38
38
|
- Global launcher: `openkit run`
|
|
39
|
-
- Global lifecycle: `npm install -g openkit`, `openkit upgrade`, `openkit uninstall`
|
|
39
|
+
- Global lifecycle: `npm install -g @duypham93/openkit`, `openkit upgrade`, `openkit uninstall`
|
|
40
40
|
- Runtime inspection: `node .opencode/workflow-state.js status`
|
|
41
41
|
- Compatibility diagnostics: `node .opencode/workflow-state.js doctor`
|
|
42
42
|
- Current state view: `node .opencode/workflow-state.js show`
|
|
@@ -32,8 +32,8 @@ approval_gate: tech_lead_to_fullstack
|
|
|
32
32
|
## Target UX
|
|
33
33
|
|
|
34
34
|
- Fresh machine install:
|
|
35
|
-
- `npx openkit@latest install-global`
|
|
36
|
-
- `npx openkit@latest doctor`
|
|
35
|
+
- `npx @duypham93/openkit@latest install-global`
|
|
36
|
+
- `npx @duypham93/openkit@latest doctor`
|
|
37
37
|
- Day-to-day usage in any repo:
|
|
38
38
|
- `opencode --profile openkit`
|
|
39
39
|
- Existing repo should not need checked-in `agents/`, `skills/`, `commands/`, or `.opencode/` surfaces just to use the kit.
|
package/package.json
CHANGED
package/src/cli/commands/help.js
CHANGED
|
@@ -37,7 +37,7 @@ test('openkit --help shows global-install oriented help', () => {
|
|
|
37
37
|
const result = runCli(['--help']);
|
|
38
38
|
|
|
39
39
|
assert.equal(result.status, 0);
|
|
40
|
-
assert.match(result.stdout, /npm install -g openkit/);
|
|
40
|
+
assert.match(result.stdout, /npm install -g @duypham93\/openkit/);
|
|
41
41
|
assert.match(result.stdout, /perform first-time setup if needed/);
|
|
42
42
|
assert.match(result.stdout, /install-global/);
|
|
43
43
|
assert.match(result.stdout, /upgrade/);
|