sdtk-ops-kit 0.2.2 → 0.2.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 CHANGED
@@ -1,131 +1,163 @@
1
- # sdtk-ops-kit
2
-
3
- > Skill-driven operations toolkit for deployment, verification, monitoring, incident response, backup or recovery, security, compliance, and cost discipline.
4
-
5
- ## Package
6
-
7
- - Package: `sdtk-ops-kit`
8
- - CLI: `sdtk-ops`
9
- - Latest published version lookup: `npm view sdtk-ops-kit version`
10
-
11
- ## Install
12
-
13
- ```bash
14
- npm install -g sdtk-ops-kit
15
- ```
16
-
17
- Then verify the installed command:
18
-
19
- ```bash
20
- sdtk-ops --version
21
- sdtk-ops --help
22
- ```
23
-
24
- If you need the exact latest published version number, run:
25
-
26
- ```bash
27
- npm view sdtk-ops-kit version
28
- ```
29
-
30
- ## Supported Command Surface
31
-
32
- `SDTK-OPS` keeps a deliberately small CLI surface.
33
-
34
- | Command | Purpose |
35
- |---|---|
36
- | `sdtk-ops help` | Show the supported command surface and routing guidance |
37
- | `sdtk-ops init` | Copy shared project files and prepare runtime installation |
38
- | `sdtk-ops runtime install` | Install runtime assets for Claude or Codex |
39
- | `sdtk-ops runtime status` | Check installed runtime assets |
40
- | `sdtk-ops runtime uninstall` | Remove runtime assets cleanly |
41
-
42
- Not supported:
43
- - `sdtk-ops generate`
44
- - workflow-first commands such as `sdtk-ops deploy`, `sdtk-ops incident`, or `sdtk-ops monitor`
45
-
46
- ## Runtime Matrix
47
-
48
- | Runtime | Project Scope | User Scope | Notes |
49
- |---|:---:|:---:|---|
50
- | Claude | Yes | Yes | Default scope is project |
51
- | Codex | No | Yes | Gate C0 blocks project-local install |
52
-
53
- Important truth:
54
- - Claude supports `project` and `user` scope.
55
- - Codex supports `user` scope only.
56
- - Codex installs collision-avoiding `sdtk-ops-*` skill names.
57
-
58
- ## Remove Runtime Assets vs Remove the Package
59
-
60
- `runtime uninstall` removes only the SDTK-OPS-managed skill folders for the selected runtime and scope.
61
- It does not delete `.claude/`, `.claude/skills/`, `$CODEX_HOME/`, or `$CODEX_HOME/skills/`, because those roots may contain non-SDTK user assets.
62
-
63
- Use runtime cleanup first:
64
-
65
- ```bash
66
- sdtk-ops runtime uninstall --runtime claude --scope project --project-path ./my-project
67
- sdtk-ops runtime uninstall --runtime claude --scope user
68
- sdtk-ops runtime uninstall --runtime codex --all
69
- ```
70
-
71
- Use npm uninstall separately when you also want to remove the globally installed CLI package:
72
-
73
- ```bash
74
- npm uninstall -g sdtk-ops-kit
75
- ```
76
-
77
- That npm command removes the package only. It does not remove runtime assets already copied into Claude or Codex skill directories.
78
-
79
- ## Quick Start
80
-
81
- ### 1. Initialize a project
82
-
83
- ```bash
84
- sdtk-ops init --runtime claude --project-path ./my-project
85
- ```
86
-
87
- `init` copies:
88
- - `AGENTS.md`
89
- - `sdtk-spec.config.json`
90
- - `sdtk-spec.config.profiles.example.json`
91
-
92
- ### 2. Install runtime assets
93
-
94
- Claude project scope:
95
-
96
- ```bash
97
- sdtk-ops runtime install --runtime claude --scope project --project-path ./my-project
98
- ```
99
-
100
- Claude user scope:
101
-
102
- ```bash
103
- sdtk-ops runtime install --runtime claude --scope user
104
- ```
105
-
106
- Codex user scope:
107
-
108
- ```bash
109
- sdtk-ops runtime install --runtime codex --scope user
110
- ```
111
-
112
- Gate C0:
113
-
114
- ```bash
115
- sdtk-ops runtime install --runtime codex --scope project
116
- ```
117
-
118
- The Codex project-scope command must fail. That rejection is the correct product behavior.
119
-
1
+ # sdtk-ops-kit
2
+
3
+ > Skill-driven operations toolkit for deployment, verification, monitoring, incident response, backup or recovery, security, compliance, and cost discipline.
4
+
5
+ ## Package
6
+
7
+ - Package: `sdtk-ops-kit`
8
+ - CLI: `sdtk-ops`
9
+ - Latest published version lookup: `npm view sdtk-ops-kit version`
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ npm install -g sdtk-ops-kit
15
+ ```
16
+
17
+ Then verify the installed command:
18
+
19
+ ```bash
20
+ sdtk-ops --version
21
+ sdtk-ops --help
22
+ ```
23
+
24
+ If you need the exact latest published version number, run:
25
+
26
+ ```bash
27
+ npm view sdtk-ops-kit version
28
+ ```
29
+
30
+ ## Update Existing Installation
31
+
32
+ Use the public `update` command when `sdtk-ops-kit` is already installed and you want the newest published package line.
33
+
34
+ ```bash
35
+ sdtk-ops update --check-only
36
+ sdtk-ops update --runtime claude --project-path ./my-project
37
+ ```
38
+
39
+ Codex user-scope variant:
40
+
41
+ ```bash
42
+ sdtk-ops update --runtime codex --scope user --project-path ./my-project
43
+ ```
44
+
45
+ Project-local Codex refresh is also supported, but only when you intentionally launch the runtime with the explicit local `CODEX_HOME=<project>/.codex` contract. Native `.codex/skills` auto-discovery is still not claimed.
46
+
47
+ Then verify:
48
+
49
+ ```bash
50
+ sdtk-ops --version
51
+ sdtk-ops runtime status --runtime claude --project-path ./my-project
52
+ ```
53
+
54
+ Important truth:
55
+ - `sdtk-ops update` still uses `npm install -g sdtk-ops-kit@<target>` as the package refresh mechanism
56
+ - `update --check-only` is non-destructive and prints the planned commands only
57
+ - `init --force` refreshes managed project files
58
+ - `runtime install --force` refreshes managed runtime assets
59
+ - existing ops evidence is not rewritten automatically
60
+
61
+ ## Supported Command Surface
62
+
63
+ `SDTK-OPS` keeps a deliberately small CLI surface.
64
+
65
+ | Command | Purpose |
66
+ |---|---|
67
+ | `sdtk-ops help` | Show the supported command surface and routing guidance |
68
+ | `sdtk-ops init` | Copy shared project files and prepare runtime installation |
69
+ | `sdtk-ops update` | Refresh the installed package line and optionally rerun bounded managed-file/runtime refresh steps |
70
+ | `sdtk-ops runtime install` | Install runtime assets for Claude or Codex |
71
+ | `sdtk-ops runtime status` | Check installed runtime assets |
72
+ | `sdtk-ops runtime uninstall` | Remove runtime assets cleanly |
73
+
74
+ Not supported:
75
+ - `sdtk-ops generate`
76
+ - workflow-first commands such as `sdtk-ops deploy`, `sdtk-ops incident`, or `sdtk-ops monitor`
77
+
78
+ ## Runtime Matrix
79
+
80
+ | Runtime | Project Scope | User Scope | Notes |
81
+ |---|:---:|:---:|---|
82
+ | Claude | Yes | Yes | Default scope is project |
83
+ | Codex | Yes | Yes | Default scope is user; project-local installs require the explicit local `CODEX_HOME=<project>/.codex` contract |
84
+
85
+ Important truth:
86
+ - Claude supports `project` and `user` scope.
87
+ - Codex defaults to `user` scope and supports `project` scope only through the explicit local `CODEX_HOME=<project>/.codex` contract.
88
+ - Codex installs collision-avoiding `sdtk-ops-*` skill names.
89
+
90
+ ## Remove Runtime Assets vs Remove the Package
91
+
92
+ `runtime uninstall` removes only the SDTK-OPS-managed skill folders for the selected runtime and scope.
93
+ It does not delete `.claude/`, `.claude/skills/`, `$CODEX_HOME/`, or `$CODEX_HOME/skills/`, because those roots may contain non-SDTK user assets.
94
+
95
+ Use runtime cleanup first:
96
+
97
+ ```bash
98
+ sdtk-ops runtime uninstall --runtime claude --scope project --project-path ./my-project
99
+ sdtk-ops runtime uninstall --runtime claude --scope user
100
+ sdtk-ops runtime uninstall --runtime codex --all
101
+ ```
102
+
103
+ Use npm uninstall separately when you also want to remove the globally installed CLI package:
104
+
105
+ ```bash
106
+ npm uninstall -g sdtk-ops-kit
107
+ ```
108
+
109
+ That npm command removes the package only. It does not remove runtime assets already copied into Claude or Codex skill directories.
110
+
111
+ ## Quick Start
112
+
113
+ ### 1. Initialize a project
114
+
115
+ ```bash
116
+ sdtk-ops init --runtime claude --project-path ./my-project
117
+ ```
118
+
119
+ `init` copies:
120
+ - `AGENTS.md`
121
+ - `sdtk-spec.config.json`
122
+ - `sdtk-spec.config.profiles.example.json`
123
+
124
+ ### 2. Install runtime assets
125
+
126
+ Claude project scope:
127
+
128
+ ```bash
129
+ sdtk-ops runtime install --runtime claude --scope project --project-path ./my-project
130
+ ```
131
+
132
+ Claude user scope:
133
+
134
+ ```bash
135
+ sdtk-ops runtime install --runtime claude --scope user
136
+ ```
137
+
138
+ Codex user scope:
139
+
140
+ ```bash
141
+ sdtk-ops runtime install --runtime codex --scope user
142
+ ```
143
+
144
+ Codex project-local scope, only when you intentionally launch with `CODEX_HOME=<project>/.codex`:
145
+
146
+ ```bash
147
+ sdtk-ops runtime install --runtime codex --scope project --project-path ./my-project
148
+ ```
149
+
150
+ Project-local Codex installs remain bounded explicit-local support. Native `.codex/skills` auto-discovery is not claimed.
151
+
120
152
  ### 3. Choose the right skill journey
121
153
 
122
154
  Use `ops-discover` when the correct operational path is unclear.
123
-
124
- Canonical journeys:
125
- - deployment: `ops-plan -> ops-infra-plan -> ops-container -> ops-ci-cd -> ops-deploy -> ops-monitor -> ops-verify`
126
- - incident: `ops-incident -> ops-debug -> ops-deploy` when rollback or corrective rollout is needed, then `ops-monitor -> ops-verify`
127
- - monitoring: `ops-plan -> ops-monitor -> ops-verify`
128
- - backup or recovery: `ops-plan -> ops-backup -> ops-verify`
155
+
156
+ Canonical journeys:
157
+ - deployment: `ops-plan -> ops-infra-plan -> ops-container -> ops-ci-cd -> ops-deploy -> ops-monitor -> ops-verify`
158
+ - incident: `ops-incident -> ops-debug -> ops-deploy` when rollback or corrective rollout is needed, then `ops-monitor -> ops-verify`
159
+ - monitoring: `ops-plan -> ops-monitor -> ops-verify`
160
+ - backup or recovery: `ops-plan -> ops-backup -> ops-verify`
129
161
 
130
162
  Always close work with `ops-verify`.
131
163
 
@@ -159,38 +191,38 @@ Minimum OPS evidence expectations for this wave:
159
191
  This wave does not define a final OPS evidence schema and does not implement QA bridge logic.
160
192
 
161
193
  ## Product Boundary
162
-
163
- `SDTK-OPS` is the downstream operations product in the `SDTK-SPEC -> SDTK-CODE -> SDTK-OPS` family.
164
-
165
- It is:
166
- - skill-driven
167
- - operations-focused
168
- - suitable for deployment, verification, monitoring, incident response, backup, security, compliance, and cost work
169
-
170
- It is not:
171
- - a workflow-first CLI like `SDTK-CODE`
172
- - a generator product
173
- - a provider-pack catalog
174
- - a Kubernetes or cloud-platform package
175
-
176
- ## Package Validation
177
-
178
- Maintainers validating a release candidate from source can run:
179
-
180
- ```bash
181
- npm run build:payload
182
- npm run verify:payload
183
- npm test
184
- npm run pack:smoke
185
- ```
186
-
187
- Those commands validate payload integrity, runtime behavior, and isolated packed-package smoke before publish.
188
-
189
- ## Documentation
190
-
191
- - Usage guide:
192
- - `https://github.com/codexsdtk/sdtk-toolkit/blob/main/products/sdtk-ops/governance/SDTKOPS_TOOLKIT_USAGE_GUIDE.md`
193
- - Installation runbook:
194
- - `https://github.com/codexsdtk/sdtk-toolkit/blob/main/products/sdtk-ops/governance/installation-runbook.md`
195
- - Product boundary doc:
196
- - `https://github.com/codexsdtk/sdtk-toolkit/blob/main/products/sdtk-ops/toolkit/SDTKOPS_TOOLKIT.md`
194
+
195
+ `SDTK-OPS` is the downstream operations product in the `SDTK-SPEC -> SDTK-CODE -> SDTK-OPS` family.
196
+
197
+ It is:
198
+ - skill-driven
199
+ - operations-focused
200
+ - suitable for deployment, verification, monitoring, incident response, backup, security, compliance, and cost work
201
+
202
+ It is not:
203
+ - a workflow-first CLI like `SDTK-CODE`
204
+ - a generator product
205
+ - a provider-pack catalog
206
+ - a Kubernetes or cloud-platform package
207
+
208
+ ## Package Validation
209
+
210
+ Maintainers validating a release candidate from source can run:
211
+
212
+ ```bash
213
+ npm run build:payload
214
+ npm run verify:payload
215
+ npm test
216
+ npm run pack:smoke
217
+ ```
218
+
219
+ Those commands validate payload integrity, runtime behavior, and isolated packed-package smoke before publish.
220
+
221
+ ## Documentation
222
+
223
+ - Usage guide:
224
+ - `https://github.com/codexsdtk/sdtk-toolkit/blob/main/products/sdtk-ops/governance/SDTKOPS_TOOLKIT_USAGE_GUIDE.md`
225
+ - Installation runbook:
226
+ - `https://github.com/codexsdtk/sdtk-toolkit/blob/main/products/sdtk-ops/governance/installation-runbook.md`
227
+ - Product boundary doc:
228
+ - `https://github.com/codexsdtk/sdtk-toolkit/blob/main/products/sdtk-ops/toolkit/SDTKOPS_TOOLKIT.md`
@@ -1,12 +1,12 @@
1
1
  {
2
- "version": "0.2.2",
2
+ "version": "0.2.3",
3
3
  "sourceCommit": "5b21b7376fcf11a9138f486921de5e07e0c88ac7",
4
4
  "fileCount": 36,
5
5
  "files": [
6
6
  {
7
7
  "path": "toolkit/AGENTS.md",
8
- "sha256": "a0fa279e32a8b311606867ed162cc33b371bffc5b1ce2922995903a2dbff3561",
9
- "size": 5907
8
+ "sha256": "a1a8d03564680cde44ef34e1878f3c8fb6ad7ce79e79b7ba7274fdb072321f30",
9
+ "size": 5925
10
10
  },
11
11
  {
12
12
  "path": "toolkit/install.ps1",
@@ -35,8 +35,8 @@
35
35
  },
36
36
  {
37
37
  "path": "toolkit/SDTKOPS_TOOLKIT.md",
38
- "sha256": "a7cfca05138e8b9831ea03bd0622a4fd64d77924b69d5c0faff5c279a20091d1",
39
- "size": 7853
38
+ "sha256": "bed302b782f0c1729c8010877207a67bbc4c3032209186a54bac280d468cf5c8",
39
+ "size": 8171
40
40
  },
41
41
  {
42
42
  "path": "toolkit/sdtk-spec.config.json",
@@ -1,10 +1,10 @@
1
- a0fa279e32a8b311606867ed162cc33b371bffc5b1ce2922995903a2dbff3561 toolkit/AGENTS.md
1
+ a1a8d03564680cde44ef34e1878f3c8fb6ad7ce79e79b7ba7274fdb072321f30 toolkit/AGENTS.md
2
2
  ac041e80d0771b13fc1dc94c6a572debaddba223ff4d029695a6953f35ebaa92 toolkit/install.ps1
3
3
  5eae77f4d14b81d56c3c109f563fefafd1967d85093ff1b192293fe438aeabe5 toolkit/scripts/install-claude-skills.ps1
4
4
  68eb662bc9b8906882d32f6cd1247238f6ae663137a489f18054a75724cd1e81 toolkit/scripts/install-codex-skills.ps1
5
5
  2c629d8316b205c6a7cd0d95959b80801b281ef62e205c10a92e3a2568eb8b41 toolkit/scripts/uninstall-claude-skills.ps1
6
6
  fdb9631a80ecfb0d986a52a2833e88bf15c5303ab654d35bad6d64cca43046e8 toolkit/scripts/uninstall-codex-skills.ps1
7
- a7cfca05138e8b9831ea03bd0622a4fd64d77924b69d5c0faff5c279a20091d1 toolkit/SDTKOPS_TOOLKIT.md
7
+ bed302b782f0c1729c8010877207a67bbc4c3032209186a54bac280d468cf5c8 toolkit/SDTKOPS_TOOLKIT.md
8
8
  8247ddf24502ce285bee213eefc801ce6b0b83afe00efd828468ac9130f53b09 toolkit/sdtk-spec.config.json
9
9
  de0310b0c69f77d1c1601b94b0ea72b2c83c92cb8ee94d2f4a1759ceb58f2fd4 toolkit/sdtk-spec.config.profiles.example.json
10
10
  1cd81e12cebdb2be528803e2d8afe43959aab1493e55499af529b99ec566a56c toolkit/skills/ops-backup/references/backup-script-patterns.md
@@ -1,4 +1,4 @@
1
- # SDTK-OPS -- Operations Discipline Toolkit
1
+ # SDTK-OPS -- Operations Discipline Toolkit
2
2
 
3
3
  Purpose: use SDTK-OPS to drive disciplined infrastructure and operations work across planning, deployment, monitoring, incident response, recovery, security hardening, and cost optimization.
4
4
 
@@ -86,7 +86,7 @@ Minimum OPS evidence expectations:
86
86
  | Runtime | Project Scope | User Scope | Default Scope | Notes |
87
87
  |---------|:-------------:|:----------:|---------------|-------|
88
88
  | Claude | true | true | project | project-local toolkit supported |
89
- | Codex | false | true | user | Gate C0: current shipped product blocks project-local skill runtime; future support remains unverified until code and bounded validation change. |
89
+ | Codex | true | true | user | Project-local skill runtime is supported only through the explicit local `CODEX_HOME=<project>/.codex` contract; native `.codex/skills` auto-discovery is not claimed. |
90
90
 
91
91
  ## Verification Policy
92
92