@fonoster/ctl 0.7.56 → 0.8.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/README.md CHANGED
@@ -12,6 +12,1272 @@ ctl
12
12
  $ npm install --save @fonoster/ctl
13
13
  ```
14
14
 
15
- ## Usage
15
+ <!-- toc -->
16
+ * [Usage](#usage)
17
+ * [Commands](#commands)
18
+ <!-- tocstop -->
19
+ # Usage
20
+ <!-- usage -->
21
+ ```sh-session
22
+ $ npm install -g @fonoster/ctl
23
+ $ fonoster COMMAND
24
+ running command...
25
+ $ fonoster (--version)
26
+ @fonoster/ctl/0.8.0 darwin-arm64 node-v20.15.1
27
+ $ fonoster --help [COMMAND]
28
+ USAGE
29
+ $ fonoster COMMAND
30
+ ...
31
+ ```
32
+ <!-- usagestop -->
33
+ # Commands
34
+ <!-- commands -->
35
+ * [`fonoster apikeys:create`](#fonoster-apikeyscreate)
36
+ * [`fonoster apikeys:delete REF`](#fonoster-apikeysdelete-ref)
37
+ * [`fonoster apikeys:list`](#fonoster-apikeyslist)
38
+ * [`fonoster apikeys:regenerate REF`](#fonoster-apikeysregenerate-ref)
39
+ * [`fonoster applications:create`](#fonoster-applicationscreate)
40
+ * [`fonoster applications:delete REF`](#fonoster-applicationsdelete-ref)
41
+ * [`fonoster applications:get [REF]`](#fonoster-applicationsget-ref)
42
+ * [`fonoster applications:list`](#fonoster-applicationslist)
43
+ * [`fonoster applications:update [REF]`](#fonoster-applicationsupdate-ref)
44
+ * [`fonoster bug`](#fonoster-bug)
45
+ * [`fonoster feedback`](#fonoster-feedback)
46
+ * [`fonoster secrets:create`](#fonoster-secretscreate)
47
+ * [`fonoster secrets:delete REF`](#fonoster-secretsdelete-ref)
48
+ * [`fonoster secrets:get [REF]`](#fonoster-secretsget-ref)
49
+ * [`fonoster secrets:list`](#fonoster-secretslist)
50
+ * [`fonoster secrets:update [REF]`](#fonoster-secretsupdate-ref)
51
+ * [`fonoster sipnet:acls:create`](#fonoster-sipnetaclscreate)
52
+ * [`fonoster sipnet:acls:delete REF`](#fonoster-sipnetaclsdelete-ref)
53
+ * [`fonoster sipnet:acls:get REF`](#fonoster-sipnetaclsget-ref)
54
+ * [`fonoster sipnet:acls:list`](#fonoster-sipnetaclslist)
55
+ * [`fonoster sipnet:acls:update REF`](#fonoster-sipnetaclsupdate-ref)
56
+ * [`fonoster sipnet:agents:create`](#fonoster-sipnetagentscreate)
57
+ * [`fonoster sipnet:agents:delete REF`](#fonoster-sipnetagentsdelete-ref)
58
+ * [`fonoster sipnet:agents:get REF`](#fonoster-sipnetagentsget-ref)
59
+ * [`fonoster sipnet:agents:list`](#fonoster-sipnetagentslist)
60
+ * [`fonoster sipnet:agents:update REF`](#fonoster-sipnetagentsupdate-ref)
61
+ * [`fonoster sipnet:calls:create`](#fonoster-sipnetcallscreate)
62
+ * [`fonoster sipnet:calls:get REF`](#fonoster-sipnetcallsget-ref)
63
+ * [`fonoster sipnet:calls:list`](#fonoster-sipnetcallslist)
64
+ * [`fonoster sipnet:credentials:create`](#fonoster-sipnetcredentialscreate)
65
+ * [`fonoster sipnet:credentials:delete REF`](#fonoster-sipnetcredentialsdelete-ref)
66
+ * [`fonoster sipnet:credentials:get REF`](#fonoster-sipnetcredentialsget-ref)
67
+ * [`fonoster sipnet:credentials:list`](#fonoster-sipnetcredentialslist)
68
+ * [`fonoster sipnet:credentials:update REF`](#fonoster-sipnetcredentialsupdate-ref)
69
+ * [`fonoster sipnet:domains:create`](#fonoster-sipnetdomainscreate)
70
+ * [`fonoster sipnet:domains:delete REF`](#fonoster-sipnetdomainsdelete-ref)
71
+ * [`fonoster sipnet:domains:get REF`](#fonoster-sipnetdomainsget-ref)
72
+ * [`fonoster sipnet:domains:list`](#fonoster-sipnetdomainslist)
73
+ * [`fonoster sipnet:domains:update REF`](#fonoster-sipnetdomainsupdate-ref)
74
+ * [`fonoster sipnet:numbers:create`](#fonoster-sipnetnumberscreate)
75
+ * [`fonoster sipnet:numbers:delete REF`](#fonoster-sipnetnumbersdelete-ref)
76
+ * [`fonoster sipnet:numbers:get [REF]`](#fonoster-sipnetnumbersget-ref)
77
+ * [`fonoster sipnet:numbers:linkTwilioNumber`](#fonoster-sipnetnumberslinktwilionumber)
78
+ * [`fonoster sipnet:numbers:list`](#fonoster-sipnetnumberslist)
79
+ * [`fonoster sipnet:numbers:update [REF]`](#fonoster-sipnetnumbersupdate-ref)
80
+ * [`fonoster sipnet:trunks:create`](#fonoster-sipnettrunkscreate)
81
+ * [`fonoster sipnet:trunks:delete REF`](#fonoster-sipnettrunksdelete-ref)
82
+ * [`fonoster sipnet:trunks:get REF`](#fonoster-sipnettrunksget-ref)
83
+ * [`fonoster sipnet:trunks:list`](#fonoster-sipnettrunkslist)
84
+ * [`fonoster sipnet:trunks:update [REF]`](#fonoster-sipnettrunksupdate-ref)
85
+ * [`fonoster workspaces:active`](#fonoster-workspacesactive)
86
+ * [`fonoster workspaces:list`](#fonoster-workspaceslist)
87
+ * [`fonoster workspaces:login`](#fonoster-workspaceslogin)
88
+ * [`fonoster workspaces:logout REF`](#fonoster-workspaceslogout-ref)
89
+ * [`fonoster workspaces:use REF`](#fonoster-workspacesuse-ref)
90
+
91
+ ## `fonoster apikeys:create`
92
+
93
+ create an API key for the active Workspace
94
+
95
+ ```
96
+ USAGE
97
+ $ fonoster apikeys:create [-i] [-e <value>] [-r <value>]
98
+
99
+ FLAGS
100
+ -e, --expiration=<value> API Key expiration time in days(e.g. 10d) or months(e.g. 10m)
101
+ -i, --insecure allow connections to a server with no TLS
102
+ -r, --role=<value> [default: WORKSPACE_ADMIN] API Key role
103
+
104
+ DESCRIPTION
105
+ create an API key for the active Workspace
106
+
107
+ EXAMPLES
108
+ $ fonoster apikeys:create
109
+ ```
110
+
111
+ _See code: [dist/commands/apikeys/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/apikeys/create.js)_
112
+
113
+ ## `fonoster apikeys:delete REF`
114
+
115
+ delete an API key from the active Workspace
116
+
117
+ ```
118
+ USAGE
119
+ $ fonoster apikeys:delete REF [-i]
120
+
121
+ ARGUMENTS
122
+ REF the ApiKey to delete from the Workspace
123
+
124
+ FLAGS
125
+ -i, --insecure allow connections to a server with no TLS
126
+
127
+ DESCRIPTION
128
+ delete an API key from the active Workspace
129
+
130
+ EXAMPLES
131
+ $ fonoster apikeys:delete
132
+ ```
133
+
134
+ _See code: [dist/commands/apikeys/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/apikeys/delete.js)_
135
+
136
+ ## `fonoster apikeys:list`
137
+
138
+ display all API keys in the active Workspace
139
+
140
+ ```
141
+ USAGE
142
+ $ fonoster apikeys:list [-i] [-s <value>]
143
+
144
+ FLAGS
145
+ -i, --insecure allow connections to a server with no TLS
146
+ -s, --page-size=<value> [default: 1000] the number of items to show
147
+
148
+ DESCRIPTION
149
+ display all API keys in the active Workspace
150
+
151
+ EXAMPLES
152
+ $ fonoster apikeys:list
153
+ ```
154
+
155
+ _See code: [dist/commands/apikeys/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/apikeys/list.js)_
156
+
157
+ ## `fonoster apikeys:regenerate REF`
158
+
159
+ generate a new access key secret for an API key
160
+
161
+ ```
162
+ USAGE
163
+ $ fonoster apikeys:regenerate REF [-i]
164
+
165
+ ARGUMENTS
166
+ REF the Application to update
167
+
168
+ FLAGS
169
+ -i, --insecure allow connections to a server with no TLS
170
+
171
+ DESCRIPTION
172
+ generate a new access key secret for an API key
173
+
174
+ EXAMPLES
175
+ $ fonoster apikeys:regenerate
176
+ ```
177
+
178
+ _See code: [dist/commands/apikeys/regenerate.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/apikeys/regenerate.js)_
179
+
180
+ ## `fonoster applications:create`
181
+
182
+ add a new Application to the active Workspace
183
+
184
+ ```
185
+ USAGE
186
+ $ fonoster applications:create [-i]
187
+
188
+ FLAGS
189
+ -i, --insecure allow connections to a server with no TLS
190
+
191
+ DESCRIPTION
192
+ add a new Application to the active Workspace
193
+
194
+ EXAMPLES
195
+ $ fonoster applications:create
196
+ ```
197
+
198
+ _See code: [dist/commands/applications/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/applications/create.js)_
199
+
200
+ ## `fonoster applications:delete REF`
201
+
202
+ delete an Application from the active Workspace
203
+
204
+ ```
205
+ USAGE
206
+ $ fonoster applications:delete REF [-i]
207
+
208
+ ARGUMENTS
209
+ REF the Application to delete
210
+
211
+ FLAGS
212
+ -i, --insecure allow connections to a server with no TLS
213
+
214
+ DESCRIPTION
215
+ delete an Application from the active Workspace
216
+
217
+ EXAMPLES
218
+ $ fonoster applications:delete
219
+ ```
220
+
221
+ _See code: [dist/commands/applications/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/applications/delete.js)_
222
+
223
+ ## `fonoster applications:get [REF]`
224
+
225
+ retrieve details of an Application by reference
226
+
227
+ ```
228
+ USAGE
229
+ $ fonoster applications:get [REF] [-i]
230
+
231
+ ARGUMENTS
232
+ REF The Application to show details about
233
+
234
+ FLAGS
235
+ -i, --insecure allow connections to a server with no TLS
236
+
237
+ DESCRIPTION
238
+ retrieve details of an Application by reference
239
+
240
+ EXAMPLES
241
+ $ fonoster applications:get
242
+ ```
243
+
244
+ _See code: [dist/commands/applications/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/applications/get.js)_
245
+
246
+ ## `fonoster applications:list`
247
+
248
+ display all Applications in the active Workspace
249
+
250
+ ```
251
+ USAGE
252
+ $ fonoster applications:list [-i] [-s <value>]
253
+
254
+ FLAGS
255
+ -i, --insecure allow connections to a server with no TLS
256
+ -s, --page-size=<value> [default: 1000] the number of items to show
257
+
258
+ DESCRIPTION
259
+ display all Applications in the active Workspace
260
+
261
+ EXAMPLES
262
+ $ fonoster applications:list
263
+ ```
264
+
265
+ _See code: [dist/commands/applications/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/applications/list.js)_
266
+
267
+ ## `fonoster applications:update [REF]`
268
+
269
+ modify the configuration of an Application
270
+
271
+ ```
272
+ USAGE
273
+ $ fonoster applications:update [REF] [-i]
274
+
275
+ ARGUMENTS
276
+ REF the Application to update
277
+
278
+ FLAGS
279
+ -i, --insecure allow connections to a server with no TLS
280
+
281
+ DESCRIPTION
282
+ modify the configuration of an Application
283
+
284
+ EXAMPLES
285
+ $ fonoster applications:update
286
+ ```
287
+
288
+ _See code: [dist/commands/applications/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/applications/update.js)_
289
+
290
+ ## `fonoster bug`
291
+
292
+ report a bug to the development team 🐞
293
+
294
+ ```
295
+ USAGE
296
+ $ fonoster bug
297
+
298
+ DESCRIPTION
299
+ report a bug to the development team 🐞
300
+
301
+ EXAMPLES
302
+ $ fonoster bug
303
+ ```
304
+
305
+ _See code: [dist/commands/bug.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/bug.js)_
306
+
307
+ ## `fonoster feedback`
308
+
309
+ provide feedback on your experience
310
+
311
+ ```
312
+ USAGE
313
+ $ fonoster feedback
314
+
315
+ DESCRIPTION
316
+ provide feedback on your experience
317
+ ...
318
+ Help us improve by providing some feedback
319
+
320
+
321
+ EXAMPLES
322
+ $ fonoster feedback
323
+ ```
324
+
325
+ _See code: [dist/commands/feedback.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/feedback.js)_
326
+
327
+ ## `fonoster secrets:create`
328
+
329
+ add a new Secret to the active Workspace
330
+
331
+ ```
332
+ USAGE
333
+ $ fonoster secrets:create [-i]
334
+
335
+ FLAGS
336
+ -i, --insecure allow connections to a server with no TLS
337
+
338
+ DESCRIPTION
339
+ add a new Secret to the active Workspace
340
+
341
+ EXAMPLES
342
+ $ fonoster secrets:create
343
+ ```
344
+
345
+ _See code: [dist/commands/secrets/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/secrets/create.js)_
346
+
347
+ ## `fonoster secrets:delete REF`
348
+
349
+ delete a Secret from the active Workspace
350
+
351
+ ```
352
+ USAGE
353
+ $ fonoster secrets:delete REF [-i]
354
+
355
+ ARGUMENTS
356
+ REF the Secret reference
357
+
358
+ FLAGS
359
+ -i, --insecure allow connections to a server with no TLS
360
+
361
+ DESCRIPTION
362
+ delete a Secret from the active Workspace
363
+
364
+ EXAMPLES
365
+ $ fonoster secrets:delete
366
+ ```
367
+
368
+ _See code: [dist/commands/secrets/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/secrets/delete.js)_
369
+
370
+ ## `fonoster secrets:get [REF]`
371
+
372
+ retrieve details of a Secret by reference
373
+
374
+ ```
375
+ USAGE
376
+ $ fonoster secrets:get [REF] [-i]
377
+
378
+ ARGUMENTS
379
+ REF The Secret to show details about
380
+
381
+ FLAGS
382
+ -i, --insecure allow connections to a server with no TLS
383
+
384
+ DESCRIPTION
385
+ retrieve details of a Secret by reference
386
+
387
+ EXAMPLES
388
+ $ fonoster secrets:get
389
+ ```
390
+
391
+ _See code: [dist/commands/secrets/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/secrets/get.js)_
392
+
393
+ ## `fonoster secrets:list`
394
+
395
+ display all Secrets in the active Workspace
396
+
397
+ ```
398
+ USAGE
399
+ $ fonoster secrets:list [-i] [-s <value>]
400
+
401
+ FLAGS
402
+ -i, --insecure allow connections to a server with no TLS
403
+ -s, --page-size=<value> [default: 1000] the number of items to show
404
+
405
+ DESCRIPTION
406
+ display all Secrets in the active Workspace
407
+
408
+ EXAMPLES
409
+ $ fonoster secrets:list
410
+ ```
411
+
412
+ _See code: [dist/commands/secrets/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/secrets/list.js)_
413
+
414
+ ## `fonoster secrets:update [REF]`
415
+
416
+ modify the value or metadata of a Secret
417
+
418
+ ```
419
+ USAGE
420
+ $ fonoster secrets:update [REF] [-i]
421
+
422
+ ARGUMENTS
423
+ REF the Secret to update
424
+
425
+ FLAGS
426
+ -i, --insecure allow connections to a server with no TLS
427
+
428
+ DESCRIPTION
429
+ modify the value or metadata of a Secret
430
+
431
+ EXAMPLES
432
+ $ fonoster secrets:update
433
+ ```
434
+
435
+ _See code: [dist/commands/secrets/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/secrets/update.js)_
436
+
437
+ ## `fonoster sipnet:acls:create`
438
+
439
+ create a new Access Control List (ACL)
440
+
441
+ ```
442
+ USAGE
443
+ $ fonoster sipnet:acls:create [-i]
444
+
445
+ FLAGS
446
+ -i, --insecure allow connections to a server with no TLS
447
+
448
+ DESCRIPTION
449
+ create a new Access Control List (ACL)
450
+
451
+ EXAMPLES
452
+ $ fonoster sipnet:acls:create
453
+ ```
454
+
455
+ _See code: [dist/commands/sipnet/acls/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/acls/create.js)_
456
+
457
+ ## `fonoster sipnet:acls:delete REF`
458
+
459
+ remove an Access Control List (ACL) from the Workspace
460
+
461
+ ```
462
+ USAGE
463
+ $ fonoster sipnet:acls:delete REF [-i]
464
+
465
+ ARGUMENTS
466
+ REF the ACL reference
467
+
468
+ FLAGS
469
+ -i, --insecure allow connections to a server with no TLS
470
+
471
+ DESCRIPTION
472
+ remove an Access Control List (ACL) from the Workspace
473
+
474
+ EXAMPLES
475
+ $ fonoster sipnet:acls:delete
476
+ ```
477
+
478
+ _See code: [dist/commands/sipnet/acls/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/acls/delete.js)_
479
+
480
+ ## `fonoster sipnet:acls:get REF`
481
+
482
+ get a specific Access Control List (ACL)
483
+
484
+ ```
485
+ USAGE
486
+ $ fonoster sipnet:acls:get REF [-i]
487
+
488
+ ARGUMENTS
489
+ REF The ACL reference
490
+
491
+ FLAGS
492
+ -i, --insecure allow connections to a server with no TLS
493
+
494
+ DESCRIPTION
495
+ get a specific Access Control List (ACL)
496
+
497
+ EXAMPLES
498
+ $ fonoster sipnet:acls:get
499
+ ```
500
+
501
+ _See code: [dist/commands/sipnet/acls/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/acls/get.js)_
502
+
503
+ ## `fonoster sipnet:acls:list`
504
+
505
+ list all Access Control Lists (ACLs)
506
+
507
+ ```
508
+ USAGE
509
+ $ fonoster sipnet:acls:list [-i] [-s <value>]
510
+
511
+ FLAGS
512
+ -i, --insecure allow connections to a server with no TLS
513
+ -s, --page-size=<value> [default: 1000] the number of items to show
514
+
515
+ DESCRIPTION
516
+ list all Access Control Lists (ACLs)
517
+
518
+ EXAMPLES
519
+ $ fonoster sipnet:acls:list
520
+ ```
521
+
522
+ _See code: [dist/commands/sipnet/acls/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/acls/list.js)_
523
+
524
+ ## `fonoster sipnet:acls:update REF`
525
+
526
+ update an existing Access Control List (ACL)
527
+
528
+ ```
529
+ USAGE
530
+ $ fonoster sipnet:acls:update REF [-i]
531
+
532
+ ARGUMENTS
533
+ REF the ACL reference
534
+
535
+ FLAGS
536
+ -i, --insecure allow connections to a server with no TLS
537
+
538
+ DESCRIPTION
539
+ update an existing Access Control List (ACL)
540
+
541
+ EXAMPLES
542
+ $ fonoster sipnet:acls:update
543
+ ```
544
+
545
+ _See code: [dist/commands/sipnet/acls/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/acls/update.js)_
546
+
547
+ ## `fonoster sipnet:agents:create`
548
+
549
+ add a new SIP Agent to the network
550
+
551
+ ```
552
+ USAGE
553
+ $ fonoster sipnet:agents:create [-i]
554
+
555
+ FLAGS
556
+ -i, --insecure allow connections to a server with no TLS
557
+
558
+ DESCRIPTION
559
+ add a new SIP Agent to the network
560
+
561
+ EXAMPLES
562
+ $ fonoster sipnet:agents:create
563
+ ```
564
+
565
+ _See code: [dist/commands/sipnet/agents/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/agents/create.js)_
566
+
567
+ ## `fonoster sipnet:agents:delete REF`
568
+
569
+ delete a SIP Agent from the network
570
+
571
+ ```
572
+ USAGE
573
+ $ fonoster sipnet:agents:delete REF [-i]
574
+
575
+ ARGUMENTS
576
+ REF the Agent reference
577
+
578
+ FLAGS
579
+ -i, --insecure allow connections to a server with no TLS
580
+
581
+ DESCRIPTION
582
+ delete a SIP Agent from the network
583
+
584
+ EXAMPLES
585
+ $ fonoster sipnet:agents:delete
586
+ ```
587
+
588
+ _See code: [dist/commands/sipnet/agents/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/agents/delete.js)_
589
+
590
+ ## `fonoster sipnet:agents:get REF`
591
+
592
+ retrieve details of a SIP Agent
593
+
594
+ ```
595
+ USAGE
596
+ $ fonoster sipnet:agents:get REF [-i]
597
+
598
+ ARGUMENTS
599
+ REF The Agent reference
600
+
601
+ FLAGS
602
+ -i, --insecure allow connections to a server with no TLS
603
+
604
+ DESCRIPTION
605
+ retrieve details of a SIP Agent
606
+
607
+ EXAMPLES
608
+ $ fonoster sipnet:agents:get
609
+ ```
610
+
611
+ _See code: [dist/commands/sipnet/agents/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/agents/get.js)_
612
+
613
+ ## `fonoster sipnet:agents:list`
614
+
615
+ display all SIP Agents in the network
616
+
617
+ ```
618
+ USAGE
619
+ $ fonoster sipnet:agents:list [-i] [-s <value>]
620
+
621
+ FLAGS
622
+ -i, --insecure allow connections to a server with no TLS
623
+ -s, --page-size=<value> [default: 1000] the number of items to show
624
+
625
+ DESCRIPTION
626
+ display all SIP Agents in the network
627
+
628
+ EXAMPLES
629
+ $ fonoster sipnet:agents:list
630
+ ```
631
+
632
+ _See code: [dist/commands/sipnet/agents/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/agents/list.js)_
633
+
634
+ ## `fonoster sipnet:agents:update REF`
635
+
636
+ add a new SIP Agent to the network
637
+
638
+ ```
639
+ USAGE
640
+ $ fonoster sipnet:agents:update REF [-i]
641
+
642
+ ARGUMENTS
643
+ REF the ACL reference
644
+
645
+ FLAGS
646
+ -i, --insecure allow connections to a server with no TLS
647
+
648
+ DESCRIPTION
649
+ add a new SIP Agent to the network
650
+
651
+ EXAMPLES
652
+ $ fonoster sipnet:agents:update
653
+ ```
654
+
655
+ _See code: [dist/commands/sipnet/agents/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/agents/update.js)_
656
+
657
+ ## `fonoster sipnet:calls:create`
658
+
659
+ initiate a call to a phone number or SIP URI
660
+
661
+ ```
662
+ USAGE
663
+ $ fonoster sipnet:calls:create -f <value> -t <value> -a <value> [-i] [-o <value>] [-c]
664
+
665
+ FLAGS
666
+ -a, --app-ref=<value> (required) The application reference
667
+ -c, --track-call Track the call
668
+ -f, --from-number=<value> (required) The number to make the call from
669
+ -i, --insecure allow connections to a server with no TLS
670
+ -o, --timeout=<value> [default: 30] The call timeout
671
+ -t, --to-number=<value> (required) The number to make the call to
672
+
673
+ DESCRIPTION
674
+ initiate a call to a phone number or SIP URI
675
+
676
+ EXAMPLES
677
+ $ fonoster sipnet:calls:create
678
+ ```
679
+
680
+ _See code: [dist/commands/sipnet/calls/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/calls/create.js)_
681
+
682
+ ## `fonoster sipnet:calls:get REF`
683
+
684
+ get a specific Access Control List (ACL)
685
+
686
+ ```
687
+ USAGE
688
+ $ fonoster sipnet:calls:get REF [-i]
689
+
690
+ ARGUMENTS
691
+ REF The ACL reference
692
+
693
+ FLAGS
694
+ -i, --insecure allow connections to a server with no TLS
695
+
696
+ DESCRIPTION
697
+ get a specific Access Control List (ACL)
698
+
699
+ EXAMPLES
700
+ $ fonoster sipnet:calls:get
701
+ ```
702
+
703
+ _See code: [dist/commands/sipnet/calls/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/calls/get.js)_
704
+
705
+ ## `fonoster sipnet:calls:list`
706
+
707
+ display all calls made in the active Workspace
708
+
709
+ ```
710
+ USAGE
711
+ $ fonoster sipnet:calls:list [-i] [-s <value>]
712
+
713
+ FLAGS
714
+ -i, --insecure allow connections to a server with no TLS
715
+ -s, --page-size=<value> [default: 1000] the number of items to show
716
+
717
+ DESCRIPTION
718
+ display all calls made in the active Workspace
719
+
720
+ EXAMPLES
721
+ $ fonoster sipnet:calls:list
722
+ ```
723
+
724
+ _See code: [dist/commands/sipnet/calls/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/calls/list.js)_
725
+
726
+ ## `fonoster sipnet:credentials:create`
727
+
728
+ add a new set of Credentials to the network
729
+
730
+ ```
731
+ USAGE
732
+ $ fonoster sipnet:credentials:create [-i]
733
+
734
+ FLAGS
735
+ -i, --insecure allow connections to a server with no TLS
736
+
737
+ DESCRIPTION
738
+ add a new set of Credentials to the network
739
+
740
+ EXAMPLES
741
+ $ fonoster sipnet:credentials:create
742
+ ```
743
+
744
+ _See code: [dist/commands/sipnet/credentials/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/credentials/create.js)_
745
+
746
+ ## `fonoster sipnet:credentials:delete REF`
747
+
748
+ delete a set of Credentials from the active Workspace
749
+
750
+ ```
751
+ USAGE
752
+ $ fonoster sipnet:credentials:delete REF [-i]
753
+
754
+ ARGUMENTS
755
+ REF the Credentials reference
756
+
757
+ FLAGS
758
+ -i, --insecure allow connections to a server with no TLS
759
+
760
+ DESCRIPTION
761
+ delete a set of Credentials from the active Workspace
762
+
763
+ EXAMPLES
764
+ $ fonoster sipnet:credentials:delete
765
+ ```
766
+
767
+ _See code: [dist/commands/sipnet/credentials/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/credentials/delete.js)_
768
+
769
+ ## `fonoster sipnet:credentials:get REF`
770
+
771
+ retrieve details of a set of Credentials by reference
772
+
773
+ ```
774
+ USAGE
775
+ $ fonoster sipnet:credentials:get REF [-i]
776
+
777
+ ARGUMENTS
778
+ REF The Credentials reference
779
+
780
+ FLAGS
781
+ -i, --insecure allow connections to a server with no TLS
782
+
783
+ DESCRIPTION
784
+ retrieve details of a set of Credentials by reference
785
+
786
+ EXAMPLES
787
+ $ fonoster sipnet:credentials:get
788
+ ```
789
+
790
+ _See code: [dist/commands/sipnet/credentials/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/credentials/get.js)_
791
+
792
+ ## `fonoster sipnet:credentials:list`
793
+
794
+ display all Credentials in the active Workspace
795
+
796
+ ```
797
+ USAGE
798
+ $ fonoster sipnet:credentials:list [-i] [-s <value>]
799
+
800
+ FLAGS
801
+ -i, --insecure allow connections to a server with no TLS
802
+ -s, --page-size=<value> [default: 1000] the number of items to show
803
+
804
+ DESCRIPTION
805
+ display all Credentials in the active Workspace
806
+
807
+ EXAMPLES
808
+ $ fonoster sipnet:credentials:list
809
+ ```
810
+
811
+ _See code: [dist/commands/sipnet/credentials/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/credentials/list.js)_
812
+
813
+ ## `fonoster sipnet:credentials:update REF`
814
+
815
+ modify the values or metadata of a set of Credentials
816
+
817
+ ```
818
+ USAGE
819
+ $ fonoster sipnet:credentials:update REF [-i]
820
+
821
+ ARGUMENTS
822
+ REF the Credentials reference
823
+
824
+ FLAGS
825
+ -i, --insecure allow connections to a server with no TLS
826
+
827
+ DESCRIPTION
828
+ modify the values or metadata of a set of Credentials
829
+
830
+ EXAMPLES
831
+ $ fonoster sipnet:credentials:update
832
+ ```
833
+
834
+ _See code: [dist/commands/sipnet/credentials/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/credentials/update.js)_
835
+
836
+ ## `fonoster sipnet:domains:create`
837
+
838
+ add a new Domain to the SIP network
839
+
840
+ ```
841
+ USAGE
842
+ $ fonoster sipnet:domains:create [-i]
843
+
844
+ FLAGS
845
+ -i, --insecure allow connections to a server with no TLS
846
+
847
+ DESCRIPTION
848
+ add a new Domain to the SIP network
849
+
850
+ EXAMPLES
851
+ $ fonoster sipnet:domains:create
852
+ ```
853
+
854
+ _See code: [dist/commands/sipnet/domains/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/domains/create.js)_
855
+
856
+ ## `fonoster sipnet:domains:delete REF`
857
+
858
+ delete a Domain from the active Workspace
859
+
860
+ ```
861
+ USAGE
862
+ $ fonoster sipnet:domains:delete REF [-i]
863
+
864
+ ARGUMENTS
865
+ REF the Domain reference
866
+
867
+ FLAGS
868
+ -i, --insecure allow connections to a server with no TLS
869
+
870
+ DESCRIPTION
871
+ delete a Domain from the active Workspace
872
+
873
+ EXAMPLES
874
+ $ fonoster sipnet:domains:delete
875
+ ```
876
+
877
+ _See code: [dist/commands/sipnet/domains/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/domains/delete.js)_
878
+
879
+ ## `fonoster sipnet:domains:get REF`
880
+
881
+ retrieve details of a Domain by reference
882
+
883
+ ```
884
+ USAGE
885
+ $ fonoster sipnet:domains:get REF [-i]
886
+
887
+ ARGUMENTS
888
+ REF The Domain reference
889
+
890
+ FLAGS
891
+ -i, --insecure allow connections to a server with no TLS
892
+
893
+ DESCRIPTION
894
+ retrieve details of a Domain by reference
895
+
896
+ EXAMPLES
897
+ $ fonoster sipnet:domains:get
898
+ ```
899
+
900
+ _See code: [dist/commands/sipnet/domains/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/domains/get.js)_
901
+
902
+ ## `fonoster sipnet:domains:list`
903
+
904
+ display all Domains in the SIP network
905
+
906
+ ```
907
+ USAGE
908
+ $ fonoster sipnet:domains:list [-i] [-s <value>]
909
+
910
+ FLAGS
911
+ -i, --insecure allow connections to a server with no TLS
912
+ -s, --page-size=<value> [default: 1000] the number of items to show
913
+
914
+ DESCRIPTION
915
+ display all Domains in the SIP network
916
+
917
+ EXAMPLES
918
+ $ fonoster sipnet:domains:list
919
+ ```
920
+
921
+ _See code: [dist/commands/sipnet/domains/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/domains/list.js)_
922
+
923
+ ## `fonoster sipnet:domains:update REF`
924
+
925
+ modify the configuration of a Domain
926
+
927
+ ```
928
+ USAGE
929
+ $ fonoster sipnet:domains:update REF [-i]
930
+
931
+ ARGUMENTS
932
+ REF the Domain reference
933
+
934
+ FLAGS
935
+ -i, --insecure allow connections to a server with no TLS
936
+
937
+ DESCRIPTION
938
+ modify the configuration of a Domain
939
+
940
+ EXAMPLES
941
+ $ fonoster sipnet:domains:update
942
+ ```
943
+
944
+ _See code: [dist/commands/sipnet/domains/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/domains/update.js)_
945
+
946
+ ## `fonoster sipnet:numbers:create`
947
+
948
+ add a new Number to the SIP network
949
+
950
+ ```
951
+ USAGE
952
+ $ fonoster sipnet:numbers:create [-i]
953
+
954
+ FLAGS
955
+ -i, --insecure allow connections to a server with no TLS
956
+
957
+ DESCRIPTION
958
+ add a new Number to the SIP network
959
+
960
+ EXAMPLES
961
+ $ fonoster sipnet:numbers:create
962
+ ```
963
+
964
+ _See code: [dist/commands/sipnet/numbers/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/numbers/create.js)_
965
+
966
+ ## `fonoster sipnet:numbers:delete REF`
967
+
968
+ delete a Number from the active Workspace
969
+
970
+ ```
971
+ USAGE
972
+ $ fonoster sipnet:numbers:delete REF [-i]
973
+
974
+ ARGUMENTS
975
+ REF the Numbers's reference
976
+
977
+ FLAGS
978
+ -i, --insecure allow connections to a server with no TLS
979
+
980
+ DESCRIPTION
981
+ delete a Number from the active Workspace
982
+
983
+ EXAMPLES
984
+ $ fonoster sipnet:numbers:delete
985
+ ```
986
+
987
+ _See code: [dist/commands/sipnet/numbers/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/numbers/delete.js)_
988
+
989
+ ## `fonoster sipnet:numbers:get [REF]`
990
+
991
+ retrieve details of a Number by reference
992
+
993
+ ```
994
+ USAGE
995
+ $ fonoster sipnet:numbers:get [REF] [-i]
996
+
997
+ ARGUMENTS
998
+ REF the Number to show details about
999
+
1000
+ FLAGS
1001
+ -i, --insecure allow connections to a server with no TLS
1002
+
1003
+ DESCRIPTION
1004
+ retrieve details of a Number by reference
1005
+
1006
+ EXAMPLES
1007
+ $ fonoster sipnet:numbers:get
1008
+ ```
1009
+
1010
+ _See code: [dist/commands/sipnet/numbers/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/numbers/get.js)_
1011
+
1012
+ ## `fonoster sipnet:numbers:linkTwilioNumber`
1013
+
1014
+ associate a Twilio number with a Fonoster Application
1015
+
1016
+ ```
1017
+ USAGE
1018
+ $ fonoster sipnet:numbers:linkTwilioNumber [-i] [-b <value>] [-a <value>]
1019
+
1020
+ FLAGS
1021
+ -a, --access-control-list=<value> [default: 165.22.7.155/32] the access control list to allow (use if running your
1022
+ Fonoster instance)
1023
+ -b, --outbound-uri-base=<value> [default: pstn.fonoster.dev] the uri to point twilio to for outbound calls (use if
1024
+ running your Fonoster instance)
1025
+ -i, --insecure allow connections to a server with no TLS
1026
+
1027
+ DESCRIPTION
1028
+ associate a Twilio number with a Fonoster Application
1029
+
1030
+ EXAMPLES
1031
+ $ fonoster sipnet:numbers:linkTwilioNumber
1032
+ ```
1033
+
1034
+ _See code: [dist/commands/sipnet/numbers/linkTwilioNumber.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/numbers/linkTwilioNumber.js)_
1035
+
1036
+ ## `fonoster sipnet:numbers:list`
1037
+
1038
+ display all Numbers in the active Workspace
1039
+
1040
+ ```
1041
+ USAGE
1042
+ $ fonoster sipnet:numbers:list [-i] [-s <value>]
1043
+
1044
+ FLAGS
1045
+ -i, --insecure allow connections to a server with no TLS
1046
+ -s, --page-size=<value> [default: 1000] the number of items to return
1047
+
1048
+ DESCRIPTION
1049
+ display all Numbers in the active Workspace
1050
+
1051
+ EXAMPLES
1052
+ $ fonoster sipnet:numbers:list
1053
+ ```
1054
+
1055
+ _See code: [dist/commands/sipnet/numbers/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/numbers/list.js)_
1056
+
1057
+ ## `fonoster sipnet:numbers:update [REF]`
1058
+
1059
+ modify the configuration of a Number
1060
+
1061
+ ```
1062
+ USAGE
1063
+ $ fonoster sipnet:numbers:update [REF] [-i]
1064
+
1065
+ ARGUMENTS
1066
+ REF the Number to update
1067
+
1068
+ FLAGS
1069
+ -i, --insecure allow connections to a server with no TLS
1070
+
1071
+ DESCRIPTION
1072
+ modify the configuration of a Number
1073
+
1074
+ EXAMPLES
1075
+ $ fonoster sipnet:numbers:update
1076
+ ```
1077
+
1078
+ _See code: [dist/commands/sipnet/numbers/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/numbers/update.js)_
1079
+
1080
+ ## `fonoster sipnet:trunks:create`
1081
+
1082
+ add a new Trunk to the SIP network
1083
+
1084
+ ```
1085
+ USAGE
1086
+ $ fonoster sipnet:trunks:create [-i]
1087
+
1088
+ FLAGS
1089
+ -i, --insecure allow connections to a server with no TLS
1090
+
1091
+ DESCRIPTION
1092
+ add a new Trunk to the SIP network
1093
+
1094
+ EXAMPLES
1095
+ $ fonoster sipnet:trunks:create
1096
+ ```
1097
+
1098
+ _See code: [dist/commands/sipnet/trunks/create.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/trunks/create.js)_
1099
+
1100
+ ## `fonoster sipnet:trunks:delete REF`
1101
+
1102
+ remove a Trunk from the active Workspace
1103
+
1104
+ ```
1105
+ USAGE
1106
+ $ fonoster sipnet:trunks:delete REF [-i]
1107
+
1108
+ ARGUMENTS
1109
+ REF the Trunk's reference
1110
+
1111
+ FLAGS
1112
+ -i, --insecure allow connections to a server with no TLS
1113
+
1114
+ DESCRIPTION
1115
+ remove a Trunk from the active Workspace
1116
+
1117
+ EXAMPLES
1118
+ $ fonoster sipnet:trunks:delete
1119
+ ```
1120
+
1121
+ _See code: [dist/commands/sipnet/trunks/delete.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/trunks/delete.js)_
1122
+
1123
+ ## `fonoster sipnet:trunks:get REF`
1124
+
1125
+ retrieve details of a Trunk by reference
1126
+
1127
+ ```
1128
+ USAGE
1129
+ $ fonoster sipnet:trunks:get REF [-i]
1130
+
1131
+ ARGUMENTS
1132
+ REF The Trunk's reference
1133
+
1134
+ FLAGS
1135
+ -i, --insecure allow connections to a server with no TLS
1136
+
1137
+ DESCRIPTION
1138
+ retrieve details of a Trunk by reference
1139
+
1140
+ EXAMPLES
1141
+ $ fonoster sipnet:trunks:get
1142
+ ```
1143
+
1144
+ _See code: [dist/commands/sipnet/trunks/get.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/trunks/get.js)_
1145
+
1146
+ ## `fonoster sipnet:trunks:list`
1147
+
1148
+ display all Trunks in the active Workspace
1149
+
1150
+ ```
1151
+ USAGE
1152
+ $ fonoster sipnet:trunks:list [-i] [-s <value>]
1153
+
1154
+ FLAGS
1155
+ -i, --insecure allow connections to a server with no TLS
1156
+ -s, --page-size=<value> [default: 1000] the number of items to show
1157
+
1158
+ DESCRIPTION
1159
+ display all Trunks in the active Workspace
1160
+
1161
+ EXAMPLES
1162
+ $ fonoster sipnet:trunks:list
1163
+ ```
1164
+
1165
+ _See code: [dist/commands/sipnet/trunks/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/trunks/list.js)_
1166
+
1167
+ ## `fonoster sipnet:trunks:update [REF]`
1168
+
1169
+ modify the configuration of a Trunk
1170
+
1171
+ ```
1172
+ USAGE
1173
+ $ fonoster sipnet:trunks:update [REF] [-i]
1174
+
1175
+ ARGUMENTS
1176
+ REF the Trunk to update
1177
+
1178
+ FLAGS
1179
+ -i, --insecure allow connections to a server with no TLS
1180
+
1181
+ DESCRIPTION
1182
+ modify the configuration of a Trunk
1183
+
1184
+ EXAMPLES
1185
+ $ fonoster sipnet:trunks:update
1186
+ ```
1187
+
1188
+ _See code: [dist/commands/sipnet/trunks/update.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/sipnet/trunks/update.js)_
1189
+
1190
+ ## `fonoster workspaces:active`
1191
+
1192
+ display the name of the active Workspace
1193
+
1194
+ ```
1195
+ USAGE
1196
+ $ fonoster workspaces:active
1197
+
1198
+ DESCRIPTION
1199
+ display the name of the active Workspace
1200
+
1201
+ EXAMPLES
1202
+ $ fonoster workspaces:active
1203
+ ```
1204
+
1205
+ _See code: [dist/commands/workspaces/active.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/workspaces/active.js)_
1206
+
1207
+ ## `fonoster workspaces:list`
1208
+
1209
+ display all linked Workspaces
1210
+
1211
+ ```
1212
+ USAGE
1213
+ $ fonoster workspaces:list
1214
+
1215
+ DESCRIPTION
1216
+ display all linked Workspaces
1217
+
1218
+ EXAMPLES
1219
+ $ fonoster workspaces:list
1220
+ ```
1221
+
1222
+ _See code: [dist/commands/workspaces/list.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/workspaces/list.js)_
1223
+
1224
+ ## `fonoster workspaces:login`
1225
+
1226
+ link a Workspace to the local environment
1227
+
1228
+ ```
1229
+ USAGE
1230
+ $ fonoster workspaces:login [-i]
1231
+
1232
+ FLAGS
1233
+ -i, --insecure allow connections to a server with no TLS
1234
+
1235
+ DESCRIPTION
1236
+ link a Workspace to the local environment
1237
+
1238
+ EXAMPLES
1239
+ $ fonoster workspaces:login
1240
+ ```
1241
+
1242
+ _See code: [dist/commands/workspaces/login.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/workspaces/login.js)_
1243
+
1244
+ ## `fonoster workspaces:logout REF`
1245
+
1246
+ unlink a Workspace from the local environment
1247
+
1248
+ ```
1249
+ USAGE
1250
+ $ fonoster workspaces:logout REF
1251
+
1252
+ ARGUMENTS
1253
+ REF the Workspace to unlink from
1254
+
1255
+ DESCRIPTION
1256
+ unlink a Workspace from the local environment
1257
+
1258
+ EXAMPLES
1259
+ $ fonoster workspaces:logout
1260
+ ```
1261
+
1262
+ _See code: [dist/commands/workspaces/logout.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/workspaces/logout.js)_
1263
+
1264
+ ## `fonoster workspaces:use REF`
1265
+
1266
+ set a Workspace as the default
1267
+
1268
+ ```
1269
+ USAGE
1270
+ $ fonoster workspaces:use REF
1271
+
1272
+ ARGUMENTS
1273
+ REF The Workspace to unlink from
1274
+
1275
+ DESCRIPTION
1276
+ set a Workspace as the default
1277
+
1278
+ EXAMPLES
1279
+ $ fonoster workspaces:use
1280
+ ```
16
1281
 
17
- Check the docs [here](https://github.com/fonoster/fonoster/blob/main/docs/early-access/link-twilio-number.md) for more information.
1282
+ _See code: [dist/commands/workspaces/use.js](https://github.com/fonoster/fonoster/blob/v0.8.0/dist/commands/workspaces/use.js)_
1283
+ <!-- commandsstop -->