@brunyee-studio/onus-cli 2.30.1 → 2.31.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": "@brunyee-studio/onus-cli",
3
- "version": "2.30.1",
3
+ "version": "2.31.0",
4
4
  "description": "Official CLI and TypeScript SDK for Onus issue tracking platform",
5
5
  "keywords": [
6
6
  "agent",
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: onus-cli
3
- description: Work with Onus issue tracking through the onus CLI — authenticate, fetch teams/projects/issues, create and update issues, manage comments, labels, relations, and attachments. Use when the user asks to find, list, create, update, comment on, or organize Onus issues, projects, or teams.
3
+ description: Work with Onus issue tracking through the onus CLI — authenticate, fetch teams/projects/issues, create and update issues, manage comments, labels, relations, and attachments, and consult the knowledge base (kb). Use when the user asks to find, list, create, update, comment on, or organize Onus issues, projects, or teams, or to read KB docs.
4
4
  ---
5
5
 
6
6
  # Onus CLI
@@ -26,7 +26,7 @@ Transparent refresh on 401 applies only to the stored config-file session.
26
26
 
27
27
  ## Golden rules
28
28
 
29
- - **Starting work on an issue: transition it to `in_progress` immediately.** As soon as you pick up an issue to implement it — before writing any code — run `onus issue update <ref> --status in_progress --json`. No update needed if `onus issue get <ref> --json` already shows the status is `in_progress` or `done`.
29
+ - **Starting work on an issue: transition it to `in_progress` and make sure it has an owner — you.** As soon as you pick up an issue to implement it — before writing any code — resolve your user id (`onus me --json` → `.id`), then run `onus issue update <ref> --status in_progress --assignee <userId> --json`. Self-assign only when the issue is unassigned or already assigned to you; if someone else is the assignee, leave them in place and say so. No update needed if `onus issue get <ref> --json` already shows the status is `in_progress` or `done` — but if it is `in_progress` while unassigned, still assign it to yourself.
30
30
  - Add `--json` to every command you intend to parse.
31
31
  - Multi-line text (issue descriptions, comment bodies, agent context) goes through the field's file flag — `--description-file`, `--body-file`, `--agent-context-file` — never inline in the shell command. See "Long text via file input" below.
32
32
  - Whenever referencing an Onus issue in any response, include its link: `https://onus.brunyeestudio.com/team/{TEAM}/issues/{NUM}` where `{TEAM}` is the team key (the tag before the dash in the ref, e.g. `ONUS`) and `{NUM}` is the issue number (the number after the dash). Example: for ref `ONUS-1`, `TEAM = ONUS`, `NUM = 1` → https://onus.brunyeestudio.com/team/ONUS/issues/1
@@ -50,8 +50,10 @@ onus label list --json # workspace labels (for --label ids)
50
50
  ```bash
51
51
  onus issue list --json
52
52
  onus issue list --team ONUS --status in_progress --json
53
+ onus issue list --priority high --team ONUS --json # filter by priority
53
54
  onus issue list --assignee <userId> --project <projectId> --json
54
55
  onus issue list --q "login bug" --limit 20 --json # free-text search
56
+ onus issue list --q ONUS-42 --json # display-key search
55
57
  onus issue list --cursor <cursor> --json # next page
56
58
  onus issue get ENG-42 --json # single issue by ref
57
59
  ```
@@ -198,6 +200,27 @@ onus dsn enable <keyId> --json # re-enable a disabled key
198
200
  onus dsn revoke <keyId> --json # terminal
199
201
  ```
200
202
 
203
+ ## Knowledge base (agent workflow)
204
+
205
+ Consult the KB before implementing an issue — docs (`index | area | process |
206
+ incident` kinds) describe code areas, processes, and incidents. Read-only: no
207
+ CLI command or API mutates docs.
208
+
209
+ ```bash
210
+ onus kb locate --issue <issueUuid> --json # locate first, on issue start (or --query "text"; exactly one)
211
+ onus kb get <slug> --json # then read each returned doc (also accepts UUID; ambiguous slug → exit 2)
212
+ onus kb search "<query>" --json # scored search; --mode string|semantic|hybrid|related (--doc <slug> required with related)
213
+ onus kb related <slug> --json # expand related docs
214
+ onus kb list --team ONUS --kind area --tag auth --limit 20 --cursor <cursor> --json
215
+ ```
216
+
217
+ - Results carry staleness `{stale, confidence, reason}` — a `stale` doc is
218
+ planning input: verify it against current code and surface drift.
219
+ - **Surface drift, never write it.** Note stale/incorrect docs in the PR
220
+ description ("KB drift: …"); regeneration is infrastructure-led on merge —
221
+ the pipeline updates affected docs automatically after the PR merges
222
+ (human-edited docs get proposed revisions for human approval).
223
+
201
224
  ## Pull requests and issues
202
225
 
203
226
  Linking a PR to an issue means **the issue is auto-closed when the PR merges** —