@kingkyylian/handoffkit 0.1.1 → 0.3.0
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/CHANGELOG.md +17 -0
- package/README.md +16 -3
- package/ROADMAP.md +2 -2
- package/dist/index.js +486 -151
- package/dist/index.js.map +1 -1
- package/docs/CACHE.md +34 -0
- package/docs/RELEASE.md +10 -7
- package/package.json +2 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
- Added richer deterministic risk notes that map changed file groups to common failure modes across release, CI, tooling, CLI, resume, report rendering, docs, security, and generated artifact workflows.
|
|
6
|
+
- Raised release and package publishing changes to high-severity risk guidance with explicit `pnpm pack:dry-run` and `pnpm smoke:release` verification prompts.
|
|
7
|
+
- Added transcript parsing for Codex, Claude, Cursor, and Gemini-style exported or copied agent sessions.
|
|
8
|
+
- Added opt-in local `.handoffkit` cache artifacts for `verify --cache`, `resume --cache`, and `pack --verify --cache`.
|
|
9
|
+
- Documented the `.handoffkit` cache layout and kept cache/checkpoint artifacts out of changed-file reports by default.
|
|
10
|
+
|
|
11
|
+
## 0.2.0
|
|
12
|
+
|
|
13
|
+
- Added meaningful target-specific Markdown profiles for Codex, Claude Code, Cursor, and generic handoffs.
|
|
14
|
+
- Made `--for` adjust packet titles, section order, and next-agent action notes while preserving the same collected source facts.
|
|
15
|
+
- Added local secret scanner config discovery for `gitleaks` and `secretlint`.
|
|
16
|
+
- Added scanner installation and config guidance when optional local scanners are unavailable.
|
|
17
|
+
- Fixed secret redaction so scanner names such as `secretlint` are not mistaken for secret assignment keys.
|
|
18
|
+
- Updated tests to cover target profile rendering, unchanged JSON source facts across targets, scanner config discovery, direct `scan-secrets` guidance, and scanner-name redaction.
|
|
19
|
+
|
|
3
20
|
## 0.1.1
|
|
4
21
|
|
|
5
22
|
- Added automated release tarball install smoke testing.
|
package/README.md
CHANGED
|
@@ -104,6 +104,8 @@ Optimize the packet for a target agent:
|
|
|
104
104
|
handoffkit pack --for codex --goal "Resume implementation"
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
+
Target profiles keep the same collected facts but adjust the title, section order, and next-agent notes for the selected tool. They do not invent project state or call model-specific APIs.
|
|
108
|
+
|
|
107
109
|
During development:
|
|
108
110
|
|
|
109
111
|
```sh
|
|
@@ -144,6 +146,7 @@ Run verification directly:
|
|
|
144
146
|
|
|
145
147
|
```sh
|
|
146
148
|
handoffkit verify
|
|
149
|
+
handoffkit verify --cache
|
|
147
150
|
```
|
|
148
151
|
|
|
149
152
|
Inspect deterministic risk notes:
|
|
@@ -162,6 +165,7 @@ Resume from a previous handoff or transcript:
|
|
|
162
165
|
|
|
163
166
|
```sh
|
|
164
167
|
handoffkit resume previous-handoff.md --goal "Continue from here"
|
|
168
|
+
handoffkit resume previous-handoff.md --goal "Continue from here" --cache
|
|
165
169
|
```
|
|
166
170
|
|
|
167
171
|
## CLI Options
|
|
@@ -176,9 +180,16 @@ handoffkit resume previous-handoff.md --goal "Continue from here"
|
|
|
176
180
|
| `--since <ref>` | Focus committed branch delta on a base ref such as `main`. |
|
|
177
181
|
| `--verify` | Run safe verification scripts and include results in the packet. |
|
|
178
182
|
| `--scan-secrets` | Run optional local secret scanners and include bounded redacted results. |
|
|
183
|
+
| `--cache` | Explicitly write local verification or resume artifacts under `.handoffkit/`. |
|
|
179
184
|
| `--include-diff` | Include full tracked patches and bounded untracked previews. |
|
|
180
185
|
| `--no-diff` | Omit diff summaries and full patches. |
|
|
181
186
|
|
|
187
|
+
## Local Cache
|
|
188
|
+
|
|
189
|
+
Cache writes are opt-in. `verify --cache`, `pack --verify --cache`, and `resume --cache` write redacted JSON artifacts under `.handoffkit/verification` or `.handoffkit/resume`. The cache directory is ignored by default so repeated handoffs do not pollute git status or generated reports.
|
|
190
|
+
|
|
191
|
+
See [docs/CACHE.md](docs/CACHE.md) for the file layout.
|
|
192
|
+
|
|
182
193
|
## What Gets Collected
|
|
183
194
|
|
|
184
195
|
HandoffKit reads local git and filesystem metadata from the current repository:
|
|
@@ -190,7 +201,7 @@ HandoffKit reads local git and filesystem metadata from the current repository:
|
|
|
190
201
|
- package manager and verification scripts from the root `package.json`
|
|
191
202
|
- optional verification results when `--verify` is used
|
|
192
203
|
- deterministic risk notes from changed file paths
|
|
193
|
-
- optional secret scanner availability for `gitleaks` and `secretlint`
|
|
204
|
+
- optional secret scanner availability, local config files, and install guidance for `gitleaks` and `secretlint`
|
|
194
205
|
- bounded, redacted secret scan results when `--scan-secrets` is used
|
|
195
206
|
|
|
196
207
|
## What Never Happens
|
|
@@ -198,7 +209,7 @@ HandoffKit reads local git and filesystem metadata from the current repository:
|
|
|
198
209
|
- No LLM API calls.
|
|
199
210
|
- No network requests from the CLI.
|
|
200
211
|
- No git writes, commits, staging, or branch changes.
|
|
201
|
-
- No files are written unless `--output` is provided.
|
|
212
|
+
- No files are written unless `--output` or explicit `--cache` is provided.
|
|
202
213
|
|
|
203
214
|
## Development
|
|
204
215
|
|
|
@@ -214,7 +225,7 @@ pnpm pack:dry-run
|
|
|
214
225
|
|
|
215
226
|
## Release
|
|
216
227
|
|
|
217
|
-
Releases are manual and should happen only after CI, package dry-run, and install smoke tests pass. The preferred path is the GitHub `Release` workflow with an `NPM_TOKEN` repository secret so npm provenance is attached to the published package.
|
|
228
|
+
Releases are manual and should happen only after CI, package dry-run, and install smoke tests pass. The preferred path is the GitHub `Release` workflow with an `NPM_TOKEN` repository secret that can publish from CI without an interactive OTP, so npm provenance is attached to the published package.
|
|
218
229
|
|
|
219
230
|
See [docs/RELEASE.md](docs/RELEASE.md) for the release checklist.
|
|
220
231
|
|
|
@@ -224,6 +235,8 @@ HandoffKit is local-first and deterministic. It reads local git and filesystem s
|
|
|
224
235
|
|
|
225
236
|
When `--scan-secrets` is used, HandoffKit runs installed local scanners only. It does not install scanners, send code to a service, or fail when `gitleaks` or `secretlint` is missing.
|
|
226
237
|
|
|
238
|
+
When scanner config files such as `.gitleaks.toml`, `.gitleaksignore`, `.secretlintrc.*`, or `secretlint.config.*` are present, HandoffKit reports them in the packet so the next agent knows which local policy files exist.
|
|
239
|
+
|
|
227
240
|
## License
|
|
228
241
|
|
|
229
242
|
MIT
|
package/ROADMAP.md
CHANGED
|
@@ -93,11 +93,11 @@ Regex redaction remains the default. HandoffKit detects optional local scanners
|
|
|
93
93
|
|
|
94
94
|
Scan results are bounded and redacted before rendering.
|
|
95
95
|
|
|
96
|
+
Scanner status also reports common local config files such as `.gitleaks.toml`, `.gitleaksignore`, `.secretlintrc.*`, and `secretlint.config.*`. When a scanner is not installed, the packet includes local installation and config guidance without installing anything automatically.
|
|
97
|
+
|
|
96
98
|
## Next Up
|
|
97
99
|
|
|
98
|
-
- Add scanner-specific installation guidance and config discovery.
|
|
99
100
|
- Make `risk` rules richer by mapping changed files to common failure modes.
|
|
100
|
-
- Improve `--for` formats beyond headings, with agent-specific action prompts.
|
|
101
101
|
- Add transcript parsers for Claude Code, Codex, Cursor, and Gemini exports.
|
|
102
102
|
- Add a stable `.handoffkit` cache format for verification and resume artifacts.
|
|
103
103
|
|