Get ngrok tunnel info
Easy and fast tool written in python 3 to get info about running ngrok tunnel. Supports HTTPS and TCP
Installation
-
python3 -m pip install ngrok_info
Usage
-
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
andngrok_info.port
.With https tunnel, you can acess these variables:
ngrok_info.tnl_name
,ngrok_info.tnl_type
,ngrok_info.address
andngrok_info.ip
.⚠️ Thengrok_info.get()
andngrok_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
-
python3 -m pip uninstall ngrok-info
FAQ
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