@mqarty/plugin-dev-phone 1.0.0-beta.10

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 ADDED
@@ -0,0 +1,56 @@
1
+ # plugin-dev-phone
2
+
3
+ A Twilio CLI Plugin for the Twilio Dev Phone.
4
+
5
+ ![A mock-up of the Dev Phone UI](https://user-images.githubusercontent.com/8594375/162187067-33f8e50e-64f9-4bd0-8cdb-ac10b2ff9b63.png)
6
+
7
+ ## Using the Dev Phone
8
+
9
+ To use the Dev Phone, you'll need to first have [an up-to-date installation of the Twilio CLI](https://www.twilio.com/docs/content-snippets/twilio-cli-snippets/twilio-cli-installation), as well as access to a spare Twilio phone number. That means that [you'll need an upgraded Twilio account](https://support.twilio.com/hc/en-us/articles/223183208-Upgrading-to-a-paid-Twilio-Account?_ga=2.24955578.160882329.1650457443-360531395.1625234680), not a trial account.
10
+
11
+ Once you've installed the Twilio CLI, you're ready to add the Dev Phone plugin with the following command:
12
+
13
+ `twilio plugins:install @mqarty/plugin-dev-phone`
14
+
15
+ Once it's installed, you can run the Dev Phone with the following command:
16
+
17
+ `twilio dev-phone`
18
+
19
+ Check out the [Dev Phone documentation](https://www.twilio.com/docs/labs/dev-phone) to learn more about installing and using the Dev Phone.
20
+
21
+ ## Commands
22
+ <!-- commands -->
23
+ * [`twilio dev-phone`](#twilio-dev-phone)
24
+
25
+ ## `twilio dev-phone`
26
+
27
+ Dev Phone local express server
28
+
29
+ ```
30
+ USAGE
31
+ $ twilio dev-phone [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-f
32
+ --phone-number <value>] [--headless] [--clear] [--port <value>]
33
+
34
+ FLAGS
35
+ -f, --force Optional. Forces an overwrite of the phone number configuration.
36
+ -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
37
+ -o=(columns|json|tsv|none) [default: columns] Format of command output.
38
+ -p, --profile=<value> Shorthand identifier for your profile.
39
+ --clear Optional. Remove all dev-phone resources from your account before starting the
40
+ dev-phone.
41
+ --headless Optional. Prevents the UI from automatically opening in the browser.
42
+ --phone-number=<value> Optional. Associates the Dev Phone with a phone number. Takes a number from the
43
+ active profile on the Twilio CLI as the parameter.
44
+ --port=<value> Optional. Configures the port of the Dev Phone UI. Takes a valid port as a parameter.
45
+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
46
+
47
+ DESCRIPTION
48
+ Dev Phone local express server
49
+ ```
50
+
51
+ _See code: [src/commands/dev-phone.ts](https://github.com/mqarty/dev-phone/blob/1.0.0-beta.10/src/commands/dev-phone.ts)_
52
+ <!-- commandsstop -->
53
+
54
+ ## Working on this plugin
55
+
56
+ Notes for folks working on this plugin are in [DEVELOPMENT.md](DEVELOPMENT.md).