BoxLang 🚀 A New JVM Dynamic Language Learn More...

CommandBox Ngrok

v2.0.0 CommandBox Modules


Ngrok integration with CommandBox

Ngrok is a service that will proxy a locally-running server to the Internet where any coworker, friend, or client with a browser can view the local site site you have running. Use this to demo a new site or ask a friend to look at an error for you. This is also great for testing integration with 3rd party systems (like Stripe webhooks) while still developing on localhost!


Use the commands that come with this module to start and stop Ngrok shares.

Start a share

server share start
# or

It will:

  1. Start the CommandBox server if it is not already running.
  2. Start Ngrok using the embedded binaries for your platform.
  3. Stop any currently open Ngrok tunnels (since the free version only allows one at a time).
  4. Create the new Ngrok tunnel.
  5. Display the share url.
  6. Open the share url in the browser.

Stop a share

server share stop
# or

If you stop a server that is being shared, the Ngrok tunnel will be closed for you.

$ box install box-ngrok

No collaborators yet.
5.00 / 2
  • {{ getFullDate("2016-11-08T12:19:54Z") }}
  • {{ getFullDate("2023-02-16T20:17:23Z") }}
  • 9,871
  • 516