@roarkanalytics/cli 0.73.1 → 0.74.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 (128) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +191 -148
  3. package/commands.js +2868 -944
  4. package/completions.js +4 -4
  5. package/man/roark-agent-build.1 +3 -3
  6. package/man/roark-agent-conversation-create.1 +106 -0
  7. package/man/roark-agent-create.1 +27 -3
  8. package/man/roark-agent-draft-update.1 +4 -1
  9. package/man/roark-agent-endpoint-create.1 +5 -5
  10. package/man/roark-agent-endpoint-get.1 +1 -1
  11. package/man/roark-agent-get.1 +1 -1
  12. package/man/roark-autoimprove-job-cancel.1 +1 -1
  13. package/man/roark-autoimprove-job-dismiss.1 +1 -1
  14. package/man/roark-autoimprove-job-guidance-send.1 +1 -1
  15. package/man/roark-autoimprove-job-promote.1 +1 -1
  16. package/man/roark-benchmark-target-history-list.1 +1 -1
  17. package/man/roark-call-get.1 +1 -1
  18. package/man/roark-connections-agent-backfill-cancel.1 +96 -0
  19. package/man/roark-connections-agent-backfill-create.1 +97 -0
  20. package/man/roark-connections-agent-backfill-list.1 +93 -0
  21. package/man/roark-connections-agent-create.1 +124 -0
  22. package/man/roark-connections-agent-delete.1 +93 -0
  23. package/man/roark-connections-agent-discover.1 +96 -0
  24. package/man/roark-connections-agent-get.1 +93 -0
  25. package/man/roark-connections-agent-list.1 +93 -0
  26. package/man/roark-connections-agent-provider-list.1 +89 -0
  27. package/man/roark-connections-agent-update.1 +128 -0
  28. package/man/roark-connections-calendar-calendar-list.1 +93 -0
  29. package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
  30. package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
  31. package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
  32. package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
  33. package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
  34. package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
  35. package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
  36. package/man/roark-connections-calendar-target-create.1 +124 -0
  37. package/man/roark-connections-calendar-target-delete.1 +96 -0
  38. package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
  39. package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
  40. package/man/roark-connections-calendar-target-update.1 +124 -0
  41. package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
  42. package/man/roark-connections-mcp-server-create.1 +105 -0
  43. package/man/roark-connections-mcp-server-delete.1 +93 -0
  44. package/man/roark-connections-mcp-server-discover.1 +99 -0
  45. package/man/roark-connections-mcp-server-get.1 +93 -0
  46. package/man/roark-connections-mcp-server-list.1 +89 -0
  47. package/man/roark-connections-mcp-server-refresh.1 +93 -0
  48. package/man/roark-connections-mcp-server-update.1 +100 -0
  49. package/man/roark-conversation-get.1 +93 -0
  50. package/man/roark-credential-create.1 +2 -2
  51. package/man/roark-credential-list.1 +2 -2
  52. package/man/roark-credential-revoke.1 +2 -2
  53. package/man/{roark-customer-profile-attribute-delete.1 → roark-customer-attribute-delete.1} +5 -5
  54. package/man/{roark-customer-profile-attribute-unlock.1 → roark-customer-attribute-unlock.1} +5 -5
  55. package/man/{roark-customer-profile-attribute-update.1 → roark-customer-attribute-update.1} +5 -5
  56. package/man/{roark-customer-profile-conversation-list.1 → roark-customer-conversation-list.1} +5 -5
  57. package/man/{roark-customer-profile-delete.1 → roark-customer-delete.1} +6 -6
  58. package/man/roark-customer-field-create.1 +105 -0
  59. package/man/roark-customer-field-delete.1 +93 -0
  60. package/man/roark-customer-field-list.1 +89 -0
  61. package/man/roark-customer-field-update.1 +106 -0
  62. package/man/roark-customer-flow-edge-case-create.1 +1 -1
  63. package/man/roark-customer-flow-edge-case-update.1 +1 -1
  64. package/man/roark-customer-flow-folder-create.1 +99 -0
  65. package/man/roark-customer-flow-folder-delete.1 +93 -0
  66. package/man/roark-customer-flow-folder-list.1 +89 -0
  67. package/man/roark-customer-flow-get.1 +1 -1
  68. package/man/roark-customer-flow-happy-path-update.1 +1 -1
  69. package/man/roark-customer-flow-list.1 +3 -0
  70. package/man/roark-customer-flow-update.1 +4 -1
  71. package/man/{roark-customer-profile-get.1 → roark-customer-get.1} +6 -6
  72. package/man/{roark-customer-profile-list.1 → roark-customer-list.1} +8 -8
  73. package/man/{roark-customer-profile-notes-update.1 → roark-customer-notes-update.1} +5 -5
  74. package/man/roark-dashboard-list.1 +1 -1
  75. package/man/roark-dashboard-update.1 +1 -1
  76. package/man/roark-http-request-definition-create.1 +1 -1
  77. package/man/roark-http-request-definition-get.1 +1 -1
  78. package/man/roark-http-request-definition-update.1 +1 -1
  79. package/man/roark-metric-collection-job-get.1 +1 -1
  80. package/man/roark-metric-definition-create.1 +1 -1
  81. package/man/roark-metric-definition-update.1 +1 -1
  82. package/man/roark-metric-policy-create.1 +1 -1
  83. package/man/roark-metric-policy-get.1 +1 -1
  84. package/man/roark-metric-variant-list.1 +1 -1
  85. package/man/roark-metric-variant-update.1 +1 -1
  86. package/man/roark-project-list.1 +1 -1
  87. package/man/roark-simulation-environment-create.1 +12 -0
  88. package/man/roark-simulation-environment-get.1 +1 -1
  89. package/man/roark-simulation-environment-update.1 +12 -0
  90. package/man/roark-simulation-group-create.1 +2 -2
  91. package/man/roark-simulation-group-delete.1 +1 -1
  92. package/man/roark-simulation-group-get.1 +1 -1
  93. package/man/roark-simulation-group-list.1 +1 -1
  94. package/man/roark-simulation-group-run.1 +2 -2
  95. package/man/roark-simulation-group-update.1 +1 -1
  96. package/man/roark-simulation-job-get.1 +1 -1
  97. package/man/roark-simulation-job-lookup.1 +1 -1
  98. package/man/roark-simulation-persona-create.1 +1 -1
  99. package/man/roark-simulation-persona-get.1 +1 -1
  100. package/man/roark-simulation-persona-update.1 +1 -1
  101. package/man/roark-simulation-plan-get.1 +1 -1
  102. package/man/roark-simulation-plan-job-cancel.1 +1 -1
  103. package/man/roark-simulation-plan-job-cost-get.1 +1 -1
  104. package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
  105. package/man/roark-simulation-plan-job-delete.1 +1 -1
  106. package/man/roark-simulation-plan-job-get.1 +1 -1
  107. package/man/roark-simulation-plan-job-list.1 +1 -1
  108. package/man/roark-simulation-plan-job-result-get.1 +1 -1
  109. package/man/roark-simulation-plan-update.1 +7 -1
  110. package/man/roark-simulation-resource-generate.1 +120 -0
  111. package/man/roark-simulation-resource-generation-answer.1 +97 -0
  112. package/man/roark-simulation-resource-generation-cancel.1 +93 -0
  113. package/man/roark-simulation-resource-generation-get.1 +93 -0
  114. package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
  115. package/man/roark-simulation-resource-generation-list.1 +96 -0
  116. package/man/roark-simulation-run-group-list.1 +1 -1
  117. package/man/roark-tool-create.1 +32 -2
  118. package/man/roark-tool-update.1 +32 -2
  119. package/man/roark-usage-get.1 +1 -1
  120. package/man/roark-webhook-create.1 +2 -2
  121. package/man/roark-webhook-delete.1 +1 -1
  122. package/man/roark-webhook-get.1 +1 -1
  123. package/man/roark-whoami.1 +1 -1
  124. package/man/roark.1 +208 -94
  125. package/npm-shrinkwrap.json +6 -6
  126. package/package.json +56 -18
  127. package/version.d.ts +1 -1
  128. package/version.js +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.74.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.73.1...v0.74.0) (2026-11-18)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * **cli:** removes or renames command groups and commands. Scripts using the old names will fail.
9
+
10
+ ### Features
11
+
12
+ * **cli:** cli update ([#194](https://github.com/roarkhq/cli-roark-analytics/issues/194)) ([1bd77a3](https://github.com/roarkhq/cli-roark-analytics/commit/1bd77a346214b46dd138da7d4e49728422d2617c))
13
+
3
14
  ## [0.73.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.73.0...v0.73.1) (2026-11-08)
4
15
 
5
16
 
package/README.md CHANGED
@@ -130,28 +130,29 @@ roark completion fish | source
130
130
 
131
131
  ### agent
132
132
 
133
- | Command | Description |
134
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- |
135
- | `roark agent build --name <value> --job-description <value> --tts.provider <value> --tts.voice-id <value> --stt.provider <value> --stt.model <value> --llm.provider <value> --llm.model <value>` | Build a Roark-hosted agent |
136
- | `roark agent create --name <value>` | Create a new agent |
137
- | `roark agent draft create <agent-id>` | Start a draft |
138
- | `roark agent draft delete <agent-id>` | Discard the draft |
139
- | `roark agent draft get <agent-id>` | Get an agent's draft |
140
- | `roark agent draft publish <agent-id> --expected-revision <value>` | Publish the draft |
141
- | `roark agent draft update <agent-id> --settings <value>` | Edit the draft |
142
- | `roark agent endpoint create --agent-id <value> --direction <value>` | Create a new agent endpoint |
143
- | `roark agent endpoint get <endpoint-id>` | Get agent endpoint by ID |
144
- | `roark agent endpoint list` | List agent endpoints |
145
- | `roark agent endpoint update <endpoint-id>` | Update an agent endpoint |
146
- | `roark agent get <agent-id>` | Get agent by ID |
147
- | `roark agent list` | List agents |
148
- | `roark agent prompt list <agent-id>` | List an agent's prompts |
149
- | `roark agent prompt update <agent-id> --prompt <value>` | Set an agent's prompt |
150
- | `roark agent prompt version list <agent-id> <prompt-id>` | List a prompt's versions |
151
- | `roark agent update <agent-id>` | Update an agent |
152
- | `roark agent version get <agent-id> <version-id>` | Get an agent version |
153
- | `roark agent version list <agent-id>` | List an agent's versions |
154
- | `roark agent version rollback <agent-id> <version-id>` | Roll an agent back to a version |
133
+ | Command | Description |
134
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- |
135
+ | `roark agent build --name <value> --job-description <value> --tts.provider <value> --tts.voice-id <value> --stt.provider <value> --stt.model <value> --llm.provider <value> --llm.model <value>` | Build a Roark-hosted agent |
136
+ | `roark agent conversation create <agent-id> --modality <value> --channel <value> --allowed-origins <value>` | Start a conversation with an agent |
137
+ | `roark agent create --name <value> --endpoint.direction <value>` | Create an agent |
138
+ | `roark agent draft create <agent-id>` | Start a draft |
139
+ | `roark agent draft delete <agent-id>` | Discard the draft |
140
+ | `roark agent draft get <agent-id>` | Get an agent's draft |
141
+ | `roark agent draft publish <agent-id> --expected-revision <value>` | Publish the draft |
142
+ | `roark agent draft update <agent-id> --settings <value>` | Edit the draft |
143
+ | `roark agent endpoint create --direction <value> --agent-id <value>` | Create an agent endpoint |
144
+ | `roark agent endpoint get <endpoint-id>` | Get an agent endpoint |
145
+ | `roark agent endpoint list` | List agent endpoints |
146
+ | `roark agent endpoint update <endpoint-id>` | Update an agent endpoint |
147
+ | `roark agent get <agent-id>` | Get an agent |
148
+ | `roark agent list` | List agents |
149
+ | `roark agent prompt list <agent-id>` | List an agent's prompts |
150
+ | `roark agent prompt update <agent-id> --prompt <value>` | Set an agent's prompt |
151
+ | `roark agent prompt version list <agent-id> <prompt-id>` | List a prompt's versions |
152
+ | `roark agent update <agent-id>` | Update an agent |
153
+ | `roark agent version get <agent-id> <version-id>` | Get an agent version |
154
+ | `roark agent version list <agent-id>` | List an agent's versions |
155
+ | `roark agent version rollback <agent-id> <version-id>` | Roll an agent back to a version |
155
156
 
156
157
  ### agent-config
157
158
 
@@ -173,40 +174,27 @@ roark completion fish | source
173
174
 
174
175
  ### autoimprove
175
176
 
176
- | Command | Description |
177
- | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
178
- | `roark autoimprove job answer <job-id> --text <value>` | Answer Roark's question |
179
- | `roark autoimprove job cancel <job-id>` | Cancel a job |
180
- | `roark autoimprove job create --agent-id <value> --objective-metric-definition-id <value> --objective-label <value>` | Start an Autoimprove job |
181
- | `roark autoimprove job dismiss <job-id>` | Dismiss a verified job |
182
- | `roark autoimprove job get <job-id>` | Get an Autoimprove job |
183
- | `roark autoimprove job guidance send <job-id> --text <value>` | Send guidance to a running job |
184
- | `roark autoimprove job list` | List Autoimprove jobs |
185
- | `roark autoimprove job promote <job-id>` | Promote a verified job to production |
177
+ | Command | Description |
178
+ | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
179
+ | `roark autoimprove job answer <job-id> --text <value>` | Answer Roark's question |
180
+ | `roark autoimprove job cancel <job-id>` | Cancel an Autoimprove job |
181
+ | `roark autoimprove job create --agent-id <value> --objective-metric-definition-id <value> --objective-label <value>` | Start an Autoimprove job |
182
+ | `roark autoimprove job dismiss <job-id>` | Dismiss an Autoimprove job |
183
+ | `roark autoimprove job get <job-id>` | Get an Autoimprove job |
184
+ | `roark autoimprove job guidance send <job-id> --text <value>` | Guide a running Autoimprove job |
185
+ | `roark autoimprove job list` | List Autoimprove jobs |
186
+ | `roark autoimprove job promote <job-id>` | Promote an Autoimprove job to production |
186
187
 
187
188
  ### benchmark
188
189
 
189
- | Command | Description |
190
- | ----------------------------------------------------------------------- | ------------------------------------- |
191
- | `roark benchmark leaderboard get --suite <value>` | Get the benchmark leaderboard |
192
- | `roark benchmark metric list --suite <value>` | List benchmark metrics |
193
- | `roark benchmark suite list` | List benchmark suites |
194
- | `roark benchmark target get <target-key> --suite <value>` | Get a benchmark target |
195
- | `roark benchmark target history list <target-key> --suite <value>` | List a target’s published generations |
196
- | `roark benchmark target score-sample list <target-key> --suite <value>` | List score samples for a target |
197
-
198
- ### calendar-connection
199
-
200
- | Command | Description |
201
- | --------------------------------------------------------------------------------------- | ------------------------------------- |
202
- | `roark calendar-connection check <connection-id>` | Check a calendar connection |
203
- | `roark calendar-connection create --provider <value> --label <value> --api-key <value>` | Connect a calendar account |
204
- | `roark calendar-connection delete <connection-id>` | Delete a calendar connection |
205
- | `roark calendar-connection get <connection-id>` | Get a calendar connection |
206
- | `roark calendar-connection list` | List calendar connections |
207
- | `roark calendar-connection target get <connection-id> <target-id>` | Read one bookable target |
208
- | `roark calendar-connection target list <connection-id>` | List what can be booked on a calendar |
209
- | `roark calendar-connection update <connection-id>` | Update a calendar connection |
190
+ | Command | Description |
191
+ | ----------------------------------------------------------------------- | ----------------------------------------------- |
192
+ | `roark benchmark leaderboard get --suite <value>` | Get the benchmark leaderboard |
193
+ | `roark benchmark metric list --suite <value>` | List benchmark metrics |
194
+ | `roark benchmark suite list` | List benchmark suites |
195
+ | `roark benchmark target get <target-key> --suite <value>` | Get a benchmark target |
196
+ | `roark benchmark target history list <target-key> --suite <value>` | List a benchmark target's published generations |
197
+ | `roark benchmark target score-sample list <target-key> --suite <value>` | List score samples for a target |
210
198
 
211
199
  ### call
212
200
 
@@ -216,7 +204,7 @@ roark completion fish | source
216
204
  | `roark call cost get <call-id>` | Get call cost |
217
205
  | `roark call create --recording-url <value> --started-at <value> --interface-type <value> --call-direction <value> --customer.phone-number-e164 <value>` | Create a call |
218
206
  | `roark call delete <call-id>` | Delete a call |
219
- | `roark call get <call-id>` | Get a call by ID |
207
+ | `roark call get <call-id>` | Get a call |
220
208
  | `roark call list` | List calls |
221
209
  | `roark call metric list <call-id>` | List call metrics |
222
210
  | `roark call property update <call-id> --properties <value>` | Update the properties of a call |
@@ -231,13 +219,72 @@ roark completion fish | source
231
219
  | `roark config apply [dir]` | Reconcile the project to a config directory (or bundle). Previews and confirms first. |
232
220
  | `roark config diff [dir]` | Preview the changes a config directory (or bundle) would make. No writes. |
233
221
 
222
+ ### connections
223
+
224
+ | Command | Description |
225
+ | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
226
+ | `roark connections agent backfill cancel <connection-id> <backfill-id>` | Cancel a backfill |
227
+ | `roark connections agent backfill create <connection-id> --max-calls <value>` | Import past calls |
228
+ | `roark connections agent backfill list <connection-id>` | List backfills |
229
+ | `roark connections agent create --data '{ ... }'` | Connect an agent |
230
+ | `roark connections agent delete <connection-id>` | Disconnect an agent connection |
231
+ | `roark connections agent discover --provider <value> --api-key <value>` | Discover agents with a platform API key |
232
+ | `roark connections agent get <connection-id>` | Get an agent connection |
233
+ | `roark connections agent list` | List agent connections |
234
+ | `roark connections agent provider list` | List agent connection providers |
235
+ | `roark connections agent update <connection-id> --data '{ ... }'` | Update an agent connection |
236
+ | `roark connections calendar calendar list <connection-id>` | List calendars for bookable targets |
237
+ | `roark connections calendar calendly-oauth start` | Start connecting a Calendly account |
238
+ | `roark connections calendar check <connection-id>` | Check a calendar connection |
239
+ | `roark connections calendar create --provider <value> --label <value> --api-key <value>` | Connect a calendar account |
240
+ | `roark connections calendar delete <connection-id>` | Delete a calendar connection |
241
+ | `roark connections calendar get <connection-id>` | Get a calendar connection |
242
+ | `roark connections calendar google-oauth start` | Start connecting a Google Calendar |
243
+ | `roark connections calendar list` | List calendar connections |
244
+ | `roark connections calendar target create <connection-id> --name <value> --calendar-id <value> --duration-minutes <value>` | Create a bookable target |
245
+ | `roark connections calendar target delete <connection-id> <target-id>` | Delete a bookable target |
246
+ | `roark connections calendar target get <connection-id> <target-id>` | Get a bookable target |
247
+ | `roark connections calendar target list <connection-id>` | List bookable targets |
248
+ | `roark connections calendar target update <connection-id> <target-id>` | Update a bookable target |
249
+ | `roark connections calendar update <connection-id>` | Update a calendar connection |
250
+ | `roark connections mcp-server create --url <value> --label <value>` | Connect an MCP server |
251
+ | `roark connections mcp-server delete <server-id>` | Disconnect an MCP server |
252
+ | `roark connections mcp-server discover --url <value>` | Discover an MCP server |
253
+ | `roark connections mcp-server get <server-id>` | Get an MCP server |
254
+ | `roark connections mcp-server list` | List MCP servers |
255
+ | `roark connections mcp-server refresh <server-id>` | Refresh an MCP server |
256
+ | `roark connections mcp-server update <server-id>` | Update an MCP server |
257
+
258
+ ### conversation
259
+
260
+ | Command | Description |
261
+ | ------------------------------------------ | ------------------ |
262
+ | `roark conversation get <conversation-id>` | Get a conversation |
263
+
234
264
  ### credential
235
265
 
236
- | Command | Description |
237
- | ----------------------------------------- | --------------------------------------- |
238
- | `roark credential create --name <value>` | Create a personal credential |
239
- | `roark credential list` | List your personal credentials |
240
- | `roark credential revoke <credential-id>` | Revoke one of your personal credentials |
266
+ | Command | Description |
267
+ | ----------------------------------------- | ------------------------- |
268
+ | `roark credential create --name <value>` | Create a personal API key |
269
+ | `roark credential list` | List personal API keys |
270
+ | `roark credential revoke <credential-id>` | Revoke a personal API key |
271
+
272
+ ### customer
273
+
274
+ | Command | Description |
275
+ | -------------------------------------------------------------------------------------------------- | ------------------------------- |
276
+ | `roark customer attribute delete <customer-profile-id> <key>` | Clear a field on a customer |
277
+ | `roark customer attribute unlock <customer-profile-id> <key>` | Unlock a field on a customer |
278
+ | `roark customer attribute update <customer-profile-id> <key> --value <value>` | Set a field on a customer |
279
+ | `roark customer conversation list <customer-profile-id>` | List a customer's conversations |
280
+ | `roark customer delete <customer-profile-id>` | Erase a customer |
281
+ | `roark customer field create --key <value> --label <value> --value-type <value> --extract <value>` | Create a customer field |
282
+ | `roark customer field delete <key>` | Delete a customer field |
283
+ | `roark customer field list` | List customer fields |
284
+ | `roark customer field update <key>` | Update a customer field |
285
+ | `roark customer get <customer-profile-id>` | Get a customer |
286
+ | `roark customer list` | List customers |
287
+ | `roark customer notes update <customer-profile-id> --notes <value>` | Update the notes on a customer |
241
288
 
242
289
  ### customer-flow
243
290
 
@@ -250,25 +297,15 @@ roark completion fish | source
250
297
  | `roark customer-flow edge-case delete <flow-id> <edge-case-id>` | Remove an edge case |
251
298
  | `roark customer-flow edge-case promote <flow-id> <edge-case-id>` | Promote an edge case to the happy path |
252
299
  | `roark customer-flow edge-case update <flow-id> <edge-case-id>` | Update an edge case |
253
- | `roark customer-flow get <flow-id>` | Get customer flow by ID |
300
+ | `roark customer-flow folder create --name <value>` | Create a customer flow folder |
301
+ | `roark customer-flow folder delete <folder-id>` | Delete a customer flow folder |
302
+ | `roark customer-flow folder list` | List customer flow folders |
303
+ | `roark customer-flow get <flow-id>` | Get a customer flow |
254
304
  | `roark customer-flow graph replace <flow-id> --graph <value>` | Replace a scripted flow's steps |
255
305
  | `roark customer-flow happy-path update <flow-id>` | Update a flow's happy path |
256
306
  | `roark customer-flow list` | List customer flows |
257
307
  | `roark customer-flow update <flow-id> --off-script-policy.reaction <value> --off-script-policy.max-attempts <value> --off-script-policy.then <value>` | Update a customer flow |
258
308
 
259
- ### customer-profile
260
-
261
- | Command | Description |
262
- | ------------------------------------------------------------------------------------- | -------------------------------------- |
263
- | `roark customer-profile attribute delete <customer-profile-id> <key>` | Clear a customer profile field |
264
- | `roark customer-profile attribute unlock <customer-profile-id> <key>` | Unlock a customer profile field |
265
- | `roark customer-profile attribute update <customer-profile-id> <key> --value <value>` | Set a customer profile field |
266
- | `roark customer-profile conversation list <customer-profile-id>` | List a customer's conversations |
267
- | `roark customer-profile delete <customer-profile-id>` | Erase a customer profile |
268
- | `roark customer-profile get <customer-profile-id>` | Get a customer profile |
269
- | `roark customer-profile list` | List customer profiles |
270
- | `roark customer-profile notes update <customer-profile-id> --notes <value>` | Update the notes on a customer profile |
271
-
272
309
  ### dashboard
273
310
 
274
311
  | Command | Description |
@@ -294,10 +331,10 @@ roark completion fish | source
294
331
 
295
332
  | Command | Description |
296
333
  | -------------------------------------------------------------------- | --------------------------------- |
297
- | `roark http-request-definition create --scope <value> --url <value>` | Create HTTP request definition |
298
- | `roark http-request-definition get <definition-id>` | Get HTTP request definition by ID |
334
+ | `roark http-request-definition create --scope <value> --url <value>` | Create an HTTP request definition |
335
+ | `roark http-request-definition get <definition-id>` | Get an HTTP request definition |
299
336
  | `roark http-request-definition list` | List HTTP request definitions |
300
- | `roark http-request-definition update <definition-id>` | Update HTTP request definition |
337
+ | `roark http-request-definition update <definition-id>` | Update an HTTP request definition |
301
338
 
302
339
  ### live-report
303
340
 
@@ -318,20 +355,20 @@ roark completion fish | source
318
355
  | -------------------------------------------------------------------------------- | -------------------------------------- |
319
356
  | `roark metric collection-job cancel <job-id>` | Cancel a metric collection job |
320
357
  | `roark metric collection-job create` | Create and run a metric collection job |
321
- | `roark metric collection-job get <job-id>` | Get metric collection job by ID |
358
+ | `roark metric collection-job get <job-id>` | Get a metric collection job |
322
359
  | `roark metric collection-job list` | List metric collection jobs |
323
- | `roark metric definition create --data '{ ... }'` | Create custom metric definition |
360
+ | `roark metric definition create --data '{ ... }'` | Create a metric definition |
324
361
  | `roark metric definition list` | List metric definitions |
325
362
  | `roark metric definition update <id-or-slug> --http-request.url <value>` | Update a metric definition |
326
363
  | `roark metric policy create --name <value> --modality <value> --metrics <value>` | Create a metric policy |
327
364
  | `roark metric policy delete <policy-id>` | Delete a metric policy |
328
- | `roark metric policy get <policy-id>` | Get metric policy by ID |
365
+ | `roark metric policy get <policy-id>` | Get a metric policy |
329
366
  | `roark metric policy list` | List metric policies |
330
367
  | `roark metric policy update <policy-id>` | Update a metric policy |
331
368
  | `roark metric variant create <id-or-slug> --name <value>` | Create a metric variant |
332
369
  | `roark metric variant delete <id-or-slug> <variant-id>` | Delete a metric variant |
333
370
  | `roark metric variant get <id-or-slug> <variant-id>` | Get a metric variant |
334
- | `roark metric variant list <id-or-slug>` | List a metric’s variants |
371
+ | `roark metric variant list <id-or-slug>` | List a metric's variants |
335
372
  | `roark metric variant update <id-or-slug> <variant-id>` | Update a metric variant |
336
373
 
337
374
  ### phone-number
@@ -347,89 +384,95 @@ roark completion fish | source
347
384
 
348
385
  ### project
349
386
 
350
- | Command | Description |
351
- | -------------------- | ------------------------------------------ |
352
- | `roark project list` | List projects available to this credential |
387
+ | Command | Description |
388
+ | -------------------- | ------------------------ |
389
+ | `roark project list` | List accessible projects |
353
390
 
354
391
  ### simulation
355
392
 
356
- | Command | Description |
357
- | ----------------------------------------------------------------------------------------------------- | ----------------------------------- |
358
- | `roark simulation audio-clip list` | List audio clips |
359
- | `roark simulation environment create --name <value> --background-noise <value>` | Create an environment |
360
- | `roark simulation environment delete <environment-id>` | Delete an environment |
361
- | `roark simulation environment get <environment-id>` | Get environment by ID |
362
- | `roark simulation environment list` | List environments |
363
- | `roark simulation environment update <environment-id>` | Update an environment |
364
- | `roark simulation group create --name <value> --simulation-run-plan-ids <value>` | Create a simulation group |
365
- | `roark simulation group delete <group-id>` | Delete a simulation group |
366
- | `roark simulation group get <group-id>` | Get a simulation group |
367
- | `roark simulation group list` | List simulation groups |
368
- | `roark simulation group run <group-id>` | Run a simulation group |
369
- | `roark simulation group update <group-id>` | Update a simulation group |
370
- | `roark simulation job get <job-id>` | Get simulation by ID |
371
- | `roark simulation job lookup --roark-phone-number <value>` | Lookup by phone number |
372
- | `roark simulation job tool-mock list <job-id>` | List mocked tool invocations |
373
- | `roark simulation persona create --name <value> --language <value> --accent <value> --gender <value>` | Create a new persona |
374
- | `roark simulation persona get <persona-id>` | Get persona by ID |
375
- | `roark simulation persona list` | List personas |
376
- | `roark simulation persona update <persona-id>` | Update a persona |
377
- | `roark simulation plan create --data '{ ... }'` | Create a run plan |
378
- | `roark simulation plan delete <plan-id>` | Delete a run plan |
379
- | `roark simulation plan get <plan-id>` | Get run plan by ID |
380
- | `roark simulation plan job cancel <job-id>` | Cancel a simulation plan job |
381
- | `roark simulation plan job cost get <job-id>` | Get simulation run cost |
382
- | `roark simulation plan job debrief create <job-id>` | Generate simulation run debrief |
383
- | `roark simulation plan job delete <job-id>` | Delete a simulation plan job |
384
- | `roark simulation plan job get <job-id>` | Get simulation plan job |
385
- | `roark simulation plan job list` | List simulation plan jobs |
386
- | `roark simulation plan job result get <job-id>` | Get simulation run results |
387
- | `roark simulation plan job start <plan-id>` | Run a simulation plan |
388
- | `roark simulation plan list` | List run plans |
389
- | `roark simulation plan update <plan-id>` | Update a run plan |
390
- | `roark simulation run --data '{ ... }'` | Run a simulation |
391
- | `roark simulation run-group create` | Create a run group |
392
- | `roark simulation run-group delete <group-id>` | Delete a run group |
393
- | `roark simulation run-group get <group-id>` | Get a run group |
394
- | `roark simulation run-group list` | List run groups |
395
- | `roark simulation run-group report regenerate <group-id>` | Regenerate a run group report |
396
- | `roark simulation template list` | List simulation templates |
397
- | `roark simulation tool mock --simulation-job-id <value> --tool-name <value>` | Mock a tool call during a test call |
398
- | `roark simulation tool-fixture create --tool-name <value>` | Set a tool fixture |
399
- | `roark simulation tool-fixture delete <fixture-id>` | Delete a tool fixture |
400
- | `roark simulation tool-fixture list` | List tool fixtures |
401
- | `roark simulation tool-fixture update <fixture-id>` | Update a tool fixture |
393
+ | Command | Description |
394
+ | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
395
+ | `roark simulation audio-clip list` | List audio clips |
396
+ | `roark simulation environment create --name <value> --background-noise <value>` | Create an environment |
397
+ | `roark simulation environment delete <environment-id>` | Delete an environment |
398
+ | `roark simulation environment get <environment-id>` | Get an environment |
399
+ | `roark simulation environment list` | List environments |
400
+ | `roark simulation environment update <environment-id>` | Update an environment |
401
+ | `roark simulation group create --name <value> --simulation-run-plan-ids <value>` | Create a plan group |
402
+ | `roark simulation group delete <group-id>` | Delete a plan group |
403
+ | `roark simulation group get <group-id>` | Get a plan group |
404
+ | `roark simulation group list` | List plan groups |
405
+ | `roark simulation group run <group-id>` | Run a plan group |
406
+ | `roark simulation group update <group-id>` | Update a plan group |
407
+ | `roark simulation job get <job-id>` | Get a simulated call |
408
+ | `roark simulation job lookup --roark-phone-number <value>` | Find a simulated call by phone number |
409
+ | `roark simulation job tool-mock list <job-id>` | List mocked tool invocations |
410
+ | `roark simulation persona create --name <value> --language <value> --accent <value> --gender <value>` | Create a persona |
411
+ | `roark simulation persona get <persona-id>` | Get a persona |
412
+ | `roark simulation persona list` | List personas |
413
+ | `roark simulation persona update <persona-id>` | Update a persona |
414
+ | `roark simulation plan create --data '{ ... }'` | Create a run plan |
415
+ | `roark simulation plan delete <plan-id>` | Delete a run plan |
416
+ | `roark simulation plan get <plan-id>` | Get a run plan |
417
+ | `roark simulation plan job cancel <job-id>` | Cancel a simulation run |
418
+ | `roark simulation plan job cost get <job-id>` | Get a simulation run's cost |
419
+ | `roark simulation plan job debrief create <job-id>` | Generate a simulation run debrief |
420
+ | `roark simulation plan job delete <job-id>` | Delete a simulation run |
421
+ | `roark simulation plan job get <job-id>` | Get a simulation run |
422
+ | `roark simulation plan job list` | List simulation runs |
423
+ | `roark simulation plan job result get <job-id>` | Get a simulation run's results |
424
+ | `roark simulation plan job start <plan-id>` | Run a simulation plan |
425
+ | `roark simulation plan list` | List run plans |
426
+ | `roark simulation plan update <plan-id>` | Update a run plan |
427
+ | `roark simulation resource generate --agent-ids <value>` | Generate simulation resources |
428
+ | `roark simulation resource-generation answer <generation-id> --text <value>` | Answer a simulation resource generation's question |
429
+ | `roark simulation resource-generation cancel <generation-id>` | Cancel a running simulation resource generation |
430
+ | `roark simulation resource-generation get <generation-id>` | Get a simulation resource generation |
431
+ | `roark simulation resource-generation guidance send <generation-id> --text <value>` | Guide a running simulation resource generation |
432
+ | `roark simulation resource-generation list` | List simulation resource generations |
433
+ | `roark simulation run --data '{ ... }'` | Run a simulation |
434
+ | `roark simulation run-group create` | Create a run group |
435
+ | `roark simulation run-group delete <group-id>` | Delete a run group |
436
+ | `roark simulation run-group get <group-id>` | Get a run group |
437
+ | `roark simulation run-group list` | List run groups |
438
+ | `roark simulation run-group report regenerate <group-id>` | Regenerate a run group report |
439
+ | `roark simulation template list` | List simulation templates |
440
+ | `roark simulation tool mock --simulation-job-id <value> --tool-name <value>` | Mock a tool call during a test call |
441
+ | `roark simulation tool-fixture create --tool-name <value>` | Set a tool fixture |
442
+ | `roark simulation tool-fixture delete <fixture-id>` | Delete a tool fixture |
443
+ | `roark simulation tool-fixture list` | List tool fixtures |
444
+ | `roark simulation tool-fixture update <fixture-id>` | Update a tool fixture |
402
445
 
403
446
  ### tool
404
447
 
405
- | Command | Description |
406
- | -------------------------------------------------------------------------------------------- | ------------- |
407
- | `roark tool create --name <value> --description <value> --runtime.request <value>` | Create a tool |
408
- | `roark tool delete <tool-id>` | Delete a tool |
409
- | `roark tool get <tool-id>` | Get a tool |
410
- | `roark tool list` | List tools |
411
- | `roark tool update <tool-id> --name <value> --description <value> --runtime.request <value>` | Update a tool |
448
+ | Command | Description |
449
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
450
+ | `roark tool create --name <value> --description <value> --runtime.request <value> --calendar.calendar-connection-id <value> --calendar.operation <value> --calendar.appointment-types <value> --mcp.mcp-server-id <value> --mcp.tool <value>` | Create a tool |
451
+ | `roark tool delete <tool-id>` | Delete a tool |
452
+ | `roark tool get <tool-id>` | Get a tool |
453
+ | `roark tool list` | List tools |
454
+ | `roark tool update <tool-id> --name <value> --description <value> --runtime.request <value> --calendar.calendar-connection-id <value> --calendar.operation <value> --calendar.appointment-types <value> --mcp.mcp-server-id <value> --mcp.tool <value>` | Update a tool |
412
455
 
413
456
  ### usage
414
457
 
415
- | Command | Description |
416
- | --------------------------------------------- | ---------------- |
417
- | `roark usage get --from <value> --to <value>` | Get usage & cost |
458
+ | Command | Description |
459
+ | --------------------------------------------- | ------------------ |
460
+ | `roark usage get --from <value> --to <value>` | Get usage and cost |
418
461
 
419
462
  ### webhook
420
463
 
421
- | Command | Description |
422
- | ----------------------------------------------------- | ----------------- |
423
- | `roark webhook create --url <value> --events <value>` | Create webhook |
424
- | `roark webhook delete <webhook-id>` | Delete webhook |
425
- | `roark webhook get <webhook-id>` | Get webhook by ID |
426
- | `roark webhook list` | List webhooks |
464
+ | Command | Description |
465
+ | ----------------------------------------------------- | ---------------- |
466
+ | `roark webhook create --url <value> --events <value>` | Create a webhook |
467
+ | `roark webhook delete <webhook-id>` | Delete a webhook |
468
+ | `roark webhook get <webhook-id>` | Get a webhook |
469
+ | `roark webhook list` | List webhooks |
427
470
 
428
471
  ### whoami
429
472
 
430
- | Command | Description |
431
- | -------------- | ------------------------------- |
432
- | `roark whoami` | Describe the current credential |
473
+ | Command | Description |
474
+ | -------------- | -------------------------- |
475
+ | `roark whoami` | Get the current credential |
433
476
 
434
477
  ## Requirements
435
478