open-index/open-npm huggingface dataset:
npm package: @shopify/cli-plugin-ngrok
Description: Enables the creation of ngrok tunnels from `shopify app dev`, allowing previews from any device
Latest version: 0.1.0

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](https://dashboard.ngrok.com/signup) account

## Installation

```bash
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](https://dashboard.ngrok.com/get-started/your-authtoken)
and run this command to save it:
```bash
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:

```bash
shopify app dev
```

Alternatively, you can manually start a new tunnel on a custom port:
```bash
shopify tunnel start -p 3001
```

## Run tests

```bash
yarn test
```

or

```bash
npm test
```