briefops 2.1.2 → 2.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/CHANGELOG.md +5 -0
- package/README.md +9 -2
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/docs/compatibility.md +2 -2
- package/docs/evals/briefops-utility-log.md +140 -0
- package/docs/evals.md +9 -0
- package/docs/repository-maintenance-workflows.md +218 -0
- package/docs/use-cases.md +152 -0
- package/examples/evals/briefops-harness-continuity.md +66 -0
- package/examples/evals/pr-review.md +66 -0
- package/examples/evals/release-readiness.md +71 -0
- package/package.json +1 -1
- package/plugins/briefops-codex/.codex-plugin/plugin.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
- No changes yet.
|
|
6
6
|
|
|
7
|
+
## 2.1.3 - 2026-07-05
|
|
8
|
+
|
|
9
|
+
- Add lightweight utility evaluation documentation and example eval logs.
|
|
10
|
+
- Refresh the npm lockfile after dependency update with zero reported audit vulnerabilities.
|
|
11
|
+
|
|
7
12
|
## 2.1.2 - 2026-07-01
|
|
8
13
|
|
|
9
14
|
- Add an explicit BriefOps environment gate to generated startup guidance so missing `briefops` on `PATH` becomes `Status: setup-required` instead of a silently skipped prime step.
|
package/README.md
CHANGED
|
@@ -46,7 +46,7 @@ BriefOps can generate Codex skill-plugin assets, but the plugin calls the local
|
|
|
46
46
|
|
|
47
47
|
## Release Status
|
|
48
48
|
|
|
49
|
-
BriefOps 2.1.
|
|
49
|
+
BriefOps 2.1.3 is the current npm-ready release for developers who want a local-first memory and context ledger for AI coding agents. It packages the 2.1 Master Harness routing, continuity observability, strict release-readiness checks, evidence anchors, workspace-lock hardening, the fresh-thread environment gate that treats missing local CLI setup as `Status: setup-required`, and lightweight local utility evaluation docs.
|
|
50
50
|
|
|
51
51
|
The public CLI behavior and workspace file-format policy are documented in `docs/compatibility.md` and `docs/file-format.md`. The core safety principles are stable:
|
|
52
52
|
|
|
@@ -59,7 +59,7 @@ The public CLI behavior and workspace file-format policy are documented in `docs
|
|
|
59
59
|
|
|
60
60
|
For privacy guarantees, see `docs/privacy-model.md`.
|
|
61
61
|
|
|
62
|
-
##
|
|
62
|
+
## Publishing And Sharing Boundary
|
|
63
63
|
|
|
64
64
|
Before publishing a repository or sharing generated context, review:
|
|
65
65
|
|
|
@@ -69,6 +69,13 @@ Before publishing a repository or sharing generated context, review:
|
|
|
69
69
|
- `docs/file-format.md` and `docs/compatibility.md` for the local data contract.
|
|
70
70
|
- `docs/privacy-model.md` for export-policy and local data boundaries.
|
|
71
71
|
|
|
72
|
+
## Use Cases And Workflows
|
|
73
|
+
|
|
74
|
+
BriefOps helps AI coding threads carry context across issue triage, pull request review, release readiness, incident follow-up, and long-running repository maintenance work.
|
|
75
|
+
|
|
76
|
+
- [Use Cases](docs/use-cases.md)
|
|
77
|
+
- [Repository Maintenance Workflows](docs/repository-maintenance-workflows.md)
|
|
78
|
+
|
|
72
79
|
## Install
|
|
73
80
|
|
|
74
81
|
From npm:
|
package/dist/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const briefopsVersion = "2.1.
|
|
1
|
+
export declare const briefopsVersion = "2.1.3";
|
package/dist/version.js
CHANGED
package/docs/compatibility.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# BriefOps 2.1.
|
|
1
|
+
# BriefOps 2.1.3 Compatibility Policy
|
|
2
2
|
|
|
3
3
|
BriefOps follows semantic versioning for the public CLI and local file formats.
|
|
4
4
|
|
|
@@ -39,7 +39,7 @@ Breaking changes require a new major version. Examples:
|
|
|
39
39
|
|
|
40
40
|
New 1.0 workspaces write `version: 1.0.0` in `.briefops/config.yaml`.
|
|
41
41
|
|
|
42
|
-
BriefOps 2.1.
|
|
42
|
+
BriefOps 2.1.3 keeps the workspace schema at `1.0.0` and can read legacy `0.x` workspace configs on a best-effort compatibility basis. Future unsupported workspace schema major versions fail with an explicit upgrade error instead of silently reading incompatible data.
|
|
43
43
|
|
|
44
44
|
## Migration Policy
|
|
45
45
|
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# BriefOps Utility Log
|
|
2
|
+
|
|
3
|
+
Use this local log to judge whether BriefOps made one real task easier to
|
|
4
|
+
continue. It is intentionally manual. Do not add telemetry, cloud analytics,
|
|
5
|
+
databases, dashboards, or automatic scoring until repeated logs show a concrete
|
|
6
|
+
need.
|
|
7
|
+
|
|
8
|
+
The goal is to capture evidence for practical utility:
|
|
9
|
+
|
|
10
|
+
- Did BriefOps reduce re-explanation?
|
|
11
|
+
- Did it preserve prior decisions, lessons, risks, next steps, and commands?
|
|
12
|
+
- Did it produce a better fresh-thread handoff?
|
|
13
|
+
- Did routing avoid unnecessary process while still improving verification?
|
|
14
|
+
|
|
15
|
+
Use one entry per task or fresh-thread continuation. Keep examples short enough
|
|
16
|
+
that a maintainer can review them in a few minutes.
|
|
17
|
+
|
|
18
|
+
## Suggested Local Checks
|
|
19
|
+
|
|
20
|
+
Run only the checks that fit the task:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
briefops harness route --task "<task>"
|
|
24
|
+
briefops prime --format codex --task "<task>" --max-tokens 800
|
|
25
|
+
briefops obs continuity --worker <worker> --task "<task>" --json
|
|
26
|
+
briefops finish --worker <worker> --task "<task>" --result "<result>"
|
|
27
|
+
briefops continue --worker <worker> --task "<next task>" --pack
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
For context-size evidence, prefer `briefops obs continuity`. For broader impact
|
|
31
|
+
claims such as token savings, use `docs/impact-report.md` and label anything
|
|
32
|
+
without measured evidence as estimated or unmeasured.
|
|
33
|
+
|
|
34
|
+
## Scoring
|
|
35
|
+
|
|
36
|
+
Use simple 0 to 3 scores.
|
|
37
|
+
|
|
38
|
+
Continuity score:
|
|
39
|
+
|
|
40
|
+
- 0: Fresh thread still needed full re-explanation.
|
|
41
|
+
- 1: Some useful context survived, but major decisions or risks were missing.
|
|
42
|
+
- 2: Fresh thread could continue with minor clarification.
|
|
43
|
+
- 3: Fresh thread could continue without repeating important context.
|
|
44
|
+
|
|
45
|
+
Relevance score:
|
|
46
|
+
|
|
47
|
+
- 0: Mostly unrelated context.
|
|
48
|
+
- 1: Mixed; useful items were buried in unrelated material.
|
|
49
|
+
- 2: Mostly relevant with a little harmless extra context.
|
|
50
|
+
- 3: Compact and directly useful for the task.
|
|
51
|
+
|
|
52
|
+
Noise score:
|
|
53
|
+
|
|
54
|
+
- 0: No meaningful noise.
|
|
55
|
+
- 1: Minor extra context.
|
|
56
|
+
- 2: Noticeable bloat or duplicate context.
|
|
57
|
+
- 3: Noise likely slowed the task or risked confusion.
|
|
58
|
+
|
|
59
|
+
Estimated time saved:
|
|
60
|
+
|
|
61
|
+
- Use minutes.
|
|
62
|
+
- Write `unmeasured` when there is no credible estimate.
|
|
63
|
+
- Mark estimates as hypotheses unless compared with a similar no-BriefOps run.
|
|
64
|
+
|
|
65
|
+
## Template
|
|
66
|
+
|
|
67
|
+
```markdown
|
|
68
|
+
# BriefOps Utility Log
|
|
69
|
+
|
|
70
|
+
date:
|
|
71
|
+
evaluator:
|
|
72
|
+
project:
|
|
73
|
+
task:
|
|
74
|
+
fresh thread?: yes/no
|
|
75
|
+
BriefOps commands used:
|
|
76
|
+
-
|
|
77
|
+
|
|
78
|
+
## Context Evidence
|
|
79
|
+
|
|
80
|
+
raw candidate context:
|
|
81
|
+
prime context:
|
|
82
|
+
compression ratio:
|
|
83
|
+
route:
|
|
84
|
+
|
|
85
|
+
## Reuse Evidence
|
|
86
|
+
|
|
87
|
+
reused decisions:
|
|
88
|
+
-
|
|
89
|
+
|
|
90
|
+
reused lessons:
|
|
91
|
+
-
|
|
92
|
+
|
|
93
|
+
reused risks:
|
|
94
|
+
-
|
|
95
|
+
|
|
96
|
+
reused next steps:
|
|
97
|
+
-
|
|
98
|
+
|
|
99
|
+
reused commands:
|
|
100
|
+
-
|
|
101
|
+
|
|
102
|
+
## Missing Or Repeated Context
|
|
103
|
+
|
|
104
|
+
what was still missing:
|
|
105
|
+
-
|
|
106
|
+
|
|
107
|
+
repeated explanations:
|
|
108
|
+
-
|
|
109
|
+
|
|
110
|
+
repeated rejected approaches:
|
|
111
|
+
-
|
|
112
|
+
|
|
113
|
+
## Scores
|
|
114
|
+
|
|
115
|
+
continuity score:
|
|
116
|
+
relevance score:
|
|
117
|
+
noise score:
|
|
118
|
+
estimated time saved:
|
|
119
|
+
|
|
120
|
+
## Notes
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
## Follow-Up
|
|
124
|
+
|
|
125
|
+
promote to memory?: yes/no
|
|
126
|
+
adjust docs or examples?: yes/no
|
|
127
|
+
possible product improvement:
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Review Cadence
|
|
131
|
+
|
|
132
|
+
After 5 to 10 logs, review them manually and look for repeated patterns:
|
|
133
|
+
|
|
134
|
+
- Missing decisions suggest finish or memory extraction wording needs work.
|
|
135
|
+
- Missing risks suggest handoff and prime sections need stronger risk selection.
|
|
136
|
+
- High noise suggests memory hygiene, quotas, or examples need tightening.
|
|
137
|
+
- Repeated over-routing suggests route wording or classification needs tuning.
|
|
138
|
+
- Repeated under-routing suggests route risk signals need clearer escalation.
|
|
139
|
+
|
|
140
|
+
Treat each pattern as a hypothesis until at least two or three logs show it.
|
package/docs/evals.md
CHANGED
|
@@ -16,3 +16,12 @@ Prime-context evals should also check that the compact output is materially smal
|
|
|
16
16
|
```bash
|
|
17
17
|
npm test -- tests/prime.test.ts
|
|
18
18
|
```
|
|
19
|
+
|
|
20
|
+
For real task utility, use the manual utility log:
|
|
21
|
+
|
|
22
|
+
- [BriefOps Utility Log](evals/briefops-utility-log.md)
|
|
23
|
+
|
|
24
|
+
The utility log is for local, task-by-task review of re-explanation, preserved
|
|
25
|
+
decisions, preserved risks, handoff quality, routing fit, and verification
|
|
26
|
+
discipline. It complements checklist evals without adding telemetry,
|
|
27
|
+
dashboards, databases, or cloud analytics.
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# Repository Maintenance Workflows
|
|
2
|
+
|
|
3
|
+
BriefOps supports recurring repository maintenance work: issue triage, pull request review, release preparation, incident follow-up, documentation updates, dependency changes, and long-running cleanup.
|
|
4
|
+
|
|
5
|
+
The workflow pattern is simple:
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
prime -> route -> work -> verify -> finish -> continue when needed
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Use durable memory for decisions, lessons, incidents, and recurring project constraints. Keep transient notes in work logs or out of memory entirely.
|
|
12
|
+
|
|
13
|
+
## Workspace Setup
|
|
14
|
+
|
|
15
|
+
Create a repository-oriented skill, project, and worker once per repository.
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
briefops bootstrap
|
|
19
|
+
|
|
20
|
+
briefops skill create repo-review \
|
|
21
|
+
--description "Review repository work for regressions, release risk, privacy boundaries, and missing verification." \
|
|
22
|
+
--tags "maintenance,review,release"
|
|
23
|
+
|
|
24
|
+
briefops project create briefops \
|
|
25
|
+
--description "Local-first CLI for AI coding agent context continuity." \
|
|
26
|
+
--tags "cli,local-first,ai-agents"
|
|
27
|
+
|
|
28
|
+
briefops worker create repo-worker \
|
|
29
|
+
--project briefops \
|
|
30
|
+
--skills "repo-review" \
|
|
31
|
+
--style "verify before completion, keep changes scoped, record durable decisions"
|
|
32
|
+
|
|
33
|
+
briefops worker use repo-worker
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Check the workspace before relying on it:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
briefops doctor --privacy
|
|
40
|
+
briefops doctor --stability
|
|
41
|
+
briefops inspect budget
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Issue Triage
|
|
45
|
+
|
|
46
|
+
Use this workflow when bugs, support requests, or feature proposals need project context.
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
briefops prime --worker repo-worker --task "Triage new issues." --format codex --max-tokens 800
|
|
50
|
+
briefops harness route --task "Triage new issues."
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
During triage, record only facts that will help future work:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
briefops finish \
|
|
57
|
+
--worker repo-worker \
|
|
58
|
+
--task "Triage new issues." \
|
|
59
|
+
--result "Confirmed one reproducible CLI regression and one duplicate support request." \
|
|
60
|
+
--lesson "Ask for command output and BriefOps version before diagnosing CLI setup failures." \
|
|
61
|
+
--next-step "Reproduce the regression in a temporary workspace."
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Good durable memory candidates:
|
|
65
|
+
|
|
66
|
+
- supported version boundaries
|
|
67
|
+
- common duplicate reports
|
|
68
|
+
- required reproduction details
|
|
69
|
+
- recurring release or privacy pitfalls
|
|
70
|
+
|
|
71
|
+
## Pull Request Review
|
|
72
|
+
|
|
73
|
+
Use the review route when work needs actionable findings, severity ordering, and explicit verification gaps.
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
briefops harness route --task "Review this pull request." --type code-review
|
|
77
|
+
briefops prime --worker repo-worker --task "Review this pull request." --format codex --max-tokens 800
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
After review, preserve the next useful step:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
briefops finish \
|
|
84
|
+
--worker repo-worker \
|
|
85
|
+
--task "Review this pull request." \
|
|
86
|
+
--result "Found one blocking issue and one missing test." \
|
|
87
|
+
--open-risk "The workspace-lock path is not covered by a regression test." \
|
|
88
|
+
--next-step "Request a targeted regression test before merge."
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
If review needs to continue in another thread:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
briefops continue \
|
|
95
|
+
--worker repo-worker \
|
|
96
|
+
--task "Finish unresolved PR review checks." \
|
|
97
|
+
--pack
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Release Preparation
|
|
101
|
+
|
|
102
|
+
Use the release route when a task needs evidence across build, test, package contents, privacy checks, and release notes.
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
briefops harness route --task "Prepare this release." --type release-preparation
|
|
106
|
+
npm run build
|
|
107
|
+
npm test
|
|
108
|
+
briefops doctor --strict --json
|
|
109
|
+
npm pack --dry-run
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
If dependency audit or registry checks are part of the release, run them only from an environment where registry metadata disclosure is acceptable:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
npm audit --audit-level=moderate
|
|
116
|
+
npm view briefops versions --json
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Record the release outcome:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
briefops finish \
|
|
123
|
+
--worker repo-worker \
|
|
124
|
+
--task "Prepare this release." \
|
|
125
|
+
--result "Release verification completed with no blocking failures." \
|
|
126
|
+
--decision "The package is ready for publish after version confirmation." \
|
|
127
|
+
--commands "npm run build,npm test,briefops doctor --strict --json,npm pack --dry-run"
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Use [Release Checklist](release-checklist.md) for the full local release gate.
|
|
131
|
+
|
|
132
|
+
## Dependency And Refactor Work
|
|
133
|
+
|
|
134
|
+
Use routing before broad maintenance changes so the next thread can see the intended depth.
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
briefops harness route --task "Upgrade dependencies and verify compatibility." --type dependency-upgrade
|
|
138
|
+
briefops harness route --task "Refactor memory proposal handling." --type refactor
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Before ending a session, record the behavior boundary and verification:
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
briefops finish \
|
|
145
|
+
--worker repo-worker \
|
|
146
|
+
--task "Refactor memory proposal handling." \
|
|
147
|
+
--result "Separated proposal formatting from application without changing public CLI behavior." \
|
|
148
|
+
--decision "Keep proposal application file-backed and protected by workspace locks." \
|
|
149
|
+
--commands "npm run build,npm test"
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Durable memory should explain the reusable rule, not the mechanics of every edit.
|
|
153
|
+
|
|
154
|
+
## Documentation Maintenance
|
|
155
|
+
|
|
156
|
+
Use the documentation route when updating README, guides, or examples.
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
briefops harness route --task "Update documentation for release readiness." --type documentation-task
|
|
160
|
+
briefops prime --worker repo-worker --task "Update documentation for release readiness." --format codex --max-tokens 800
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
Before finishing, check that commands and links match current behavior:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
briefops finish \
|
|
167
|
+
--worker repo-worker \
|
|
168
|
+
--task "Update documentation for release readiness." \
|
|
169
|
+
--result "Updated release readiness documentation and linked related guides." \
|
|
170
|
+
--commands "rg \"doctor --strict|verify:release\" README.md docs"
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Incident Follow-Up
|
|
174
|
+
|
|
175
|
+
Use the incident route for regressions, broken releases, privacy hazards, or any failure that needs explicit mitigation evidence.
|
|
176
|
+
|
|
177
|
+
```bash
|
|
178
|
+
briefops harness route --task "Investigate the package release failure." --type production-incident
|
|
179
|
+
briefops prime --worker repo-worker --task "Investigate the package release failure." --format codex --max-tokens 800
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Close with an incident, decision, and next step:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
briefops finish \
|
|
186
|
+
--worker repo-worker \
|
|
187
|
+
--task "Investigate the package release failure." \
|
|
188
|
+
--result "Identified missing dist files in the dry-run package." \
|
|
189
|
+
--incident "Release candidate omitted generated dist output." \
|
|
190
|
+
--decision "Run npm pack dry-run after build and before publish." \
|
|
191
|
+
--next-step "Update release checklist and rerun package verification."
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
## Sharing Repository Context
|
|
195
|
+
|
|
196
|
+
Keep `.briefops/` local unless the contents are intentionally curated.
|
|
197
|
+
|
|
198
|
+
Use `shared-only` for context that may be pasted, attached, or committed:
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
briefops prime --worker repo-worker --task "Review this pull request." --format codex --export-policy shared-only
|
|
202
|
+
briefops pack resume --worker repo-worker --task "Continue review." --export-policy shared-only
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
Router exports point tools at BriefOps commands and do not copy local memory:
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
briefops export agents-md
|
|
209
|
+
briefops export claude-md
|
|
210
|
+
briefops export cursor-rules
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
Before publishing or sharing generated context:
|
|
214
|
+
|
|
215
|
+
```bash
|
|
216
|
+
briefops doctor --privacy
|
|
217
|
+
briefops doctor --strict --json
|
|
218
|
+
```
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Use Cases
|
|
2
|
+
|
|
3
|
+
BriefOps helps developers keep useful AI coding context across fresh threads without turning the repository into a context dump.
|
|
4
|
+
|
|
5
|
+
Use it when a task depends on prior decisions, recent work, project-specific constraints, or open risks that should survive beyond one chat session.
|
|
6
|
+
|
|
7
|
+
## Fresh Thread Priming
|
|
8
|
+
|
|
9
|
+
Use `prime` at the start of a new AI coding thread when the agent needs project context before reading broadly.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
briefops prime --task "Continue the release readiness review." --format codex --max-tokens 800
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
This is useful for:
|
|
16
|
+
|
|
17
|
+
- starting a new thread with a compact project and worker summary
|
|
18
|
+
- avoiding a manual paste of old chat history
|
|
19
|
+
- keeping the first context small enough to inspect
|
|
20
|
+
- applying the same worker style across related tasks
|
|
21
|
+
|
|
22
|
+
Use a resume pack only when the next thread needs more continuity than `prime` should carry:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
briefops continue --worker repo-worker --task "Continue the release readiness review." --pack
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Pull Request Review
|
|
29
|
+
|
|
30
|
+
Use BriefOps when a review has findings, follow-up checks, or risks that may outlive the current thread.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
briefops harness route --task "Review this pull request." --type code-review
|
|
34
|
+
briefops prime --task "Review this pull request." --format codex --max-tokens 800
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
After review work finishes, record the result and any unresolved risk:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
briefops finish \
|
|
41
|
+
--worker repo-worker \
|
|
42
|
+
--task "Review this pull request." \
|
|
43
|
+
--result "Found a blocking regression in the release readiness path." \
|
|
44
|
+
--open-risk "Strict doctor JSON output still needs targeted verification." \
|
|
45
|
+
--next-step "Run the strict doctor check and update the review."
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
This keeps the next review thread focused on unresolved work instead of rediscovering the same findings.
|
|
49
|
+
|
|
50
|
+
## Release Readiness
|
|
51
|
+
|
|
52
|
+
Use BriefOps for release work when commands, package contents, privacy checks, and remaining blockers need a durable trail.
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
briefops harness route --task "Prepare this release." --type release-preparation
|
|
56
|
+
npm run build
|
|
57
|
+
npm test
|
|
58
|
+
briefops doctor --strict --json
|
|
59
|
+
npm pack --dry-run
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Then close the loop:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
briefops finish \
|
|
66
|
+
--worker repo-worker \
|
|
67
|
+
--task "Prepare this release." \
|
|
68
|
+
--result "Build, tests, strict doctor, and dry-run package review completed." \
|
|
69
|
+
--decision "Release package contents are ready for publish." \
|
|
70
|
+
--commands "npm run build,npm test,briefops doctor --strict --json,npm pack --dry-run"
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Run commands that contact external registries only from an environment where that disclosure is acceptable.
|
|
74
|
+
|
|
75
|
+
## Long-Running Maintenance
|
|
76
|
+
|
|
77
|
+
Use workers and memory when cleanup, dependency work, or refactors span multiple sessions.
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
briefops skill create repo-review \
|
|
81
|
+
--description "Review maintenance work for regressions, stale assumptions, and release risk."
|
|
82
|
+
|
|
83
|
+
briefops project create briefops \
|
|
84
|
+
--description "Local-first CLI for AI coding agent context continuity."
|
|
85
|
+
|
|
86
|
+
briefops worker create repo-worker \
|
|
87
|
+
--project briefops \
|
|
88
|
+
--skills "repo-review" \
|
|
89
|
+
--style "small scoped diffs, verify before completion, record durable decisions"
|
|
90
|
+
|
|
91
|
+
briefops worker use repo-worker
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
During the work:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
briefops obs continuity --worker repo-worker --task "Continue dependency cleanup." --json
|
|
98
|
+
briefops prime --worker repo-worker --task "Continue dependency cleanup." --format codex --max-tokens 800
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Record only reusable knowledge as durable memory. Use low-importance or no-memory paths for one-off exploration:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
briefops finish --task "Fix typo" --result "Fixed typo." --importance trivial
|
|
105
|
+
briefops finish --task "Try discarded approach" --result "Discarded." --no-memory-proposal
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Incident Follow-Up
|
|
109
|
+
|
|
110
|
+
Use the incident route when a regression, outage, or release blocker needs findings, mitigation evidence, and a follow-up trail.
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
briefops harness route --task "Investigate the release regression." --type production-incident
|
|
114
|
+
briefops prime --task "Investigate the release regression." --format codex --max-tokens 800
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
After mitigation:
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
briefops finish \
|
|
121
|
+
--worker repo-worker \
|
|
122
|
+
--task "Investigate the release regression." \
|
|
123
|
+
--result "Mitigated the failing package check." \
|
|
124
|
+
--incident "Release dry-run failed because generated files were missing from dist." \
|
|
125
|
+
--decision "Release verification must include npm pack dry-run before publish." \
|
|
126
|
+
--next-step "Add the package check to the release checklist."
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Privacy-Safe Sharing
|
|
130
|
+
|
|
131
|
+
Use `shared-only` when generated context may leave the local workspace.
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
briefops prime --task "Review this pull request." --format codex --export-policy shared-only
|
|
135
|
+
briefops pack resume --worker repo-worker --task "Continue the review." --export-policy shared-only
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
`shared-only` includes only memory marked `visibility: shared` and `exportable: true`. It omits private memory, raw work logs, open risks, local next steps, private worker history, incidents, and private metadata counts.
|
|
139
|
+
|
|
140
|
+
Before publishing a repository or sharing generated context, run:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
briefops doctor --privacy
|
|
144
|
+
briefops doctor --stability
|
|
145
|
+
briefops doctor --strict --json
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Router exports are safe to commit when reviewed because they point tools at BriefOps commands instead of copying `.briefops/` memory:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
briefops export all
|
|
152
|
+
```
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# BriefOps Utility Log: Harness Continuity
|
|
2
|
+
|
|
3
|
+
date: 2026-07-05
|
|
4
|
+
evaluator: maintainer example
|
|
5
|
+
project: briefops
|
|
6
|
+
task: Continue Master Harness product review in a fresh Codex thread.
|
|
7
|
+
fresh thread?: yes
|
|
8
|
+
BriefOps commands used:
|
|
9
|
+
- `briefops harness route --task "Review BriefOps 2.1.x product improvement opportunities."`
|
|
10
|
+
- `briefops prime --format codex --task "Review BriefOps 2.1.x product improvement opportunities." --max-tokens 800`
|
|
11
|
+
- `briefops obs continuity --worker briefops-maintainer --task "Review BriefOps 2.1.x product improvement opportunities." --json`
|
|
12
|
+
|
|
13
|
+
## Context Evidence
|
|
14
|
+
|
|
15
|
+
raw candidate context: observed through `obs continuity`
|
|
16
|
+
prime context: compact Codex-format context under the requested budget
|
|
17
|
+
compression ratio: copy from `obs continuity` when running the example
|
|
18
|
+
route: code-review or exploratory-research, depending on exact task wording
|
|
19
|
+
|
|
20
|
+
## Reuse Evidence
|
|
21
|
+
|
|
22
|
+
reused decisions:
|
|
23
|
+
- Missing `briefops` on PATH should be `Status: setup-required`.
|
|
24
|
+
- BriefOps should preserve local-first memory and avoid becoming an agent runtime.
|
|
25
|
+
|
|
26
|
+
reused lessons:
|
|
27
|
+
- Keep plugin cache and local plugin path synchronized during release work.
|
|
28
|
+
|
|
29
|
+
reused risks:
|
|
30
|
+
- npm publish may remain blocked by npm authentication.
|
|
31
|
+
|
|
32
|
+
reused next steps:
|
|
33
|
+
- Verify release-readiness behavior before publishing.
|
|
34
|
+
|
|
35
|
+
reused commands:
|
|
36
|
+
- `briefops prime --format codex --task "<task>" --max-tokens 800`
|
|
37
|
+
- `briefops continue --worker briefops-maintainer --task "<task>" --pack`
|
|
38
|
+
|
|
39
|
+
## Missing Or Repeated Context
|
|
40
|
+
|
|
41
|
+
what was still missing:
|
|
42
|
+
- Whether the previous route classification was correct for a product-review task.
|
|
43
|
+
|
|
44
|
+
repeated explanations:
|
|
45
|
+
- The reviewer still had to restate the product boundary from the user prompt.
|
|
46
|
+
|
|
47
|
+
repeated rejected approaches:
|
|
48
|
+
- MCP server, dashboard, database, vector search, and cloud sync remained out of scope.
|
|
49
|
+
|
|
50
|
+
## Scores
|
|
51
|
+
|
|
52
|
+
continuity score: 2
|
|
53
|
+
relevance score: 3
|
|
54
|
+
noise score: 1
|
|
55
|
+
estimated time saved: 10 minutes, hypothesis
|
|
56
|
+
|
|
57
|
+
## Notes
|
|
58
|
+
|
|
59
|
+
Prime carried release and setup context well. The product boundary still came
|
|
60
|
+
from the task prompt, which is appropriate because it is user-specified scope.
|
|
61
|
+
|
|
62
|
+
## Follow-Up
|
|
63
|
+
|
|
64
|
+
promote to memory?: no
|
|
65
|
+
adjust docs or examples?: yes
|
|
66
|
+
possible product improvement: Add a lightweight utility log so this judgment is repeatable.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# BriefOps Utility Log: Pull Request Review
|
|
2
|
+
|
|
3
|
+
date: 2026-07-05
|
|
4
|
+
evaluator: maintainer example
|
|
5
|
+
project: briefops
|
|
6
|
+
task: Review a pull request for regressions, privacy leaks, and missing tests.
|
|
7
|
+
fresh thread?: yes
|
|
8
|
+
BriefOps commands used:
|
|
9
|
+
- `briefops harness route --task "Review this pull request." --type code-review`
|
|
10
|
+
- `briefops prime --format codex --task "Review this pull request." --max-tokens 800`
|
|
11
|
+
- `briefops finish --worker briefops-maintainer --task "Review this pull request." --result "<result>" --open-risk "<risk>" --next-step "<next step>"`
|
|
12
|
+
- `briefops continue --worker briefops-maintainer --task "Finish unresolved PR review checks." --pack`
|
|
13
|
+
|
|
14
|
+
## Context Evidence
|
|
15
|
+
|
|
16
|
+
raw candidate context: observed through `obs continuity`
|
|
17
|
+
prime context: compact review context plus route contract
|
|
18
|
+
compression ratio: copy from `obs continuity`
|
|
19
|
+
route: code-review
|
|
20
|
+
|
|
21
|
+
## Reuse Evidence
|
|
22
|
+
|
|
23
|
+
reused decisions:
|
|
24
|
+
- Shared-only exports must omit private memory, local project file details, raw logs, open risks, and private metadata counts.
|
|
25
|
+
|
|
26
|
+
reused lessons:
|
|
27
|
+
- Review outputs should lead with actionable findings and explicit verification gaps.
|
|
28
|
+
|
|
29
|
+
reused risks:
|
|
30
|
+
- A change touching shared output paths can leak private continuity data if not checked.
|
|
31
|
+
|
|
32
|
+
reused next steps:
|
|
33
|
+
- Run targeted tests for shared-only output and output overwrite protection.
|
|
34
|
+
|
|
35
|
+
reused commands:
|
|
36
|
+
- `npm test -- tests/safety.test.ts`
|
|
37
|
+
- `npm test -- tests/output-safety.test.ts`
|
|
38
|
+
|
|
39
|
+
## Missing Or Repeated Context
|
|
40
|
+
|
|
41
|
+
what was still missing:
|
|
42
|
+
- Exact changed files in the pull request; BriefOps does not inspect the diff for the reviewer.
|
|
43
|
+
|
|
44
|
+
repeated explanations:
|
|
45
|
+
- The user still needed to provide the PR or diff target.
|
|
46
|
+
|
|
47
|
+
repeated rejected approaches:
|
|
48
|
+
- Treating context compression as proof that the review was correct.
|
|
49
|
+
|
|
50
|
+
## Scores
|
|
51
|
+
|
|
52
|
+
continuity score: 2
|
|
53
|
+
relevance score: 2
|
|
54
|
+
noise score: 1
|
|
55
|
+
estimated time saved: 8 minutes, hypothesis
|
|
56
|
+
|
|
57
|
+
## Notes
|
|
58
|
+
|
|
59
|
+
BriefOps helps preserve review style, known risks, and follow-up checks. It does
|
|
60
|
+
not replace source inspection or diff review.
|
|
61
|
+
|
|
62
|
+
## Follow-Up
|
|
63
|
+
|
|
64
|
+
promote to memory?: only for durable findings or repeated failure patterns
|
|
65
|
+
adjust docs or examples?: yes, if reviewers repeatedly miss the expected final response contract
|
|
66
|
+
possible product improvement: Add more example logs before changing routing logic.
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# BriefOps Utility Log: Release Readiness
|
|
2
|
+
|
|
3
|
+
date: 2026-07-05
|
|
4
|
+
evaluator: maintainer example
|
|
5
|
+
project: briefops
|
|
6
|
+
task: Prepare a patch release and verify local release readiness.
|
|
7
|
+
fresh thread?: no
|
|
8
|
+
BriefOps commands used:
|
|
9
|
+
- `briefops harness route --task "Prepare this release." --type release-preparation`
|
|
10
|
+
- `briefops doctor --strict --json`
|
|
11
|
+
- `briefops obs continuity --worker briefops-maintainer --task "Prepare this release." --json`
|
|
12
|
+
- `briefops finish --worker briefops-maintainer --task "Prepare this release." --result "<result>" --commands "npm run build,npm test,briefops doctor --strict --json,npm pack --dry-run"`
|
|
13
|
+
|
|
14
|
+
## Context Evidence
|
|
15
|
+
|
|
16
|
+
raw candidate context: observed through `obs continuity`
|
|
17
|
+
prime context: not used if continuing in the same terminal session
|
|
18
|
+
compression ratio: copy from `obs continuity` if prime was used
|
|
19
|
+
route: release-preparation
|
|
20
|
+
|
|
21
|
+
## Reuse Evidence
|
|
22
|
+
|
|
23
|
+
reused decisions:
|
|
24
|
+
- Warnings from strict doctor should keep `releaseReady` false.
|
|
25
|
+
- Generated harness files must be routers, not memory dumps.
|
|
26
|
+
|
|
27
|
+
reused lessons:
|
|
28
|
+
- Run package dry-run after build and before publish.
|
|
29
|
+
|
|
30
|
+
reused risks:
|
|
31
|
+
- npm registry commands disclose dependency or package metadata.
|
|
32
|
+
- npm authentication can block publish even when local release checks pass.
|
|
33
|
+
|
|
34
|
+
reused next steps:
|
|
35
|
+
- Authenticate npm before publishing.
|
|
36
|
+
- Review package contents before release.
|
|
37
|
+
|
|
38
|
+
reused commands:
|
|
39
|
+
- `npm run build`
|
|
40
|
+
- `npm test`
|
|
41
|
+
- `briefops doctor --strict --json`
|
|
42
|
+
- `npm pack --dry-run`
|
|
43
|
+
|
|
44
|
+
## Missing Or Repeated Context
|
|
45
|
+
|
|
46
|
+
what was still missing:
|
|
47
|
+
- Actual npm authentication state, because it must be checked in the release environment.
|
|
48
|
+
|
|
49
|
+
repeated explanations:
|
|
50
|
+
- None if the release checklist and prior memory were available.
|
|
51
|
+
|
|
52
|
+
repeated rejected approaches:
|
|
53
|
+
- Skipping strict doctor because build and tests passed.
|
|
54
|
+
|
|
55
|
+
## Scores
|
|
56
|
+
|
|
57
|
+
continuity score: 3
|
|
58
|
+
relevance score: 3
|
|
59
|
+
noise score: 0
|
|
60
|
+
estimated time saved: 15 minutes, hypothesis
|
|
61
|
+
|
|
62
|
+
## Notes
|
|
63
|
+
|
|
64
|
+
This is a strong BriefOps use case because release work depends on remembered
|
|
65
|
+
commands, blockers, and verification discipline.
|
|
66
|
+
|
|
67
|
+
## Follow-Up
|
|
68
|
+
|
|
69
|
+
promote to memory?: yes, if a new blocker or release rule was discovered
|
|
70
|
+
adjust docs or examples?: no
|
|
71
|
+
possible product improvement: Keep release-readiness examples tied to strict doctor and pack dry-run evidence.
|
package/package.json
CHANGED