# node-ngrok-cli

> ✨ NGROK CLI made with NodeJS

Latest version **0.0.2** (published 2021-03-17) · GPL-3.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install node-ngrok-cli
pnpm add node-ngrok-cli
yarn add node-ngrok-cli
bun add node-ngrok-cli
```

Provides the command `ngrok`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-03-17 |
| First published | 2021-03-17 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 94.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Barış DEMİRCİ |
| Maintainers | leydihavuc |
| Keywords | ngrok, node-ngrok, ngrok-cli, tunnel |

## Links

- npm: https://www.npmjs.com/package/node-ngrok-cli
- Repository: https://github.com/barbarbar338/node-ngrok-cli
- Homepage: https://github.com/barbarbar338/node-ngrok-cli#readme
- Issues: https://github.com/barbarbar338/node-ngrok-cli/issues
- npm.io page: https://npm.io/package/node-ngrok-cli

## Dependencies (4)

- [daph](https://npm.io/package/daph.md) ^1.0.1
- [ngrok](https://npm.io/package/ngrok.md) ^3.4.1
- [pogger](https://npm.io/package/pogger.md) ^0.0.8
- [remove-properties](https://npm.io/package/remove-properties.md) ^2.0.0

## Recent versions

- 0.0.2 (latest) — 2021-03-17
- 0.0.1 — 2021-03-17

## README

# ✨ NGROK CLI made with NodeJS

NGROK CLI app made with NodeJS, easy to download and use.

# 📦 Installation

Run `npm i -g node-ngrok-cli` or `yarn global add node-ngrok-cli`. After running this command, you will be able to use `ngrok` command.

# 🐮 Usage

Run `ngrok` command to see all available commands.

To get help about a command, run:

```bash
$ ngrok <command> --help

# example
$ ngrok serve --help
```

Authenticating:

```bash
$ ngrok auth <auth_token>
```

Starting tunnel:

```bash
$ ngrok serve <port> [...options]
```

# 🔑 `serve` Command Options

| Name      | Type   | Required | Default | Description                                       |
| --------- | ------ | -------- | ------- | ------------------------------------------------- |
| port      | number | ✔️       | -       | port or network address                           |
| proto     | string | ❌       | http    | http, tcp, tls                                    |
| auth      | string | ❌       | -       | http basic authentication for tunnel              |
| subdomain | string | ❌       | -       | reserved tunnel name https://example.ngrok.io     |
| authtoken | string | ❌       | -       | your authtoken from ngrok.com                     |
| region    | string | ❌       | us      | one of ngrok regions (us, eu, au, ap, sa, jp, in) |

Example:

```bash
$ ngrok serve 3000 --region eu --subdomain example
```

# 🧦 Contributing

Fell free to use GitHub's features.

---
_Source: https://npm.io/package/node-ngrok-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
