Metadata-Version: 2.1
Name: ngrok-info
Version: 1.1.5
Summary: Easy and fast tool written in python 3 to get info about running ngrok tunnel
Home-page: https://github.com/HexagonCore/get-ngrok-tunnel-info
Author: Hexagon Core Development
Author-email: mp3martin.developer@gmail.com
License: MIT
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`<br/> ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎`ngrok_info.get()`
        	
        * ### Linux
        	Add this to your script: `import ngrok_info`<br/> ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎`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()`
        
        ### ‎
        
        ## 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](https://ngrok.com/docs#tunnel-definitions). You need to specify it only, if you are using [config file](https://ngrok.com/docs#config-default-location) to specify tunnel preset. If you've checked everything, but it's still not working, contact [us on Discord](https://discord.gg/agREa6Dh3r) or [open issue](https://github.com/HexagonCore/get-ngrok-tunnel-info/issues/new/choose).
        ### ‎
        
        
        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
Platform: UNKNOWN
Description-Content-Type: text/markdown
