overlord-cli 0.2605211051.0 → 0.2605211850.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "overlord-cli",
3
- "version": "0.2605211051.0",
3
+ "version": "0.2605211850.0",
4
4
  "description": "Overlord CLI — launch AI agents on tickets from anywhere",
5
5
  "homepage": "https://www.ovld.ai/docs/",
6
6
  "type": "module",
@@ -58,7 +58,11 @@ Always include `changeRationales` when delivering. Optionally include them on up
58
58
 
59
59
  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. Skip formatting-only noise.
60
60
 
61
- For the `record-change-rationales` command and `--change-rationales-json` payload shape see [reference/cli.md](reference/cli.md).
61
+ Each rationale entry requires these fields: `file_path`, `label`, `summary`, `why`, `impact` — all strings. Do **not** use `filePath` or `rationale`; those are a different internal shape and will cause a validation error.
62
+
63
+ For more than a handful of entries, use `--change-rationales-file` with a temp file or stdin (`-`) instead of inline `--change-rationales-json` to avoid shell quoting failures with large arrays.
64
+
65
+ For the `record-change-rationales` command and full payload shape with optional `hunks` see [reference/cli.md](reference/cli.md).
62
66
 
63
67
  ## Rules
64
68
 
@@ -64,6 +64,8 @@ ovld protocol revert --objective-id <objective-id>
64
64
 
65
65
  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. Use `--payload-json` for compact full delivery payloads, or `--payload-file -` when the JSON is larger or quote-sensitive so summary, artifacts, and change rationales stay in one JSON document without creating a temporary file.
66
66
 
67
+ **Required fields per entry:** `file_path`, `label`, `summary`, `why`, `impact` (all strings). Do not use `filePath` or `rationale` — those are the internal API shape and will fail CLI validation.
68
+
67
69
  ```bash
68
70
  ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \
69
71
  --summary "Recorded rationale details for the latest code changes." --phase execute \
@@ -76,6 +78,19 @@ ovld protocol update --session-key <sessionKey> --ticket-id $TICKET_ID \
76
78
  --change-rationales-json '[{"label":"Add backoff","file_path":"lib/api.ts","summary":"Added retry.","why":"Transient failures.","impact":"Retries 3x.","hunks":[{"header":"@@ -22,4 +22,18 @@"}]}]'
77
79
  ```
78
80
 
81
+ For many entries (roughly 5+), pipe via stdin to avoid shell quoting failures:
82
+
83
+ ```bash
84
+ ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \
85
+ --summary "Recorded rationale details for the latest code changes." --phase execute \
86
+ --change-rationales-file - <<'EOF'
87
+ [
88
+ {"label":"Add backoff","file_path":"lib/api.ts","summary":"Added retry.","why":"Transient failures.","impact":"Retries 3x."},
89
+ {"label":"Update config","file_path":"lib/config.ts","summary":"Added timeout.","why":"Match new defaults.","impact":"Requests time out after 30s."}
90
+ ]
91
+ EOF
92
+ ```
93
+
79
94
  ## Project Discovery And Ticket Creation
80
95
 
81
96
  When creating tickets from within a repository:
@@ -58,7 +58,11 @@ Always include `changeRationales` when delivering. Optionally include them on up
58
58
 
59
59
  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. Skip formatting-only noise.
60
60
 
61
- For the `record-change-rationales` command and `--change-rationales-json` payload shape see [reference/cli.md](reference/cli.md).
61
+ Each rationale entry requires these fields: `file_path`, `label`, `summary`, `why`, `impact` — all strings. Do **not** use `filePath` or `rationale`; those are a different internal shape and will cause a validation error.
62
+
63
+ For more than a handful of entries, use `--change-rationales-file` with a temp file or stdin (`-`) instead of inline `--change-rationales-json` to avoid shell quoting failures with large arrays.
64
+
65
+ For the `record-change-rationales` command and full payload shape with optional `hunks` see [reference/cli.md](reference/cli.md).
62
66
 
63
67
  ## Rules
64
68
 
@@ -64,6 +64,8 @@ ovld protocol revert --objective-id <objective-id>
64
64
 
65
65
  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. Use `--payload-json` for compact full delivery payloads, or `--payload-file -` when the JSON is larger or quote-sensitive so summary, artifacts, and change rationales stay in one JSON document without creating a temporary file.
66
66
 
67
+ **Required fields per entry:** `file_path`, `label`, `summary`, `why`, `impact` (all strings). Do not use `filePath` or `rationale` — those are the internal API shape and will fail CLI validation.
68
+
67
69
  ```bash
68
70
  ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \
69
71
  --summary "Recorded rationale details for the latest code changes." --phase execute \
@@ -76,6 +78,19 @@ ovld protocol update --session-key <sessionKey> --ticket-id $TICKET_ID \
76
78
  --change-rationales-json '[{"label":"Add backoff","file_path":"lib/api.ts","summary":"Added retry.","why":"Transient failures.","impact":"Retries 3x.","hunks":[{"header":"@@ -22,4 +22,18 @@"}]}]'
77
79
  ```
78
80
 
81
+ For many entries (roughly 5+), pipe via stdin to avoid shell quoting failures:
82
+
83
+ ```bash
84
+ ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \
85
+ --summary "Recorded rationale details for the latest code changes." --phase execute \
86
+ --change-rationales-file - <<'EOF'
87
+ [
88
+ {"label":"Add backoff","file_path":"lib/api.ts","summary":"Added retry.","why":"Transient failures.","impact":"Retries 3x."},
89
+ {"label":"Update config","file_path":"lib/config.ts","summary":"Added timeout.","why":"Match new defaults.","impact":"Requests time out after 30s."}
90
+ ]
91
+ EOF
92
+ ```
93
+
79
94
  ## Project Discovery And Ticket Creation
80
95
 
81
96
  When creating tickets from within a repository:
@@ -58,7 +58,11 @@ Always include `changeRationales` when delivering. Optionally include them on up
58
58
 
59
59
  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. Skip formatting-only noise.
60
60
 
61
- For the `record-change-rationales` command and `--change-rationales-json` payload shape see [reference/cli.md](reference/cli.md).
61
+ Each rationale entry requires these fields: `file_path`, `label`, `summary`, `why`, `impact` — all strings. Do **not** use `filePath` or `rationale`; those are a different internal shape and will cause a validation error.
62
+
63
+ For more than a handful of entries, use `--change-rationales-file` with a temp file or stdin (`-`) instead of inline `--change-rationales-json` to avoid shell quoting failures with large arrays.
64
+
65
+ For the `record-change-rationales` command and full payload shape with optional `hunks` see [reference/cli.md](reference/cli.md).
62
66
 
63
67
  ## Rules
64
68
 
@@ -64,6 +64,8 @@ ovld protocol revert --objective-id <objective-id>
64
64
 
65
65
  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. Use `--payload-json` for compact full delivery payloads, or `--payload-file -` when the JSON is larger or quote-sensitive so summary, artifacts, and change rationales stay in one JSON document without creating a temporary file.
66
66
 
67
+ **Required fields per entry:** `file_path`, `label`, `summary`, `why`, `impact` (all strings). Do not use `filePath` or `rationale` — those are the internal API shape and will fail CLI validation.
68
+
67
69
  ```bash
68
70
  ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \
69
71
  --summary "Recorded rationale details for the latest code changes." --phase execute \
@@ -76,6 +78,19 @@ ovld protocol update --session-key <sessionKey> --ticket-id $TICKET_ID \
76
78
  --change-rationales-json '[{"label":"Add backoff","file_path":"lib/api.ts","summary":"Added retry.","why":"Transient failures.","impact":"Retries 3x.","hunks":[{"header":"@@ -22,4 +22,18 @@"}]}]'
77
79
  ```
78
80
 
81
+ For many entries (roughly 5+), pipe via stdin to avoid shell quoting failures:
82
+
83
+ ```bash
84
+ ovld protocol record-change-rationales --session-key <sessionKey> --ticket-id $TICKET_ID \
85
+ --summary "Recorded rationale details for the latest code changes." --phase execute \
86
+ --change-rationales-file - <<'EOF'
87
+ [
88
+ {"label":"Add backoff","file_path":"lib/api.ts","summary":"Added retry.","why":"Transient failures.","impact":"Retries 3x."},
89
+ {"label":"Update config","file_path":"lib/config.ts","summary":"Added timeout.","why":"Match new defaults.","impact":"Requests time out after 30s."}
90
+ ]
91
+ EOF
92
+ ```
93
+
79
94
  ## Project Discovery And Ticket Creation
80
95
 
81
96
  When creating tickets from within a repository: