Everything you need to get started.

Setup guides and documentation to help you get the most out of CmdRunner.

🚇

Ngrok Setup Guide

Learn how to connect your staging app to CmdRunner using Ngrok. Create a secure tunnel, get a public URL, and start testing in minutes.

→ Signing up for Ngrok
→ Installing and configuring Ngrok
→ Running the tunnel and connecting to CmdRunner
→ Troubleshooting connection issues

Jump to the guide ↓

Connect your staging app using Ngrok.

If your staging server isn't publicly accessible, you can use Ngrok to create a secure tunnel so CmdRunner can reach it. Follow these steps to get started.

Sign up for Ngrok

Head to ngrok.com and click on Sign up. The sign up process takes just 30 seconds — you can also sign up with a GitHub or Google account. Signing up is free.

Install Ngrok on your computer

After signing up, follow the instructions on the Ngrok setup page to install it.

Mac:

brew install ngrok

Linux:

curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok.asc \
  | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null \
  && echo "deb https://ngrok-agent.s3.amazonaws.com buster main" \
  | sudo tee /etc/apt/sources.list.d/ngrok.list \
  && sudo apt update \
  && sudo apt install ngrok

Windows:

choco install ngrok

Or download the executable from the Ngrok website.

Set your auth token

Once installed, add your Ngrok authentication token. You'll find the command with your token on the Ngrok setup page.

ngrok config add-authtoken YOUR_AUTH_TOKEN_HERE

Run the Ngrok tunnel

Run the following command to start a tunnel pointing at your staging server URL (protocol, host and port).

ngrok http STAGING_URL --host-header=rewrite

For example, if your staging server runs on staging.yourapp.com:8080:

ngrok http http://staging.yourapp.com:8080 --host-header=rewrite

Note: Use the full staging URL — protocol, domain and port. Don't add a path. If your staging server is behind a firewall or on a private network, Ngrok will create the public tunnel endpoint for it.

Give CmdRunner the Ngrok URL

In your test case file, mention the Ngrok Forwarding URL that Ngrok gives you after starting the tunnel. Copy it from the Ngrok terminal output.

Ngrok Forwarding URL:

https://a123-45-678-90-123.ngrok-free.app

Now you can upload the test case file to CmdRunner and it will have access to your staging environment.

Important: The Ngrok tunnel must be running while CmdRunner is performing the tests.

That's it! ✅

Your Ngrok tunnel is running and CmdRunner can reach your staging app. Head back to the app and run your first test.

Troubleshooting

"Connection refused" or timeout

Make sure your staging server is running and accessible before starting the Ngrok tunnel. Double-check the URL and port number match (e.g. 8080, 3000, 5000).

Ngrok tunnel not starting

Verify your auth token is set correctly with ngrok config add-authtoken. You can check your auth status on the Ngrok dashboard.

Page loads but CmdRunner can't interact

Your app may require authentication. Make sure the pages you want to test are accessible, or provide the necessary credentials in your test run configuration.