Skip to content

Commit b78a1f8

Browse files
committed
docs(twilio-run:start): document custom ngrok subdomains
1 parent 0599b5f commit b78a1f8

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

packages/twilio-run/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,9 @@ twilio-run --inspect
151151

152152
# Exposes the Twilio functions via ngrok to share them
153153
twilio-run --ngrok
154+
155+
# Exposes the Twilio functions via ngrok using a custom subdomain (requires a paid-for ngrok account)
156+
twilio-run --ngrok=subdomain
154157
```
155158

156159
### `twilio-run deploy`
@@ -318,7 +321,7 @@ Error: What?
318321
at next (/Users/dkundel/dev/twilio-run/node_modules/express/lib/router/route.js:131:14)
319322
```
320323

321-
In general you'll want to use the cleaned-up stack trace since the internals might change throughout time.
324+
In general you'll want to use the cleaned-up stack trace since the internals might change throughout time.
322325

323326

324327

packages/twilio-run/src/commands/start.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ export const cliInfo: CliInfo = {
138138
},
139139
ngrok: {
140140
type: 'string',
141-
describe: 'Uses ngrok to create and outfacing url',
141+
describe:
142+
'Uses ngrok to create a public url. Pass a string to set the subdomain (requires a paid-for ngrok account).',
142143
},
143144
logs: {
144145
type: 'boolean',

0 commit comments

Comments
 (0)