Resources

Everything you need to get started and get help.

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

Ngrok Setup Guide

Learn how to connect your local 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 ↓

Support

Need help with CmdRunner? Whether it's a setup question, a bug report, or feedback on the platform — our team is here for you. Reach out directly and we'll get back to you as quickly as possible.

  • Setup and configuration help
  • Bug reports and issue escalation
  • Feature requests and feedback
  • Enterprise and billing inquiries
support@cmdrunner.com

Setup Guide

Connect your local app using Ngrok.

If your app isn't on a public staging server yet, you can use Ngrok to create a secure tunnel from your local machine. Follow these steps to get started.

1

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.

2

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.

3

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
4

Run the Ngrok tunnel

Run the following command to start a tunnel. You need the URL to your local development environment (protocol, host and port).

ngrok http DEV_ENV_URL --host-header=rewrite

For example, if your app runs on localhost:8080:

ngrok http http://localhost:8080 --host-header=rewrite

Note: The URL doesn't have to be localhost. It can also be a domain or IP on your local network (e.g. http://our-server.local) or on the public internet but behind a firewall. Don't add a path — only protocol, domain and port.

5

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 local development 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 local app. Head back to the app and run your first test.

Troubleshooting

"Connection refused" or timeout

Make sure your local dev server is running before starting the Ngrok tunnel. Double-check the port number matches (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.

Need help?

Still stuck? We're here to help.

Whether it's a setup question, a bug report, or feedback on the platform — reach out to our team and we'll get back to you as quickly as possible.

• Setup and configuration help

• Bug reports and issue escalation

• Feature requests and feedback

• Enterprise and billing inquiries

Email us

support@cmdrunner.com