diff --git a/README.md b/README.md index de60c1f..610bf39 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ # ngrok-to-dotenv -This is a ngrok start-up wrapper that uses a dotenv file (at '../.env' relative to this project's folder) to get the authtoken and save the https address; it's a node cli tool that you can use with projects that need ngrok. You clone it into your project's folder, and add to the project's package.json a run script to call "cd ngrok-to-dotenv && node ngrok". Be sure to add the folder to your .gitignore and install the one package which is ngrok and command-line-args, using 'npm i' or 'yarn'. The 'node ngrok' script supports two arguments --proto or -p (string, example 'html'), --addr or -a (number, the port number). +This is a ngrok start-up wrapper that uses a dotenv file (at '../.env' relative to this project's folder) to get the authtoken and save the https address; it's a node cli tool that you can use with projects that need ngrok. You clone it into your project's folder, and add to the project's package.json a run script to call "cd ngrok-to-dotenv && node ngrok". Be sure to add the folder to your .gitignore and install the one package which is ngrok and command-line-args, using 'npm i' or 'yarn'. The 'node ngrok' script supports two arguments --proto or -P (string, the protocol), --port or -p (number, the port number). + +By default 'node ngrok' (no arguments) is equivalent to 'node ngrok -P http -p 3000' and 'node ngrok --proto http --port 3000'. \ No newline at end of file diff --git a/ngrok.js b/ngrok.js index bac8ee4..25a8410 100644 --- a/ngrok.js +++ b/ngrok.js @@ -5,8 +5,8 @@ const { exec } = require("child_process"); const dotenvFile = "../.env"; const optionDefinitions = [ - { name: "proto", alias: 'p', type: String }, - { name: "addr", alias: 'a', type: Number }, + { name: "proto", alias: 'P', type: String }, + { name: "port", alias: 'p', type: Number }, ]; const commandLineArgs = require("command-line-args");