myte 0.0.13 → 0.0.15

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.
Files changed (2) hide show
  1. package/README.md +24 -5
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -8,6 +8,8 @@ Use one of these flows:
8
8
 
9
9
  - Local dependency in your project:
10
10
  - `npm install myte`
11
+ - then run `npx myte ai "Explain this repository"`
12
+ - then run `npx myte ai "Return a JSON object with risks and next_steps" --json-response`
11
13
  - then run `npx myte config --json`
12
14
  - then run `npx myte bootstrap`
13
15
  - then run `npx myte run-qaqc --mission-ids M001 --wait --sync`
@@ -24,6 +26,7 @@ Use one of these flows:
24
26
  - or `npm exec myte -- query "What changed in logging?" --with-diff`
25
27
  - Global install:
26
28
  - `npm i -g myte`
29
+ - then run `myte ai "Explain this repository"`
27
30
  - then run `myte bootstrap`
28
31
  - then run `myte run-qaqc --mission-ids M001 --wait --sync`
29
32
  - then run `myte sync-qaqc`
@@ -37,6 +40,7 @@ Use one of these flows:
37
40
  - then run `myte update-owner --subject "QAQC progress" --body-file ./updates/owner.md`
38
41
  - then run `myte update-client --subject "Weekly client update" --body-file ./updates/week-12.md`
39
42
  - No install:
43
+ - `npx myte@latest ai "Explain this repository"`
40
44
  - `npx myte@latest bootstrap`
41
45
  - `npx myte@latest run-qaqc --mission-ids M001 --wait --sync`
42
46
  - `npx myte@latest sync-qaqc`
@@ -56,12 +60,14 @@ Important:
56
60
  - `npm install myte` gives the user everything needed locally.
57
61
  - The normal local command is `npx myte ...` or `npm exec myte -- ...`.
58
62
  - Bare `myte ...` only works after `npm i -g myte`.
63
+ - `myte ai` uses `MYTEAI_API_KEY` and the `api.myte.ai` gateway.
59
64
 
60
65
  ## Requirements
61
66
 
62
67
  - Node `18+`
63
68
  - macOS, Linux, and Windows are supported
64
69
  - `git` available in `PATH` for `--with-diff`
70
+ - `MYTEAI_API_KEY=<inference_api_key>` available in your shell or in a `.env` for `myte ai`
65
71
  - `MYTE_API_KEY=<project_api_key>` available in your shell or in a `.env`
66
72
  - the CLI searches for `.env` in the current folder and then up parent directories
67
73
  - For deterministic diff capture, run from:
@@ -78,6 +84,17 @@ Run this first when onboarding on a new machine:
78
84
  - or `npm exec myte -- config --json`
79
85
  - or `npx myte@latest config --json`
80
86
 
87
+ ## Myte AI gateway
88
+
89
+ Use `myte ai` as the thin inference gateway client. The npm package does not ship models or backend internals; it sends your request to `api.myte.ai` with `MYTEAI_API_KEY`.
90
+
91
+ Examples:
92
+
93
+ - `npx myte ai "Explain what this repository does"`
94
+ - `npx myte ai "Return a JSON object with risks and next_steps" --json-response`
95
+ - `npm exec myte -- ai "Summarize this file"`
96
+ - `myte ai "Return clean JSON only" --json-response`
97
+
81
98
  It confirms:
82
99
  - the API key resolves to the expected project
83
100
  - which repo names the project is configured with
@@ -116,22 +133,23 @@ Useful forms:
116
133
 
117
134
  Run this from any workspace with a valid project key:
118
135
 
119
- - `npx myte run-qaqc --mission-ids M001,M002 --wait --sync`
120
- - or `npm exec myte -- run-qaqc --mission-ids M001,M002 --wait --sync`
121
- - or `myte run-qaqc --mission-ids M001,M002 --wait --sync`
136
+ - `npx myte run-qaqc --mission-ids "M001,M002" --wait --sync`
137
+ - or `npm exec myte -- run-qaqc --mission-ids "M001,M002" --wait --sync`
138
+ - or `myte run-qaqc --mission-ids "M001,M002" --wait --sync`
122
139
 
123
140
  What it does:
124
141
  - queues QAQC for up to 10 explicit mission ids through the project-key API surface
125
142
  - returns a `batch_id` immediately
126
143
  - uses `--wait` to poll the batch until it reaches a terminal state
127
144
  - uses `--sync` to refresh `MyteCommandCenter/data/qaqc.yml` after a completed batch
145
+ - on PowerShell, quote comma-separated multi-id values: `--mission-ids "M001,M002"`
128
146
  - runs through the dedicated `project_api_qaqc` queue inside the existing Celery service, with a global budget of `20` dispatch starts/minute and `20` live jobs
129
147
  - a saturated `run-qaqc --wait` batch can take roughly `5-10` minutes before sync has final data to pull
130
148
 
131
149
  Useful forms:
132
150
  - `npx myte run-qaqc --mission-ids M001`
133
- - `npx myte run-qaqc --mission-ids M001,M002 --wait`
134
- - `npx myte run-qaqc --mission-ids M001,M002 --wait --sync --json`
151
+ - `npx myte run-qaqc --mission-ids "M001,M002" --wait`
152
+ - `npx myte run-qaqc --mission-ids "M001,M002" --wait --sync --json`
135
153
 
136
154
  ## Sync active mission QAQC context
137
155
 
@@ -365,6 +383,7 @@ Notes:
365
383
  - `--subject` is required.
366
384
  - The body can come from `--body-markdown`, `--body-file`, a positional file path, positional inline text, or `--stdin`.
367
385
  - `target_contact_ids` are optional. If omitted, the backend selects the linked primary client contact when available.
386
+ - If no linked client contacts exist, the backend falls back to the project owner so internal projects can still draft/send updates through the same flow.
368
387
  - Use `--target-contact-id <id>` multiple times or `--target-contact-ids <id1,id2>`.
369
388
  - The CLI prints the returned draft summary, including the draft id, status, recipients, and snippet.
370
389
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "myte",
3
- "version": "0.0.13",
4
- "description": "Myte developer CLI (Project Assistant + deterministic diffs).",
3
+ "version": "0.0.15",
4
+ "description": "Myte developer CLI (Project Assistant + Myte AI gateway).",
5
5
  "type": "commonjs",
6
6
  "license": "MIT",
7
7
  "files": [
@@ -16,6 +16,6 @@
16
16
  "node": ">=18"
17
17
  },
18
18
  "dependencies": {
19
- "@mytegroupinc/myte-core": "0.0.13"
19
+ "@mytegroupinc/myte-core": "0.0.15"
20
20
  }
21
21
  }