Get ngrok tunnel info
Easy and fast tool written in python 3 to get info about running ngrok tunnel. Supports HTTPS and TCP
Installation
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.ipandngrok_info.port.With https tunnel, you can acess these variables:
ngrok_info.tnl_name,ngrok_info.tnl_type,ngrok_info.addressandngrok_info.ip.⚠️ The
ngrok_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
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
1 maintainer
Release files for ngrok-info 1.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ngrok_info-1.2.4.tar.gz | 4.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ngrok_info-1.2.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.1 kB
Release files / ngrok_info-1.2.4.tar.gz
| Download URL | ngrok_info-1.2.4.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2f3e62cd8ed0ba02537fb29f95119224623f2f6fe692a85250e89682901c87a0
|
|
BLAKE2b-256 checksum How to use checksums |
34cfc870e89794983f8e2e4142323687835494b31766339b2572ae1fdf90ebc2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
Release files / ngrok_info-1.2.4-py3-none-any.whl
| Download URL | ngrok_info-1.2.4-py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0cd32247a56d4fb0d5cbd9766f4683e55dbe712df6d0336c189ab1df3bebe3b1
|
|
BLAKE2b-256 checksum How to use checksums |
bc8f6d4c08f336aff232c9f8fbf7702ac3ed92d6e11936fb886ad55e872b70fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
