Skip to main content

Easy and fast tool written in python 3 to get info about running ngrok tunnel

Project description

Get ngrok tunnel info

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


Instalation

  • Windows / macOS

    Run python3 -m pip install ngrok_info

  • Linux

    Run python3 -m pip install ngrok_info

Usage

  • Windows / macOS

    Add this to your script: import ngrok_info
    ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ngrok_info.get()

  • 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 it is TCP tunnel, you can use ngrok_info.tnl_name, ngrok_info.tnl_type, ngrok_info.adress, ngrok_info.ip and ngrok_info.port. With https tunnel, you can acess ngrok_info.tnl_name, ngrok_info.tnl_type, ngrok_info.adress and ngrok_info.ip. If you do not want output, but only variables, use ngrok_info.get_notext() If you are using config file to specify tunnel preset, use ngrok_info.get("TUNNEL_NAME_HERE_AND_KEEP_QUOTATION_MARKS_HERE").

Uninstallation

  • Windows / macOS

    Run python3 -m pip uninstall ngrok-info

  • 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 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 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ngrok_info-1.1.10.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

ngrok_info-1.1.10-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page