@roarkanalytics/cli 0.56.1 → 0.58.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/CHANGELOG.md +14 -0
- package/README.md +15 -15
- package/commands.js +110 -8
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +11 -2
- package/man/roark-phone-number-available-list.1 +9 -3
- package/man/roark-phone-number-create.1 +21 -3
- package/npm-shrinkwrap.json +5 -5
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/man/roark-agent-build.1
CHANGED
|
@@ -18,7 +18,16 @@ Name of the agent Required.
|
|
|
18
18
|
One\-line description of what the agent should do. Roark authors the system prompt from this. Required.
|
|
19
19
|
.TP
|
|
20
20
|
\fB\-\-voice\fR \fI<value>\fR
|
|
21
|
-
Optional
|
|
21
|
+
Optional display name of the agent's voice. The authored prompt matches its delivery to it. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-tts\fR \fI<value>\fR
|
|
24
|
+
Optional provider voice the hosted agent speaks with Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-tts.provider\fR \fI<value>\fR
|
|
27
|
+
Text\-to\-speech provider, for example ELEVENLABS. Not checked against a known list. Required.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-tts.voice\-id\fR \fI<value>\fR
|
|
30
|
+
The provider's id for the voice Required.
|
|
22
31
|
.SH "GLOBAL OPTIONS"
|
|
23
32
|
.TP
|
|
24
33
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -60,7 +69,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
|
|
|
60
69
|
.PP
|
|
61
70
|
.RS 4
|
|
62
71
|
.nf
|
|
63
|
-
roark agent build \-\-name <value> \-\-job\-description <value>
|
|
72
|
+
roark agent build \-\-name <value> \-\-job\-description <value> \-\-tts.provider <value> \-\-tts.voice\-id <value>
|
|
64
73
|
.fi
|
|
65
74
|
.RE
|
|
66
75
|
.SH "ENVIRONMENT"
|
|
@@ -6,19 +6,25 @@ roark\-phone\-number\-available\-list \- Search available phone numbers
|
|
|
6
6
|
.B roark phone\-number available list
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
|
-
Returns US numbers the carrier has for sale, narrowed by area code or by digits the number must contain. Buy one with POST /v1/phone\-number.
|
|
9
|
+
Returns US or Canadian numbers the carrier has for sale, local or toll\-free, narrowed by area code or by digits the number must contain. When an area code has no numbers, nearby ones are returned flagged bestEffort; an empty list means nothing matched. Buy one with POST /v1/phone\-number, or let Roark pick with autoPick.
|
|
10
10
|
.SH "API"
|
|
11
11
|
GET /v1/phone\-number/available
|
|
12
12
|
.SH "OPTIONS"
|
|
13
13
|
.TP
|
|
14
|
+
\fB\-\-country\fR \fI<value>\fR
|
|
15
|
+
ISO 3166\-1 alpha\-2 country of the number: US or CA One of: US, CA. Optional.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-number\-type\fR \fI<value>\fR
|
|
18
|
+
LOCAL for a number in an area code, TOLL_FREE for one from the shared US and Canada toll\-free pool One of: LOCAL, TOLL_FREE. Optional.
|
|
19
|
+
.TP
|
|
14
20
|
\fB\-\-area\-code\fR \fI<value>\fR
|
|
15
|
-
Three\-digit
|
|
21
|
+
Three\-digit area code, or a toll\-free prefix such as 800. When it has no numbers, nearby ones are returned instead, flagged bestEffort. Optional.
|
|
16
22
|
.TP
|
|
17
23
|
\fB\-\-contains\fR \fI<value>\fR
|
|
18
24
|
Digits or letters the number must contain (1 to 7, * matches any digit) Optional.
|
|
19
25
|
.TP
|
|
20
26
|
\fB\-\-limit\fR \fI<value>\fR
|
|
21
|
-
Maximum number of results (default: 20, max:
|
|
27
|
+
Maximum number of results (default: 20, max: 100) Optional.
|
|
22
28
|
.SH "GLOBAL OPTIONS"
|
|
23
29
|
.TP
|
|
24
30
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -6,13 +6,31 @@ roark\-phone\-number\-create \- Buy a phone number
|
|
|
6
6
|
.B roark phone\-number create
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
|
-
Buys a number from the carrier for this project. Free inside the plan allowance; past it, the first month of rent is charged now and monthly after that.
|
|
9
|
+
Buys a number from the carrier for this project: the one named by e164, or one Roark picks to match autoPick (trying the next match if the carrier has just sold one). Free inside the plan allowance; past it, the first month of rent is charged now and monthly after that.
|
|
10
10
|
.SH "API"
|
|
11
11
|
POST /v1/phone\-number
|
|
12
12
|
.SH "OPTIONS"
|
|
13
13
|
.TP
|
|
14
14
|
\fB\-\-e164\fR \fI<value>\fR
|
|
15
|
-
The number to buy, in E.164 format, from a search result
|
|
15
|
+
The number to buy, in E.164 format, from a search result. Give this or autoPick. Optional.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-auto\-pick\fR \fI<value>\fR
|
|
18
|
+
What the number Roark picks should look like. Roark buys the first matching number the carrier will sell, preferring the area code and falling back to a nearby one. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-auto\-pick.country\fR \fI<value>\fR
|
|
21
|
+
ISO 3166\-1 alpha\-2 country of the number: US or CA One of: US, CA. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-auto\-pick.number\-type\fR \fI<value>\fR
|
|
24
|
+
LOCAL for a number in an area code, TOLL_FREE for one from the shared US and Canada toll\-free pool One of: LOCAL, TOLL_FREE. Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-auto\-pick.area\-code\fR \fI<value>\fR
|
|
27
|
+
Three\-digit area code, or a toll\-free prefix such as 800. When it has no numbers, nearby ones are returned instead, flagged bestEffort. Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-auto\-pick.contains\fR \fI<value>\fR
|
|
30
|
+
Digits or letters the number must contain (1 to 7, * matches any digit) Optional.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-country\fR \fI<value>\fR
|
|
33
|
+
The country of the number given by e164 (default: US). An auto\-picked number uses autoPick.country. One of: US, CA. Optional.
|
|
16
34
|
.TP
|
|
17
35
|
\fB\-\-name\fR \fI<value>\fR
|
|
18
36
|
A label for the number Optional.
|
|
@@ -66,7 +84,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
|
|
|
66
84
|
.PP
|
|
67
85
|
.RS 4
|
|
68
86
|
.nf
|
|
69
|
-
roark phone\-number create
|
|
87
|
+
roark phone\-number create
|
|
70
88
|
.fi
|
|
71
89
|
.RE
|
|
72
90
|
.SH "ENVIRONMENT"
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.58.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@roarkanalytics/cli",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.58.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@roarkanalytics/sdk": "^5.17.0",
|
|
@@ -22,9 +22,9 @@
|
|
|
22
22
|
}
|
|
23
23
|
},
|
|
24
24
|
"node_modules/@roarkanalytics/sdk": {
|
|
25
|
-
"version": "5.
|
|
26
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.
|
|
27
|
-
"integrity": "sha512-
|
|
25
|
+
"version": "5.20.0",
|
|
26
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.20.0.tgz",
|
|
27
|
+
"integrity": "sha512-SVadaT02NRAKdPMxMF4h/1+O5sTndaYeuDHV0i4v760NjV2a+Ksb4J9T8y+MXWPyAAoXGD+mGvkzH/DqlBNPTg==",
|
|
28
28
|
"license": "Apache-2.0"
|
|
29
29
|
},
|
|
30
30
|
"node_modules/commander": {
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.58.0";
|
package/version.js
CHANGED