overlord-cli 3.5.4 → 3.10.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/README.md
CHANGED
|
@@ -54,12 +54,6 @@ ovld doctor
|
|
|
54
54
|
- `setup` - install the Overlord connector or plugin bundle for a supported agent
|
|
55
55
|
- `doctor` - verify installed agent connectors and check whether a newer CLI version is available
|
|
56
56
|
|
|
57
|
-
##
|
|
57
|
+
## License
|
|
58
58
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
yarn cli:publish
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
That script syncs the package payload and then runs `npm publish --access public` from `packages/overlord-cli/`.
|
|
59
|
+
Permission is granted to use this software for any purpose, free of charge. You may not modify, distribute, sublicense, or sell copies of the software without explicit permission from the author.
|
package/bin/_cli/setup.mjs
CHANGED
|
@@ -86,6 +86,7 @@ If you receive a prompt with a specified ticket ID, adhere to the following. If
|
|
|
86
86
|
\`\`\`bash
|
|
87
87
|
ovld protocol deliver --session-key <sessionKey> --ticket-id $TICKET_ID --payload-file ./deliver.json
|
|
88
88
|
\`\`\`
|
|
89
|
+
Treat \`deliver.json\` as ephemeral scratch data only. Create it outside the repository when practical, never commit it, and remove it after delivery.
|
|
89
90
|
|
|
90
91
|
## Change Rationales
|
|
91
92
|
|
|
@@ -93,7 +94,7 @@ Always include \`changeRationales\` when delivering. Optionally include them on
|
|
|
93
94
|
|
|
94
95
|
Before delivering, make sure every meaningful git-tracked file change is represented in \`changeRationales\`; do not send \`file_changes\` as an artifact.
|
|
95
96
|
|
|
96
|
-
These are structured protocol payloads that Overlord stores as first-class rows in the \`file_changes\` table. Prefer inline JSON or the dedicated command below. For quote-sensitive deliveries, prefer \`--payload-file\` so summary, artifacts, and change rationales stay in one JSON document. Ordinary deliver artifacts should use \`next_steps\`, \`test_results\`, \`migration\`, \`note\`, \`url\`, or \`decision\`.
|
|
97
|
+
These are structured protocol payloads that Overlord stores as first-class rows in the \`file_changes\` table. Prefer inline JSON or the dedicated command below. For quote-sensitive deliveries, prefer \`--payload-file\` so summary, artifacts, and change rationales stay in one JSON document, but treat that JSON as ephemeral scratch data rather than a repository artifact. Ordinary deliver artifacts should use \`next_steps\`, \`test_results\`, \`migration\`, \`note\`, \`url\`, or \`decision\`.
|
|
97
98
|
|
|
98
99
|
\`\`\`bash
|
|
99
100
|
ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \\\\
|
|
@@ -155,10 +156,11 @@ If you receive a prompt with a specified ticket ID, adhere to the following. If
|
|
|
155
156
|
--artifacts-json '[{"type":"next_steps","label":"Next steps","content":"..."}]' \\\\
|
|
156
157
|
--change-rationales-json '[{"label":"Short reviewer title","file_path":"path/to/file.ts","summary":"What changed.","why":"Why it changed.","impact":"Behavioral impact.","hunks":[{"header":"@@ -10,6 +10,14 @@"}]}]'
|
|
157
158
|
\`\`\`
|
|
159
|
+
If you use \`--payload-file\`, \`--artifacts-file\`, or \`--change-rationales-file\` for larger JSON, treat that file as ephemeral scratch data outside the repository and remove it after delivery. Do not leave delivery JSON checked into the worktree.
|
|
158
160
|
|
|
159
161
|
## Change Rationales
|
|
160
162
|
|
|
161
|
-
Always include \`changeRationales\` when delivering. Before delivering, make sure every meaningful git-tracked file change is represented in \`changeRationales\`; do not send \`file_changes\` as an artifact. Record only meaningful behavioral changes. Overlord stores these as structured rows in the \`file_changes\` table.
|
|
163
|
+
Always include \`changeRationales\` when delivering. Before delivering, make sure every meaningful git-tracked file change is represented in \`changeRationales\`; do not send \`file_changes\` as an artifact. Record only meaningful behavioral changes. Overlord stores these as structured rows in the \`file_changes\` table. If you need a JSON file for transport, keep it ephemeral and out of the repository.
|
|
162
164
|
|
|
163
165
|
\`\`\`bash
|
|
164
166
|
ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \\\\
|
|
@@ -227,6 +229,7 @@ When done, deliver with artifacts and change rationales:
|
|
|
227
229
|
\`\`\`bash
|
|
228
230
|
ovld protocol deliver --session-key <sessionKey> --ticket-id $TICKET_ID --summary "Narrative: what you did, next steps." --artifacts-json '[{"type":"next_steps","label":"Next steps","content":"..."}]' --change-rationales-json '[{"label":"Short reviewer title","file_path":"path/to/file.ts","summary":"What changed.","why":"Why it changed.","impact":"Behavioral impact.","hunks":[{"header":"@@ -10,6 +10,14 @@"}]}]'
|
|
229
231
|
\`\`\`
|
|
232
|
+
If you use a JSON file for delivery transport, keep it ephemeral scratch data outside the repository and remove it after the protocol call.
|
|
230
233
|
|
|
231
234
|
Rules:
|
|
232
235
|
- Always attach first and deliver last.
|
package/bin/ovld.mjs
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Canonical CLI entrypoint. Used by both the npm package and the Electron app.
|
|
5
|
+
* All CLI source files live in _cli/ alongside this file.
|
|
6
|
+
*/
|
|
7
|
+
|
|
3
8
|
import { runCli } from './_cli/index.mjs';
|
|
4
9
|
|
|
5
10
|
runCli({ primaryCommand: 'ovld' }).catch((error) => {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "overlord-cli",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.10.0",
|
|
4
4
|
"description": "Overlord CLI — launch AI agents on tickets from anywhere",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"agents",
|
|
24
24
|
"cli"
|
|
25
25
|
],
|
|
26
|
-
"license": "
|
|
26
|
+
"license": "Proprietary",
|
|
27
27
|
"repository": {
|
|
28
28
|
"type": "git",
|
|
29
29
|
"url": "https://github.com/cooperativ/overlord"
|
|
@@ -15,6 +15,7 @@ Overlord plugin.
|
|
|
15
15
|
and stop.
|
|
16
16
|
6. Deliver last with `ovld protocol deliver`, including meaningful `changeRationales` for every
|
|
17
17
|
behavioral git-tracked change.
|
|
18
|
+
If you need `--payload-file`, `--artifacts-file`, or `--change-rationales-file`, treat that JSON as ephemeral scratch data, not as a repository file. Remove it after delivery and never commit it.
|
|
18
19
|
|
|
19
20
|
## Rules
|
|
20
21
|
|