@routr/ctl 2.0.8-alpha.21

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 (78) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +973 -0
  3. package/bin/dev +17 -0
  4. package/bin/dev.cmd +3 -0
  5. package/bin/run +25 -0
  6. package/bin/run.cmd +3 -0
  7. package/dist/base.d.ts +8 -0
  8. package/dist/base.js +42 -0
  9. package/dist/commands/acl/create.d.ts +6 -0
  10. package/dist/commands/acl/create.js +122 -0
  11. package/dist/commands/acl/delete.d.ts +6 -0
  12. package/dist/commands/acl/delete.js +40 -0
  13. package/dist/commands/acl/get.d.ts +19 -0
  14. package/dist/commands/acl/get.js +135 -0
  15. package/dist/commands/acl/update.d.ts +11 -0
  16. package/dist/commands/acl/update.js +100 -0
  17. package/dist/commands/agents/create.d.ts +6 -0
  18. package/dist/commands/agents/create.js +179 -0
  19. package/dist/commands/agents/delete.d.ts +6 -0
  20. package/dist/commands/agents/delete.js +40 -0
  21. package/dist/commands/agents/get.d.ts +19 -0
  22. package/dist/commands/agents/get.js +149 -0
  23. package/dist/commands/agents/update.d.ts +11 -0
  24. package/dist/commands/agents/update.js +150 -0
  25. package/dist/commands/credentials/create.d.ts +6 -0
  26. package/dist/commands/credentials/create.js +122 -0
  27. package/dist/commands/credentials/delete.d.ts +6 -0
  28. package/dist/commands/credentials/delete.js +40 -0
  29. package/dist/commands/credentials/get.d.ts +19 -0
  30. package/dist/commands/credentials/get.js +130 -0
  31. package/dist/commands/credentials/update.d.ts +11 -0
  32. package/dist/commands/credentials/update.js +98 -0
  33. package/dist/commands/domains/create.d.ts +6 -0
  34. package/dist/commands/domains/create.js +187 -0
  35. package/dist/commands/domains/delete.d.ts +6 -0
  36. package/dist/commands/domains/delete.js +40 -0
  37. package/dist/commands/domains/get.d.ts +19 -0
  38. package/dist/commands/domains/get.js +142 -0
  39. package/dist/commands/domains/update.d.ts +11 -0
  40. package/dist/commands/domains/update.js +163 -0
  41. package/dist/commands/numbers/create.d.ts +6 -0
  42. package/dist/commands/numbers/create.js +171 -0
  43. package/dist/commands/numbers/delete.d.ts +6 -0
  44. package/dist/commands/numbers/delete.js +40 -0
  45. package/dist/commands/numbers/get.d.ts +19 -0
  46. package/dist/commands/numbers/get.js +147 -0
  47. package/dist/commands/numbers/update.d.ts +11 -0
  48. package/dist/commands/numbers/update.js +130 -0
  49. package/dist/commands/peers/create.d.ts +6 -0
  50. package/dist/commands/peers/create.js +177 -0
  51. package/dist/commands/peers/delete.d.ts +6 -0
  52. package/dist/commands/peers/delete.js +40 -0
  53. package/dist/commands/peers/get.d.ts +19 -0
  54. package/dist/commands/peers/get.js +159 -0
  55. package/dist/commands/peers/update.d.ts +11 -0
  56. package/dist/commands/peers/update.js +156 -0
  57. package/dist/commands/trunks/create.d.ts +6 -0
  58. package/dist/commands/trunks/create.js +231 -0
  59. package/dist/commands/trunks/delete.d.ts +6 -0
  60. package/dist/commands/trunks/delete.js +40 -0
  61. package/dist/commands/trunks/get.d.ts +19 -0
  62. package/dist/commands/trunks/get.js +145 -0
  63. package/dist/commands/trunks/update.d.ts +11 -0
  64. package/dist/commands/trunks/update.js +217 -0
  65. package/dist/countries.d.ts +4 -0
  66. package/dist/countries.js +270 -0
  67. package/dist/delete.d.ts +9 -0
  68. package/dist/delete.js +46 -0
  69. package/dist/help.d.ts +6 -0
  70. package/dist/help.js +84 -0
  71. package/dist/index.d.ts +1 -0
  72. package/dist/index.js +23 -0
  73. package/dist/utils.d.ts +22 -0
  74. package/dist/utils.js +97 -0
  75. package/dist/validators.d.ts +16 -0
  76. package/dist/validators.js +180 -0
  77. package/oclif.manifest.json +1 -0
  78. package/package.json +89 -0
package/README.md ADDED
@@ -0,0 +1,973 @@
1
+ oclif-hello-world
2
+ =================
3
+
4
+ oclif example Hello World CLI
5
+
6
+ [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7
+ [![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
8
+ [![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
9
+ [![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
10
+ [![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)
11
+
12
+ <!-- toc -->
13
+ * [Usage](#usage)
14
+ * [Commands](#commands)
15
+ <!-- tocstop -->
16
+ # Usage
17
+ <!-- usage -->
18
+ ```sh-session
19
+ $ npm install -g @routr/ctl
20
+ $ rctl COMMAND
21
+ running command...
22
+ $ rctl (--version)
23
+ @routr/ctl/2.0.8-alpha.21 darwin-x64 node-v16.18.1
24
+ $ rctl --help [COMMAND]
25
+ USAGE
26
+ $ rctl COMMAND
27
+ ...
28
+ ```
29
+ <!-- usagestop -->
30
+ # Commands
31
+ <!-- commands -->
32
+ * [`rctl acl create`](#rctl-acl-create)
33
+ * [`rctl acl delete [REF]`](#rctl-acl-delete-ref)
34
+ * [`rctl acl get [REF]`](#rctl-acl-get-ref)
35
+ * [`rctl acl update REF`](#rctl-acl-update-ref)
36
+ * [`rctl agents create`](#rctl-agents-create)
37
+ * [`rctl agents delete [REF]`](#rctl-agents-delete-ref)
38
+ * [`rctl agents get [REF]`](#rctl-agents-get-ref)
39
+ * [`rctl agents update REF`](#rctl-agents-update-ref)
40
+ * [`rctl autocomplete [SHELL]`](#rctl-autocomplete-shell)
41
+ * [`rctl credentials create`](#rctl-credentials-create)
42
+ * [`rctl credentials delete [REF]`](#rctl-credentials-delete-ref)
43
+ * [`rctl credentials get [REF]`](#rctl-credentials-get-ref)
44
+ * [`rctl credentials update REF`](#rctl-credentials-update-ref)
45
+ * [`rctl domains create`](#rctl-domains-create)
46
+ * [`rctl domains delete [REF]`](#rctl-domains-delete-ref)
47
+ * [`rctl domains get [REF]`](#rctl-domains-get-ref)
48
+ * [`rctl domains update REF`](#rctl-domains-update-ref)
49
+ * [`rctl numbers create`](#rctl-numbers-create)
50
+ * [`rctl numbers delete [REF]`](#rctl-numbers-delete-ref)
51
+ * [`rctl numbers get [REF]`](#rctl-numbers-get-ref)
52
+ * [`rctl numbers update REF`](#rctl-numbers-update-ref)
53
+ * [`rctl peers create`](#rctl-peers-create)
54
+ * [`rctl peers delete [REF]`](#rctl-peers-delete-ref)
55
+ * [`rctl peers get [REF]`](#rctl-peers-get-ref)
56
+ * [`rctl peers update REF`](#rctl-peers-update-ref)
57
+ * [`rctl plugins`](#rctl-plugins)
58
+ * [`rctl plugins:install PLUGIN...`](#rctl-pluginsinstall-plugin)
59
+ * [`rctl plugins:inspect PLUGIN...`](#rctl-pluginsinspect-plugin)
60
+ * [`rctl plugins:install PLUGIN...`](#rctl-pluginsinstall-plugin-1)
61
+ * [`rctl plugins:link PLUGIN`](#rctl-pluginslink-plugin)
62
+ * [`rctl plugins:uninstall PLUGIN...`](#rctl-pluginsuninstall-plugin)
63
+ * [`rctl plugins:uninstall PLUGIN...`](#rctl-pluginsuninstall-plugin-1)
64
+ * [`rctl plugins:uninstall PLUGIN...`](#rctl-pluginsuninstall-plugin-2)
65
+ * [`rctl plugins update`](#rctl-plugins-update)
66
+ * [`rctl trunks create`](#rctl-trunks-create)
67
+ * [`rctl trunks delete [REF]`](#rctl-trunks-delete-ref)
68
+ * [`rctl trunks get [REF]`](#rctl-trunks-get-ref)
69
+ * [`rctl trunks update REF`](#rctl-trunks-update-ref)
70
+
71
+ ## `rctl acl create`
72
+
73
+ Creates a new ACL
74
+
75
+ ```
76
+ USAGE
77
+ $ rctl acl create [-x] [-i] [-e <value>]
78
+
79
+ FLAGS
80
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
81
+ -i, --insecure allow insecure connections to the routr server
82
+ -x, --extended extended output format
83
+
84
+ DESCRIPTION
85
+ Creates a new ACL
86
+
87
+ EXAMPLES
88
+ $ rctl acl create
89
+ Creating ACL US Eeast... b148b4b4-6884-4c06-bb7e-bd098f5fe793
90
+ ```
91
+
92
+ ## `rctl acl delete [REF]`
93
+
94
+ Deletes an Access Control List
95
+
96
+ ```
97
+ USAGE
98
+ $ rctl acl delete [REF] [-x] [-i] [-e <value>]
99
+
100
+ FLAGS
101
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
102
+ -i, --insecure allow insecure connections to the routr server
103
+ -x, --extended extended output format
104
+
105
+ DESCRIPTION
106
+ Deletes an Access Control List
107
+
108
+ EXAMPLES
109
+ $ rctl acl delete
110
+ Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
111
+ ```
112
+
113
+ ## `rctl acl get [REF]`
114
+
115
+ Shows a list of paginated ACLs or a single ACL if a ref is provided
116
+
117
+ ```
118
+ USAGE
119
+ $ rctl acl get [REF] [-x] [-i] [-e <value>] [-s <value>]
120
+
121
+ ARGUMENTS
122
+ REF optional reference to an ACL
123
+
124
+ FLAGS
125
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
126
+ -i, --insecure allow insecure connections to the routr server
127
+ -s, --size=<value> [default: 50] the number of items to return
128
+ -x, --extended extended output format
129
+
130
+ DESCRIPTION
131
+ Shows a list of paginated ACLs or a single ACL if a ref is provided
132
+
133
+ EXAMPLES
134
+ $ rctl acl get
135
+ Ref Name Deny List Allow List
136
+ 9e7a88f0-8390-42f5-a2cb-689583ba9f4f Local Network ACL 0.0.0.0/0 10.0.0.28
137
+ ```
138
+
139
+ ## `rctl acl update REF`
140
+
141
+ Updates an existing ACL
142
+
143
+ ```
144
+ USAGE
145
+ $ rctl acl update [REF] [-x] [-i] [-e <value>]
146
+
147
+ ARGUMENTS
148
+ REF reference to an ACL
149
+
150
+ FLAGS
151
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
152
+ -i, --insecure allow insecure connections to the routr server
153
+ -x, --extended extended output format
154
+
155
+ DESCRIPTION
156
+ Updates an existing ACL
157
+
158
+ EXAMPLES
159
+ $ rctl acl update
160
+ Updating ACL US East... 80181ca6-d4aa-4575-9375-8f72b07d5555
161
+ ```
162
+
163
+ ## `rctl agents create`
164
+
165
+ Creates a new Agent
166
+
167
+ ```
168
+ USAGE
169
+ $ rctl agents create [-x] [-i] [-e <value>]
170
+
171
+ FLAGS
172
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
173
+ -i, --insecure allow insecure connections to the routr server
174
+ -x, --extended extended output format
175
+
176
+ DESCRIPTION
177
+ Creates a new Agent
178
+
179
+ EXAMPLES
180
+ $ rctl agents create
181
+ Creating Agent Jhon Doe... b148b4b4-6884-4c06-bb7e-bd098f5fe793
182
+ ```
183
+
184
+ ## `rctl agents delete [REF]`
185
+
186
+ Deletes an Agent
187
+
188
+ ```
189
+ USAGE
190
+ $ rctl agents delete [REF] [-x] [-i] [-e <value>]
191
+
192
+ FLAGS
193
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
194
+ -i, --insecure allow insecure connections to the routr server
195
+ -x, --extended extended output format
196
+
197
+ DESCRIPTION
198
+ Deletes an Agent
199
+
200
+ EXAMPLES
201
+ $ rctl agents delete
202
+ Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
203
+ ```
204
+
205
+ ## `rctl agents get [REF]`
206
+
207
+ Shows a list of paginated Agents or a single Agent if ref is provided
208
+
209
+ ```
210
+ USAGE
211
+ $ rctl agents get [REF] [-x] [-i] [-e <value>] [-s <value>]
212
+
213
+ ARGUMENTS
214
+ REF Optional Agents reference
215
+
216
+ FLAGS
217
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
218
+ -i, --insecure allow insecure connections to the routr server
219
+ -s, --size=<value> [default: 50] The number of items to return
220
+ -x, --extended extended output format
221
+
222
+ DESCRIPTION
223
+ Shows a list of paginated Agents or a single Agent if ref is provided
224
+
225
+ EXAMPLES
226
+ $ rctl agents get
227
+ Ref Name Username Domain Privacy Enabled
228
+ d31f5fb8-e367-42f7-9884-1a7999f53fe8 John Doe jdoe sip.local PRIVATE Yes
229
+ ```
230
+
231
+ ## `rctl agents update REF`
232
+
233
+ Updates an existing Agent
234
+
235
+ ```
236
+ USAGE
237
+ $ rctl agents update [REF] [-x] [-i] [-e <value>]
238
+
239
+ ARGUMENTS
240
+ REF reference to an existing Agent
241
+
242
+ FLAGS
243
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
244
+ -i, --insecure allow insecure connections to the routr server
245
+ -x, --extended extended output format
246
+
247
+ DESCRIPTION
248
+ Updates an existing Agent
249
+
250
+ EXAMPLES
251
+ $ rctl agents update
252
+ Updating Agent John Doe... 80181ca6-d4aa-4575-9375-8f72b07d5555
253
+ ```
254
+
255
+ ## `rctl autocomplete [SHELL]`
256
+
257
+ display autocomplete installation instructions
258
+
259
+ ```
260
+ USAGE
261
+ $ rctl autocomplete [SHELL] [-r]
262
+
263
+ ARGUMENTS
264
+ SHELL shell type
265
+
266
+ FLAGS
267
+ -r, --refresh-cache Refresh cache (ignores displaying instructions)
268
+
269
+ DESCRIPTION
270
+ display autocomplete installation instructions
271
+
272
+ EXAMPLES
273
+ $ rctl autocomplete
274
+
275
+ $ rctl autocomplete bash
276
+
277
+ $ rctl autocomplete zsh
278
+
279
+ $ rctl autocomplete --refresh-cache
280
+ ```
281
+
282
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.10/src/commands/autocomplete/index.ts)_
283
+
284
+ ## `rctl credentials create`
285
+
286
+ Creates a new set of Credentials
287
+
288
+ ```
289
+ USAGE
290
+ $ rctl credentials create [-x] [-i] [-e <value>]
291
+
292
+ FLAGS
293
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
294
+ -i, --insecure allow insecure connections to the routr server
295
+ -x, --extended extended output format
296
+
297
+ DESCRIPTION
298
+ Creates a new set of Credentials
299
+
300
+ EXAMPLES
301
+ $ rctl credentials create
302
+ Creating Credentials JDoe Access... b148b4b4-6884-4c06-bb7e-bd098f5fe793
303
+ ```
304
+
305
+ ## `rctl credentials delete [REF]`
306
+
307
+ Deletes a set of Credentials
308
+
309
+ ```
310
+ USAGE
311
+ $ rctl credentials delete [REF] [-x] [-i] [-e <value>]
312
+
313
+ FLAGS
314
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
315
+ -i, --insecure allow insecure connections to the routr server
316
+ -x, --extended extended output format
317
+
318
+ DESCRIPTION
319
+ Deletes a set of Credentials
320
+
321
+ EXAMPLES
322
+ $ rctl credentials delete
323
+ Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
324
+ ```
325
+
326
+ ## `rctl credentials get [REF]`
327
+
328
+ Shows a list of paginated Credentials or a single set if ref is provided
329
+
330
+ ```
331
+ USAGE
332
+ $ rctl credentials get [REF] [-x] [-i] [-e <value>] [-s <value>]
333
+
334
+ ARGUMENTS
335
+ REF optional reference to a set of Credentials
336
+
337
+ FLAGS
338
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
339
+ -i, --insecure allow insecure connections to the routr server
340
+ -s, --size=<value> [default: 50] the number of items to return
341
+ -x, --extended extended output format
342
+
343
+ DESCRIPTION
344
+ Shows a list of paginated Credentials or a single set if ref is provided
345
+
346
+ EXAMPLES
347
+ $ rctl credentials get
348
+ Ref Name Deny List Allow List
349
+ 80181ca6-d4aa-4575-9375-8f72b07d6666 Europe ACL 0.0.0.0/0 10.0.0.25
350
+ ```
351
+
352
+ ## `rctl credentials update REF`
353
+
354
+ Updates an existing set of Credentials
355
+
356
+ ```
357
+ USAGE
358
+ $ rctl credentials update [REF] [-x] [-i] [-e <value>]
359
+
360
+ ARGUMENTS
361
+ REF reference to an existing set of Credentials
362
+
363
+ FLAGS
364
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
365
+ -i, --insecure allow insecure connections to the routr server
366
+ -x, --extended extended output format
367
+
368
+ DESCRIPTION
369
+ Updates an existing set of Credentials
370
+
371
+ EXAMPLES
372
+ $ rctl credentials update
373
+ Updating Credentials JDoe Credentials... 80181ca6-d4aa-4575-9375-8f72b07d5555
374
+ ```
375
+
376
+ ## `rctl domains create`
377
+
378
+ Creates a new set Domain
379
+
380
+ ```
381
+ USAGE
382
+ $ rctl domains create [-x] [-i] [-e <value>]
383
+
384
+ FLAGS
385
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
386
+ -i, --insecure allow insecure connections to the routr server
387
+ -x, --extended extended output format
388
+
389
+ DESCRIPTION
390
+ Creates a new set Domain
391
+
392
+ EXAMPLES
393
+ $ rctl domains create
394
+ Creating Domain Local Domain... b148b4b4-6884-4c06-bb7e-bd098f5fe793
395
+ ```
396
+
397
+ ## `rctl domains delete [REF]`
398
+
399
+ Deletes a Domain
400
+
401
+ ```
402
+ USAGE
403
+ $ rctl domains delete [REF] [-x] [-i] [-e <value>]
404
+
405
+ FLAGS
406
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
407
+ -i, --insecure allow insecure connections to the routr server
408
+ -x, --extended extended output format
409
+
410
+ DESCRIPTION
411
+ Deletes a Domain
412
+
413
+ EXAMPLES
414
+ $ rctl domains delete
415
+ Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
416
+ ```
417
+
418
+ ## `rctl domains get [REF]`
419
+
420
+ Shows a list of paginated Domains or a single Domain if ref is provided
421
+
422
+ ```
423
+ USAGE
424
+ $ rctl domains get [REF] [-x] [-i] [-e <value>] [-s <value>]
425
+
426
+ ARGUMENTS
427
+ REF optional reference to a Domain
428
+
429
+ FLAGS
430
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
431
+ -i, --insecure allow insecure connections to the routr server
432
+ -s, --size=<value> [default: 50] the number of items to return
433
+ -x, --extended extended output format
434
+
435
+ DESCRIPTION
436
+ Shows a list of paginated Domains or a single Domain if ref is provided
437
+
438
+ EXAMPLES
439
+ $ rctl domains get
440
+ Ref Name URI
441
+ ab2b6959-f497-4b14-903b-85a7c464b564 Local Domain sip.local
442
+ ```
443
+
444
+ ## `rctl domains update REF`
445
+
446
+ Updates an existing Domain
447
+
448
+ ```
449
+ USAGE
450
+ $ rctl domains update [REF] [-x] [-i] [-e <value>]
451
+
452
+ ARGUMENTS
453
+ REF reference to an existing Domain
454
+
455
+ FLAGS
456
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
457
+ -i, --insecure allow insecure connections to the routr server
458
+ -x, --extended extended output format
459
+
460
+ DESCRIPTION
461
+ Updates an existing Domain
462
+
463
+ EXAMPLES
464
+ $ rctl domains update
465
+ Updating Domain Local... 80181ca6-d4aa-4575-9375-8f72b07d5555
466
+ ```
467
+
468
+ ## `rctl numbers create`
469
+
470
+ Creates a new Number
471
+
472
+ ```
473
+ USAGE
474
+ $ rctl numbers create [-x] [-i] [-e <value>]
475
+
476
+ FLAGS
477
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
478
+ -i, --insecure allow insecure connections to the routr server
479
+ -x, --extended extended output format
480
+
481
+ DESCRIPTION
482
+ Creates a new Number
483
+
484
+ EXAMPLES
485
+ $ rctl numbers create
486
+ Creating Number (784) 317-8170... a134487f-a668-4509-9ddd-dcbc98175468
487
+ ```
488
+
489
+ ## `rctl numbers delete [REF]`
490
+
491
+ Deletes a Number
492
+
493
+ ```
494
+ USAGE
495
+ $ rctl numbers delete [REF] [-x] [-i] [-e <value>]
496
+
497
+ FLAGS
498
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
499
+ -i, --insecure allow insecure connections to the routr server
500
+ -x, --extended extended output format
501
+
502
+ DESCRIPTION
503
+ Deletes a Number
504
+
505
+ EXAMPLES
506
+ $ rctl numbers delete
507
+ Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
508
+ ```
509
+
510
+ ## `rctl numbers get [REF]`
511
+
512
+ Shows a list of paginated Numbers or a single Number if ref is provided
513
+
514
+ ```
515
+ USAGE
516
+ $ rctl numbers get [REF] [-x] [-i] [-e <value>] [-s <value>]
517
+
518
+ ARGUMENTS
519
+ REF optional reference to a Number
520
+
521
+ FLAGS
522
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
523
+ -i, --insecure allow insecure connections to the routr server
524
+ -s, --size=<value> [default: 50] the number of items to return
525
+ -x, --extended extended output format
526
+
527
+ DESCRIPTION
528
+ Shows a list of paginated Numbers or a single Number if ref is provided
529
+
530
+ EXAMPLES
531
+ $ rctl numbers get
532
+ Ref Name Telephony URL AOR Link Geo
533
+ a134487f-a668-4509-9ddd-dcbc98175468 (785) 317-8070 +17853178070 sip:1001@sip.local Cameron, USA (US)
534
+ ```
535
+
536
+ ## `rctl numbers update REF`
537
+
538
+ Updates an existing set of Credentials
539
+
540
+ ```
541
+ USAGE
542
+ $ rctl numbers update [REF] [-x] [-i] [-e <value>]
543
+
544
+ ARGUMENTS
545
+ REF reference to an existing Number
546
+
547
+ FLAGS
548
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
549
+ -i, --insecure allow insecure connections to the routr server
550
+ -x, --extended extended output format
551
+
552
+ DESCRIPTION
553
+ Updates an existing set of Credentials
554
+
555
+ EXAMPLES
556
+ $ rctl numbers update
557
+ Updating Number (785) 317-8070... 80181ca6-d4aa-4575-9375-8f72b07d5555
558
+ ```
559
+
560
+ ## `rctl peers create`
561
+
562
+ Creates a new Peer
563
+
564
+ ```
565
+ USAGE
566
+ $ rctl peers create [-x] [-i] [-e <value>]
567
+
568
+ FLAGS
569
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
570
+ -i, --insecure allow insecure connections to the routr server
571
+ -x, --extended extended output format
572
+
573
+ DESCRIPTION
574
+ Creates a new Peer
575
+
576
+ EXAMPLES
577
+ $ rctl peers create
578
+ Creating Peer Asterisk Conference... b148b4b4-6884-4c06-bb7e-bd098f5fe793
579
+ ```
580
+
581
+ ## `rctl peers delete [REF]`
582
+
583
+ Deletes a Peer
584
+
585
+ ```
586
+ USAGE
587
+ $ rctl peers delete [REF] [-x] [-i] [-e <value>]
588
+
589
+ FLAGS
590
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
591
+ -i, --insecure allow insecure connections to the routr server
592
+ -x, --extended extended output format
593
+
594
+ DESCRIPTION
595
+ Deletes a Peer
596
+
597
+ EXAMPLES
598
+ $ rctl peers delete
599
+ Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
600
+ ```
601
+
602
+ ## `rctl peers get [REF]`
603
+
604
+ Shows a list of paginated Peers or a single Peer if ref is provided
605
+
606
+ ```
607
+ USAGE
608
+ $ rctl peers get [REF] [-x] [-i] [-e <value>] [-s <value>]
609
+
610
+ ARGUMENTS
611
+ REF optional reference to a Peer
612
+
613
+ FLAGS
614
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
615
+ -i, --insecure allow insecure connections to the routr server
616
+ -s, --size=<value> [default: 50] the number of items to return
617
+ -x, --extended extended output format
618
+
619
+ DESCRIPTION
620
+ Shows a list of paginated Peers or a single Peer if ref is provided
621
+
622
+ EXAMPLES
623
+ $ rctl peers get
624
+ Ref Name Username AOR Balancing Algorithm Session Affinity
625
+ 6f941c63-880c-419a-a72a-4a107cbaf5c5 Asterisk Conference conference backend:conference ROUND_ROBIN Yes
626
+ ```
627
+
628
+ ## `rctl peers update REF`
629
+
630
+ Updates an existing Peer
631
+
632
+ ```
633
+ USAGE
634
+ $ rctl peers update [REF] [-x] [-i] [-e <value>]
635
+
636
+ ARGUMENTS
637
+ REF reference to an existing Peer
638
+
639
+ FLAGS
640
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
641
+ -i, --insecure allow insecure connections to the routr server
642
+ -x, --extended extended output format
643
+
644
+ DESCRIPTION
645
+ Updates an existing Peer
646
+
647
+ EXAMPLES
648
+ $ rctl peers update
649
+ Updating Peer Asterisk Conf... 80181ca6-d4aa-4575-9375-8f72b07d5555
650
+ ```
651
+
652
+ ## `rctl plugins`
653
+
654
+ List installed plugins.
655
+
656
+ ```
657
+ USAGE
658
+ $ rctl plugins [--core]
659
+
660
+ FLAGS
661
+ --core Show core plugins.
662
+
663
+ DESCRIPTION
664
+ List installed plugins.
665
+
666
+ EXAMPLES
667
+ $ rctl plugins
668
+ ```
669
+
670
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.12/src/commands/plugins/index.ts)_
671
+
672
+ ## `rctl plugins:install PLUGIN...`
673
+
674
+ Installs a plugin into the CLI.
675
+
676
+ ```
677
+ USAGE
678
+ $ rctl plugins:install PLUGIN...
679
+
680
+ ARGUMENTS
681
+ PLUGIN Plugin to install.
682
+
683
+ FLAGS
684
+ -f, --force Run yarn install with force flag.
685
+ -h, --help Show CLI help.
686
+ -v, --verbose
687
+
688
+ DESCRIPTION
689
+ Installs a plugin into the CLI.
690
+ Can be installed from npm or a git url.
691
+
692
+ Installation of a user-installed plugin will override a core plugin.
693
+
694
+ e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
695
+ will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
696
+ the CLI without the need to patch and update the whole CLI.
697
+
698
+
699
+ ALIASES
700
+ $ rctl plugins add
701
+
702
+ EXAMPLES
703
+ $ rctl plugins:install myplugin
704
+
705
+ $ rctl plugins:install https://github.com/someuser/someplugin
706
+
707
+ $ rctl plugins:install someuser/someplugin
708
+ ```
709
+
710
+ ## `rctl plugins:inspect PLUGIN...`
711
+
712
+ Displays installation properties of a plugin.
713
+
714
+ ```
715
+ USAGE
716
+ $ rctl plugins:inspect PLUGIN...
717
+
718
+ ARGUMENTS
719
+ PLUGIN [default: .] Plugin to inspect.
720
+
721
+ FLAGS
722
+ -h, --help Show CLI help.
723
+ -v, --verbose
724
+
725
+ DESCRIPTION
726
+ Displays installation properties of a plugin.
727
+
728
+ EXAMPLES
729
+ $ rctl plugins:inspect myplugin
730
+ ```
731
+
732
+ ## `rctl plugins:install PLUGIN...`
733
+
734
+ Installs a plugin into the CLI.
735
+
736
+ ```
737
+ USAGE
738
+ $ rctl plugins:install PLUGIN...
739
+
740
+ ARGUMENTS
741
+ PLUGIN Plugin to install.
742
+
743
+ FLAGS
744
+ -f, --force Run yarn install with force flag.
745
+ -h, --help Show CLI help.
746
+ -v, --verbose
747
+
748
+ DESCRIPTION
749
+ Installs a plugin into the CLI.
750
+ Can be installed from npm or a git url.
751
+
752
+ Installation of a user-installed plugin will override a core plugin.
753
+
754
+ e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
755
+ will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
756
+ the CLI without the need to patch and update the whole CLI.
757
+
758
+
759
+ ALIASES
760
+ $ rctl plugins add
761
+
762
+ EXAMPLES
763
+ $ rctl plugins:install myplugin
764
+
765
+ $ rctl plugins:install https://github.com/someuser/someplugin
766
+
767
+ $ rctl plugins:install someuser/someplugin
768
+ ```
769
+
770
+ ## `rctl plugins:link PLUGIN`
771
+
772
+ Links a plugin into the CLI for development.
773
+
774
+ ```
775
+ USAGE
776
+ $ rctl plugins:link PLUGIN
777
+
778
+ ARGUMENTS
779
+ PATH [default: .] path to plugin
780
+
781
+ FLAGS
782
+ -h, --help Show CLI help.
783
+ -v, --verbose
784
+
785
+ DESCRIPTION
786
+ Links a plugin into the CLI for development.
787
+ Installation of a linked plugin will override a user-installed or core plugin.
788
+
789
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
790
+ command will override the user-installed or core plugin implementation. This is useful for development work.
791
+
792
+
793
+ EXAMPLES
794
+ $ rctl plugins:link myplugin
795
+ ```
796
+
797
+ ## `rctl plugins:uninstall PLUGIN...`
798
+
799
+ Removes a plugin from the CLI.
800
+
801
+ ```
802
+ USAGE
803
+ $ rctl plugins:uninstall PLUGIN...
804
+
805
+ ARGUMENTS
806
+ PLUGIN plugin to uninstall
807
+
808
+ FLAGS
809
+ -h, --help Show CLI help.
810
+ -v, --verbose
811
+
812
+ DESCRIPTION
813
+ Removes a plugin from the CLI.
814
+
815
+ ALIASES
816
+ $ rctl plugins unlink
817
+ $ rctl plugins remove
818
+ ```
819
+
820
+ ## `rctl plugins:uninstall PLUGIN...`
821
+
822
+ Removes a plugin from the CLI.
823
+
824
+ ```
825
+ USAGE
826
+ $ rctl plugins:uninstall PLUGIN...
827
+
828
+ ARGUMENTS
829
+ PLUGIN plugin to uninstall
830
+
831
+ FLAGS
832
+ -h, --help Show CLI help.
833
+ -v, --verbose
834
+
835
+ DESCRIPTION
836
+ Removes a plugin from the CLI.
837
+
838
+ ALIASES
839
+ $ rctl plugins unlink
840
+ $ rctl plugins remove
841
+ ```
842
+
843
+ ## `rctl plugins:uninstall PLUGIN...`
844
+
845
+ Removes a plugin from the CLI.
846
+
847
+ ```
848
+ USAGE
849
+ $ rctl plugins:uninstall PLUGIN...
850
+
851
+ ARGUMENTS
852
+ PLUGIN plugin to uninstall
853
+
854
+ FLAGS
855
+ -h, --help Show CLI help.
856
+ -v, --verbose
857
+
858
+ DESCRIPTION
859
+ Removes a plugin from the CLI.
860
+
861
+ ALIASES
862
+ $ rctl plugins unlink
863
+ $ rctl plugins remove
864
+ ```
865
+
866
+ ## `rctl plugins update`
867
+
868
+ Update installed plugins.
869
+
870
+ ```
871
+ USAGE
872
+ $ rctl plugins update [-h] [-v]
873
+
874
+ FLAGS
875
+ -h, --help Show CLI help.
876
+ -v, --verbose
877
+
878
+ DESCRIPTION
879
+ Update installed plugins.
880
+ ```
881
+
882
+ ## `rctl trunks create`
883
+
884
+ Creates a new Trunk
885
+
886
+ ```
887
+ USAGE
888
+ $ rctl trunks create [-x] [-i] [-e <value>]
889
+
890
+ FLAGS
891
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
892
+ -i, --insecure allow insecure connections to the routr server
893
+ -x, --extended extended output format
894
+
895
+ DESCRIPTION
896
+ Creates a new Trunk
897
+
898
+ EXAMPLES
899
+ $ rctl trunks create
900
+ Creating Trunk T01... b148b4b4-6884-4c06-bb7e-bd098f5fe793
901
+ ```
902
+
903
+ ## `rctl trunks delete [REF]`
904
+
905
+ Deletes a Trunk
906
+
907
+ ```
908
+ USAGE
909
+ $ rctl trunks delete [REF] [-x] [-i] [-e <value>]
910
+
911
+ FLAGS
912
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
913
+ -i, --insecure allow insecure connections to the routr server
914
+ -x, --extended extended output format
915
+
916
+ DESCRIPTION
917
+ Deletes a Trunk
918
+
919
+ EXAMPLES
920
+ $ rctl trunks delete
921
+ Deleting item 80181ca6-d4aa-4575-9375-8f72b071111... Done
922
+ ```
923
+
924
+ ## `rctl trunks get [REF]`
925
+
926
+ Shows a list of paginated Trunks or a single Trunk if ref is provided
927
+
928
+ ```
929
+ USAGE
930
+ $ rctl trunks get [REF] [-x] [-i] [-e <value>] [-s <value>]
931
+
932
+ ARGUMENTS
933
+ REF optional reference to a Trunk
934
+
935
+ FLAGS
936
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
937
+ -i, --insecure allow insecure connections to the routr server
938
+ -s, --size=<value> [default: 50] the number of items to return
939
+ -x, --extended extended output format
940
+
941
+ DESCRIPTION
942
+ Shows a list of paginated Trunks or a single Trunk if ref is provided
943
+
944
+ EXAMPLES
945
+ $ rctl trunks get
946
+ Ref Name Inbound SIP URI
947
+ 8cde8ea9-3c58-4dbe-b2cf-23c4413dd4cc Local sip.t01.provider.net
948
+ ```
949
+
950
+ ## `rctl trunks update REF`
951
+
952
+ Updates an existing Trunk
953
+
954
+ ```
955
+ USAGE
956
+ $ rctl trunks update [REF] [-x] [-i] [-e <value>]
957
+
958
+ ARGUMENTS
959
+ REF reference to an existing Trunk
960
+
961
+ FLAGS
962
+ -e, --endpoint=<value> [default: localhost:51907] endpoint to connect to the routr server
963
+ -i, --insecure allow insecure connections to the routr server
964
+ -x, --extended extended output format
965
+
966
+ DESCRIPTION
967
+ Updates an existing Trunk
968
+
969
+ EXAMPLES
970
+ $ rctl trunks update
971
+ Updating Trunk T01... 80181ca6-d4aa-4575-9375-8f72b07d5555
972
+ ```
973
+ <!-- commandsstop -->