@ora-ai/cli 0.24.0 → 0.26.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.
Files changed (149) hide show
  1. package/CHANGELOG.md +51 -0
  2. package/README.md +569 -462
  3. package/dist/command-tree.d.ts +30 -0
  4. package/dist/command-tree.d.ts.map +1 -0
  5. package/dist/command-tree.js +144 -0
  6. package/dist/command-tree.js.map +1 -0
  7. package/dist/core/cli-arguments.d.ts +21 -0
  8. package/dist/core/cli-arguments.d.ts.map +1 -0
  9. package/dist/core/cli-arguments.js +53 -0
  10. package/dist/core/cli-arguments.js.map +1 -0
  11. package/dist/core/error-envelope.d.ts +13 -4
  12. package/dist/core/error-envelope.d.ts.map +1 -1
  13. package/dist/core/error-envelope.js +19 -4
  14. package/dist/core/error-envelope.js.map +1 -1
  15. package/dist/core/error-stories.d.ts +36 -0
  16. package/dist/core/error-stories.d.ts.map +1 -0
  17. package/dist/core/error-stories.js +155 -0
  18. package/dist/core/error-stories.js.map +1 -0
  19. package/dist/core/http.d.ts +14 -3
  20. package/dist/core/http.d.ts.map +1 -1
  21. package/dist/core/http.js +24 -6
  22. package/dist/core/http.js.map +1 -1
  23. package/dist/core/limit-story.d.ts +13 -0
  24. package/dist/core/limit-story.d.ts.map +1 -0
  25. package/dist/core/limit-story.js +21 -0
  26. package/dist/core/limit-story.js.map +1 -0
  27. package/dist/core/operation-command.d.ts +10 -0
  28. package/dist/core/operation-command.d.ts.map +1 -0
  29. package/dist/core/operation-command.js +15 -0
  30. package/dist/core/operation-command.js.map +1 -0
  31. package/dist/core/operation-meta.d.ts +62 -0
  32. package/dist/core/operation-meta.d.ts.map +1 -0
  33. package/dist/core/operation-meta.js +15 -0
  34. package/dist/core/operation-meta.js.map +1 -0
  35. package/dist/core/output.d.ts +7 -5
  36. package/dist/core/output.d.ts.map +1 -1
  37. package/dist/core/output.js +21 -84
  38. package/dist/core/output.js.map +1 -1
  39. package/dist/core/problem.d.ts +34 -0
  40. package/dist/core/problem.d.ts.map +1 -0
  41. package/dist/core/problem.js +44 -0
  42. package/dist/core/problem.js.map +1 -0
  43. package/dist/core/retry-after.d.ts +4 -3
  44. package/dist/core/retry-after.d.ts.map +1 -1
  45. package/dist/core/retry-after.js +4 -3
  46. package/dist/core/retry-after.js.map +1 -1
  47. package/dist/core/run-operation.d.ts +12 -5
  48. package/dist/core/run-operation.d.ts.map +1 -1
  49. package/dist/core/run-operation.js +32 -11
  50. package/dist/core/run-operation.js.map +1 -1
  51. package/dist/generated/operations.d.ts +38 -1
  52. package/dist/generated/operations.d.ts.map +1 -1
  53. package/dist/generated/operations.js +27547 -171
  54. package/dist/generated/operations.js.map +1 -1
  55. package/dist/generated/types.d.ts +2113 -2
  56. package/dist/generated/types.d.ts.map +1 -1
  57. package/dist/generated/types.js +1 -1
  58. package/dist/interactive/derive-prompts.d.ts +13 -5
  59. package/dist/interactive/derive-prompts.d.ts.map +1 -1
  60. package/dist/interactive/derive-prompts.js +25 -1
  61. package/dist/interactive/derive-prompts.js.map +1 -1
  62. package/dist/interactive/session.d.ts +2 -2
  63. package/dist/interactive/session.d.ts.map +1 -1
  64. package/dist/interactive/session.js +35 -4
  65. package/dist/interactive/session.js.map +1 -1
  66. package/dist/mcp/defined-tools/defined-call.d.ts +18 -0
  67. package/dist/mcp/defined-tools/defined-call.d.ts.map +1 -0
  68. package/dist/mcp/defined-tools/defined-call.js +114 -0
  69. package/dist/mcp/defined-tools/defined-call.js.map +1 -0
  70. package/dist/mcp/defined-tools/defined-tool.d.ts +22 -0
  71. package/dist/mcp/defined-tools/defined-tool.d.ts.map +1 -0
  72. package/dist/mcp/defined-tools/defined-tool.js +35 -0
  73. package/dist/mcp/defined-tools/defined-tool.js.map +1 -0
  74. package/dist/mcp/defined-tools/json-conform.d.ts +28 -0
  75. package/dist/mcp/defined-tools/json-conform.d.ts.map +1 -0
  76. package/dist/mcp/defined-tools/json-conform.js +144 -0
  77. package/dist/mcp/defined-tools/json-conform.js.map +1 -0
  78. package/dist/mcp/defined-tools/problem-mapping.d.ts +39 -0
  79. package/dist/mcp/defined-tools/problem-mapping.d.ts.map +1 -0
  80. package/dist/mcp/defined-tools/problem-mapping.js +179 -0
  81. package/dist/mcp/defined-tools/problem-mapping.js.map +1 -0
  82. package/dist/mcp/defined-tools/request-split.d.ts +19 -0
  83. package/dist/mcp/defined-tools/request-split.d.ts.map +1 -0
  84. package/dist/mcp/defined-tools/request-split.js +25 -0
  85. package/dist/mcp/defined-tools/request-split.js.map +1 -0
  86. package/dist/mcp/defined-tools/tool-problem.d.ts +40 -0
  87. package/dist/mcp/defined-tools/tool-problem.d.ts.map +1 -0
  88. package/dist/mcp/defined-tools/tool-problem.js +42 -0
  89. package/dist/mcp/defined-tools/tool-problem.js.map +1 -0
  90. package/dist/mcp/defined-tools/tool-results.d.ts +12 -0
  91. package/dist/mcp/defined-tools/tool-results.d.ts.map +1 -0
  92. package/dist/mcp/defined-tools/tool-results.js +21 -0
  93. package/dist/mcp/defined-tools/tool-results.js.map +1 -0
  94. package/dist/mcp/local-tools/credential-minting.d.ts +24 -0
  95. package/dist/mcp/local-tools/credential-minting.d.ts.map +1 -0
  96. package/dist/mcp/local-tools/credential-minting.js +49 -0
  97. package/dist/mcp/local-tools/credential-minting.js.map +1 -0
  98. package/dist/mcp/local-tools/env-file.d.ts +30 -0
  99. package/dist/mcp/local-tools/env-file.d.ts.map +1 -0
  100. package/dist/mcp/local-tools/env-file.js +71 -0
  101. package/dist/mcp/local-tools/env-file.js.map +1 -0
  102. package/dist/mcp/local-tools/local-tools.d.ts +16 -0
  103. package/dist/mcp/local-tools/local-tools.d.ts.map +1 -0
  104. package/dist/mcp/local-tools/local-tools.js +16 -0
  105. package/dist/mcp/local-tools/local-tools.js.map +1 -0
  106. package/dist/mcp/local-tools/save-transmitter-credential.d.ts +21 -0
  107. package/dist/mcp/local-tools/save-transmitter-credential.d.ts.map +1 -0
  108. package/dist/mcp/local-tools/save-transmitter-credential.js +119 -0
  109. package/dist/mcp/local-tools/save-transmitter-credential.js.map +1 -0
  110. package/dist/mcp/mcp-call.d.ts +2 -2
  111. package/dist/mcp/mcp-call.d.ts.map +1 -1
  112. package/dist/mcp/mcp-call.js +8 -2
  113. package/dist/mcp/mcp-call.js.map +1 -1
  114. package/dist/mcp/mcp-command.d.ts +6 -2
  115. package/dist/mcp/mcp-command.d.ts.map +1 -1
  116. package/dist/mcp/mcp-command.js +36 -12
  117. package/dist/mcp/mcp-command.js.map +1 -1
  118. package/dist/mcp/mcp-install.d.ts +2 -0
  119. package/dist/mcp/mcp-install.d.ts.map +1 -1
  120. package/dist/mcp/mcp-install.js +7 -1
  121. package/dist/mcp/mcp-install.js.map +1 -1
  122. package/dist/mcp/mcp-protocol.d.ts +2 -0
  123. package/dist/mcp/mcp-protocol.d.ts.map +1 -1
  124. package/dist/mcp/mcp-protocol.js.map +1 -1
  125. package/dist/mcp/mcp-tools.d.ts +28 -25
  126. package/dist/mcp/mcp-tools.d.ts.map +1 -1
  127. package/dist/mcp/mcp-tools.js +39 -16
  128. package/dist/mcp/mcp-tools.js.map +1 -1
  129. package/dist/mcp/tool-binding.d.ts +35 -0
  130. package/dist/mcp/tool-binding.d.ts.map +1 -0
  131. package/dist/mcp/tool-binding.js +7 -0
  132. package/dist/mcp/tool-binding.js.map +1 -0
  133. package/dist/mcp/tool-bindings.d.ts +20 -0
  134. package/dist/mcp/tool-bindings.d.ts.map +1 -0
  135. package/dist/mcp/tool-bindings.js +31 -0
  136. package/dist/mcp/tool-bindings.js.map +1 -0
  137. package/dist/mcp/tool-filter.d.ts +26 -0
  138. package/dist/mcp/tool-filter.d.ts.map +1 -0
  139. package/dist/mcp/tool-filter.js +23 -0
  140. package/dist/mcp/tool-filter.js.map +1 -0
  141. package/dist/program.d.ts +9 -9
  142. package/dist/program.d.ts.map +1 -1
  143. package/dist/program.js +11 -65
  144. package/dist/program.js.map +1 -1
  145. package/dist/watch.d.ts +3 -3
  146. package/dist/watch.d.ts.map +1 -1
  147. package/dist/watch.js +10 -2
  148. package/dist/watch.js.map +1 -1
  149. package/package.json +6 -7
package/CHANGELOG.md CHANGED
@@ -10,6 +10,10 @@ says the server does not offer it yet and points at `ora login --api-key`; api k
10
10
 
11
11
  ### Added
12
12
 
13
+ - **`ora audit run <domain>`.** `ora audit run example.com --watch` audits a site with no JSON body.
14
+ `--domain example.com` works too. `--file` still works for the other fields (`mcpUrl`, `fresh`); a
15
+ domain given as an argument wins over one in the file. A second domain is refused rather than
16
+ dropped, and a missing one is named with an example.
13
17
  - **Browser sign-in.** `ora login` signs you in through your browser (the device flow, RFC 8628): it
14
18
  prints a link and a code, opens the browser when it can, and waits for your approval. A new person
15
19
  signs up on the same page. Approve only a sign-in you started yourself — the CLI says so with
@@ -34,9 +38,40 @@ says the server does not offer it yet and points at `ora login --api-key`; api k
34
38
  permissions. Everything else works with either.
35
39
  - `ora whoami` for a sign-in shows your organization and its name, your email, the permissions you
36
40
  granted, and `via: device sign-in`. `ora whoami --json` prints that identity as the API returns it.
41
+ - **Idempotency keys as a flag.** An operation that takes an idempotency key takes
42
+ `--idempotency-key <key>` (send the same key again to retry safely: the change never runs
43
+ twice). Nothing in the public API is versioned, so no command takes `--if-match`.
44
+ - Errors the API answers as RFC 9457 problems print their code and detail, one line per field
45
+ error, the next steps (with the command that takes each), whether to retry and after how long,
46
+ whether a change may have been applied, and the request id.
47
+ - `(beta)` marks beta operations in help.
48
+ - **`--help` explains the command** with the API's own description of it, below the one-line summary (what it
49
+ does, its rules and what it turns on by default), and names the field of an answer that holds a secret:
50
+ `ora front connection credentials create --help` says the key is the answer's `secret`, shown once.
51
+ - **`ora mcp serve` serves ora Front's own tools**, exactly as `https://app.ora.ai/mcp` serves them to
52
+ Claude and ChatGPT: the same names (`front_list_sites`, `front_connect_website`, …), descriptions,
53
+ input and output schemas and hints, read from the API's public document. Each answers its result
54
+ as structured content, and a failure answers the same problem as the app's server (code, whether
55
+ anything changed, whether retrying helps). A write sends a fresh idempotency key.
56
+ - **`front_save_transmitter_credential`**, a tool only `ora mcp serve` has: it creates a site's
57
+ transmitter key and writes it into an env file of the project (`ORA_INGEST_KEY`), never showing
58
+ it to the agent, and refuses a file outside the project.
59
+ - **`ora mcp serve --command <name>`** (repeatable) serves only the commands under it (`front`, or
60
+ `"front sites"`), with `--product` and `--read-only`; `ora mcp config` and `install` carry it.
61
+ `--command front` serves exactly ora Front's tools.
37
62
 
38
63
  ### Changed
39
64
 
65
+ - **A plan limit says what happened and points to billing.** With no allowance (a plan without it,
66
+ or a paused subscription) it reads "No Ora Score scans are available on your plan right now."; a
67
+ used-up limit reads "You've used all 10,000 Ora Score scans on your plan." (agent runs and Ora
68
+ Score scans add "ora usage shows when they reset."); a request bigger than what is left keeps
69
+ "Used 440 of 450.". All end with "Upgrade in Studio → Settings → Plan & billing.", or with
70
+ "Upgrade at <link>" when the refusal names the page (an ora Front 402's `upgradeUrl`).
71
+ - **`ora usage` needs the `usage:read` scope**, where it needed `intents:read`. Every api key that
72
+ held `intents:read` when this shipped was given `usage:read`, so it keeps working (for up to 15
73
+ minutes after the change it may still be refused, until its cached token renews); a new key needs
74
+ `usage:read` for `ora usage`. A browser sign-in made before this asks for it on the next `ora login`.
40
75
  - **`ora login` with no key now signs in through the browser**, where it used to ask you to paste
41
76
  one. Every way of giving it a key works as before: `ora login --api-key ora_sk_…`,
42
77
  `ORA_API_KEY`, and a key piped on stdin (`echo "$KEY" | ora login`). To paste a key at the
@@ -55,6 +90,22 @@ says the server does not offer it yet and points at `ora login --api-key`; api k
55
90
  - A command the API refuses for a missing permission tells a browser sign-in to run `ora login`
56
91
  again and allow that permission, naming it. An api key is told what it always was.
57
92
  - "No api key configured" is now "Not signed in. Run `ora login` (or set ORA_API_KEY for CI)."
93
+ - **Every command segment is kebab-case**: `ora study benchmark-definitions list`,
94
+ `ora study comparison-modes list`. The old spellings keep working for the 16 Study commands that
95
+ had them (`ora study benchmarkDefinitions list`), hidden from help. `ora mcp serve` names those
96
+ commands' tools the same way (`study_benchmark_definitions_list`).
97
+ - A query parameter the API requires is a required option: left out, the command stops before
98
+ sending anything (exit 2), where it used to get the API's 400 (`ora icps list` needs
99
+ `--domain-id`, `ora study series-trend` needs `--series`). Help describes each query parameter,
100
+ marks the required ones, and shows a date's or a uuid's shape: `--domain-id <uuid>`.
101
+ - With `--json`, an error the API sent no JSON for (the edge's plain-text 429, a 502 page) carries
102
+ its `status`, and `details.retryAfter` in seconds.
103
+ - A temporary failure of the key exchange (a 5xx) says to try again in a moment, never that the
104
+ credential no longer works.
105
+ - In `ora mcp serve`, ora Front's tools take the app's names and flat inputs (`front_list_sites`
106
+ where it was `front_sites_list` with a nested `body`), and an operation that answers a secret
107
+ (`ora front webhook-signing-key reveal`) is no longer a tool: a secret never enters an agent's
108
+ context. Its command is unchanged.
58
109
 
59
110
  ### Unchanged
60
111