@shopify/cli-plugin-ngrok
v0.1.0
Published
Enables the creation of ngrok tunnels from `shopify app dev`, allowing previews from any device
Downloads
34
Keywords
Readme
This package contains a Shopify CLI plugin that enables the creation of ngrok tunnels from shopify app dev
,
allowing previews from any device.
Requirements
- Shopify CLI
- Ngrok account
Installation
shopify plugins install @shopify/cli-plugin-ngrok
## Usage
If you don't have your ngrok account configured yet, you can get your token from the ngrok dashboard and run this command to save it:
shopify tunnel auth <TOKEN>
Then, once you run the dev
command, it will automatically create an ngrok tunnel and update your app configuration
in the Partners dashboard to point to the new URL:
shopify app dev
Alternatively, you can manually start a new tunnel on a custom port:
shopify tunnel start -p 3001
Run tests
yarn test
or
npm test