https://github.com/philnash/ngrok-for-vscode

🚇 A VSCode extension to control ngrok from the command palette
https://github.com/philnash/ngrok-for-vscode

ngrok typescript vscode vscode-extension

Last synced: 28 days ago
JSON representation

🚇 A VSCode extension to control ngrok from the command palette

• Host: GitHub
• URL: https://github.com/philnash/ngrok-for-vscode
• Owner: philnash
• License: mit
• Created: 2020-04-11T07:19:52.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-10T09:08:57.000Z (6 months ago)
• Last Synced: 2025-03-29T12:06:52.191Z (about 1 month ago)
• Topics: ngrok, typescript, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 2.68 MB
• Stars: 117
• Watchers: 5
• Forks: 15
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
ngrok for vscode

  
A VSCode extension for controlling ngrok from the command palette.

  


    

    

    

  

  


  
If you enjoy using this extension, please consider sponsoring it on GitHub

  


  




## Features

- `ngrok: start`: Start an HTTP tunnel pointing to a port of your choice from the command palette

  ![Open the command palette, type 'ngrok: start' and then type the port number](images/start.gif)

  You can choose to copy the URL to the clipboard, open it in a browser or even generate a QR code so that you can easily open it on a mobile device

  ![When you start a tunnel, you can choose to show a QR code which can be scanned by a mobile device](images/start-qr.gif)

- `ngrok: start`: Start a named HTTP tunnel from your ngrok config

  ![Open the command palette, type 'ngrok: start' and choose the tunnel from your config.](images/start-named.gif)

- `ngrok: stop`: Stop one or all HTTP tunnels

  ![Open the command palette, type 'ngrok: stop' and choose the tunnel you want to stop, or choose 'All' to stop all tunnels](images/stop.gif)

- `ngrok: dashboard`: Open the ngrok dashboard

## Extension Settings

This extension contributes the following settings:

- `ngrokForVSCode.configPath`: set a custom path to your ngrok config

## Release Notes

### [1.10.0](https://github.com/philnash/ngrok-for-vscode/compare/v1.9.2...1.10.0)

#### Changed

- Updated dependencies

- Allowed for start and stop commands to receive arguments from other extension. Fixes #21

See the [CHANGELOG](CHANGELOG.md) for all release notes.

## Contributors

### Author

**Phil Nash** - [GitHub](https://github.com/philnash) • [Website](https://philna.sh) • [Twitter](https://twitter.com/philnash)

### Other contributors

- **Michał Mrozek** - [GitHub](https://github.com/Michsior14)

- **Zack Radisic** - [GitHub](https://github.com/zackradisic)

### Thanks

Thanks go to:

- [Alan Shreve](https://github.com/inconshreveable) and [contributors](https://github.com/inconshreveable/ngrok/graphs/contributors) for [ngrok](https://ngrok.com)

- [Alex Bubenshchykov](https://github.com/bubenshchykov) and [contributors](https://github.com/bubenshchykov/ngrok/graphs/contributors) for the [Node.js wrapper for ngrok](https://github.com/bubenshchykov/ngrok).