ngrok-info

Get ngrok tunnel info

Easy and fast tool written in python 3 to get info about running ngrok tunnel. Supports HTTPS and TCP

---

‎

Installation

• Windows / macOS / Linux

  Run python3 -m pip install ngrok_info

‎

Usage

• Windows / macOS / Linux

  Add this to your script:

  import ngrok_info
  ngrok_info.get()
  

  Now, if you run it, you will see output with some info. If ngrok is not running on your computer, it will output error. After you run it, you can acess the info as variables too!

  If you are using config file to specify the tunnel preset, use ngrok_info.get("TUNNEL_NAME") (Replace TUNNEL_NAME with your tunnel name. Please do not remove the quotation marks.)

  If you do not want to print output, but only variables, use ngrok_info.get_notext()

  If the tunnel is TCP, you have access these variables: ngrok_info.tnl_name, ngrok_info.tnl_type, ngrok_info.address, ngrok_info.ip and ngrok_info.port.

  With https tunnel, you can acess these variables: ngrok_info.tnl_name, ngrok_info.tnl_type, ngrok_info.address and ngrok_info.ip.

  ⚠️ The ngrok_info.get() and ngrok_info.get_notext() functions do not return anything when executed! ⚠️

  Do you want to be reminded to update the package? Run ngrok_info.allow_update() RIGHT AFTER importing the package.

‎

Uninstallation

• Windows / macOS / Linux

  Run python3 -m pip uninstall ngrok-info

‎

FAQ

• Error: wrong tunnel name specified or no tunnel is running

  Check if ngrok is really running on your computer. If yes, check if you have correctly specified the tunnel name. You need to specify it only, if you are using config file to specify tunnel preset. If you've checked everything, but it's still not working, contact us on Discord or open an issue.

‎

Do you like this? Hit that ⭐!
Use the star button as way to show us, that it works
Forks and pull requests are welcome of course