Skip to content

🚇 A VSCode extension to control ngrok from the command palette

License

Notifications You must be signed in to change notification settings

philnash/ngrok-for-vscode

Repository files navigation

ngrok for vscode

A VSCode extension for controlling ngrok from the command palette.

Visual Studio Marketplace Version GitHub Actions CI status SonarCloud Maintainability Rating


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

Sponsor this project 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

    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

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

  • 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

  • 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

Changed

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

See the CHANGELOG for all release notes.

Contributors

Author

Phil Nash - GitHub • Website • Twitter

Other contributors

Thanks

Thanks go to: