Skip to content

πŸ”Œ Script that allows you to create all types of remote connections using Ngrok

License

Notifications You must be signed in to change notification settings

IgorKowalczyk/ngrok-cli

Repository files navigation

Ngrok CLI


✨ 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 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) (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

example.mp4

⁉️ Issues

If you come across any errors or have suggestions for improvements, please create a new issue here and describe it clearly.

πŸ“₯ Pull Requests

When submitting a pull request, please follow these steps:

  • Clone this repository 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 on GitHub and clearly describe the feature or fix you are proposing.

πŸ“‹ License

This project is licensed under the MIT. See the LICENSE file for details


This script is an independent project and is not affiliated, endorsed, or associated with Ngrok in any way.