https://github.com/igorkowalczyk/ngrok-cli
🔌 Script that allows you to create all types of remote connections using Ngrok
https://github.com/igorkowalczyk/ngrok-cli
connection http ngrok remote ssh tcp tunnel
Last synced: 10 months ago
JSON representation
🔌 Script that allows you to create all types of remote connections using Ngrok
- Host: GitHub
- URL: https://github.com/igorkowalczyk/ngrok-cli
- Owner: IgorKowalczyk
- License: mit
- Created: 2022-02-21T13:40:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T10:32:08.000Z (10 months ago)
- Last Synced: 2025-04-13T17:18:03.763Z (10 months ago)
- Topics: connection, http, ngrok, remote, ssh, tcp, tunnel
- Language: TypeScript
- Homepage: https://ngrok.com/
- Size: 1.25 MB
- Stars: 8
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.md
- Codeowners: .github/codeowners
Awesome Lists containing this project
README
---
## ✨ Features
- 🚀 Easy usage with select menus and dynamic text inputs
- 🌆 Auto-generated SSH command for easy access
- 📝 Support for all protocols (`HTTP`, `HTTPS`, `TCP`, `TLS`)
- 🌎 Support for all regions (`US`, `EU`, `AU`, `ASIA`, `SA`, `JP`, `IN`)
## 🗜️ Usage
1. Clone [this repository](https://github.com/igorkowalczyk/ngrok-cli) `git clone https://github.com/IgorKowalczyk/ngrok.git` and `cd` into the directory
2. Run `pnpm i` to install all dependencies
3. Copy `.env.example` to `.env` file
4. Fill `.env` file with Ngrok token (you can get it [here](https://dashboard.ngrok.com/get-started/setup)) (`NGROK_TOKEN`)
5. Change `config.ts` default values (optional). You can change the default region, protocol, and ports.
6. Run `pnpm start` to start the script and follow the instructions
> [!NOTE]
> You can also use `npm` or `yarn` instead of `pnpm`
## 📹 Example
https://github.com/IgorKowalczyk/ngrok-cli/assets/49127376/9a1babc2-0600-4135-bd52-1c8ed6aacf46
## ⁉️ Issues
If you come across any errors or have suggestions for improvements, please create a [new issue here](https://github.com/igorkowalczyk/ngrok-cli/issues) and describe it clearly.
## 📥 Pull Requests
When submitting a pull request, please follow these steps:
- Clone [this repository](https://github.com/igorkowalczyk/ngrok-cli) `https://github.com/IgorKowalczyk/ngrok-cli.git`
- Create a branch from `main` and give it a meaningful name (e.g. `my-awesome-new-feature`).
- Open a [pull request](https://github.com/igorkowalczyk/ngrok-cli/pulls) on [GitHub](https://github.com/) and clearly describe the feature or fix you are proposing.
## 📋 License
This project is licensed under the MIT. See the [LICENSE](https://github.com/igorkowalczyk/ngrok/blob/master/license.md) file for details
---
This script is an independent project and is not affiliated, endorsed, or associated with Ngrok in any way.