@fonoster/ctl 0.7.57 → 0.8.2

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