The root command of the ngrok agent.

ngrok [flags]
ngrok [command]

The ngrok api command provides access to ngrok's API. You can use the API through one of the api subcommands.

All api subcommands require an API key. You can configure it either using a flag (ngrok config add-api-key command).

You can get get the initial API key in the API section of the ngrok Dashboard. Additional keys can be created through ngrok api api-key create subcommand.

These commands mirror our standard ngrok HTTP API. If you have shell completion enabled, these will tab complete on the terminal.

ngrok api [flags]

The ngrok completion command generates shell tab completion code for Bash or Zsh. This requires bash-completion or zsh-completions packages to be enabled in your shell.

You can add it to your current session with the command

. <(ngrok completion)

To enable them each time you start a new session, add the following to your .bashrc or .zshrc files:

if command -v ngrok &>/dev/null; then
  eval "$(ngrok completion)"
fi

Once you add this to your profile, you'll need to source ~/.bashrc or source ~/.zshrc to enable it for your current session.

ngrok completion [flags]

The ngrok config command updates or verifies ngrok's configuration file.

Use add-authtoken or add-api-key to set the corresponding properties.

Use check to test a configuration file for validity. If you have an old configuration file, you can also use upgrade to automatically upgrade to the latest version.

ngrok config [flags]

The ngrok config add-api-key command saves the ngrok API key to the configuration file. The API key can be generated in the API section of the ngrok dashboard.

ngrok config add-api-key TOKEN [flags]

ngrok config add-api-key 1roPsn7AascHeO18mHcxRD3xT76_3ww7C9CDLYNgcdSYsscCB

The ngrok config add-authtoken command saves the ngrok authtoken to the configuration file. You can find your authtoken in the getting started section of the ngrok dashboard.

The ngrok service requires that you sign up for an account to use many advanced service features. In order to associate your agent with an account, it must pass a secret token to the ngrok service when it starts up. Instead of passing this authtoken on every invocation, you may use this command to save it into your configuration file so that your agent always authenticates you properly.

ngrok config add-authtoken TOKEN [flags]

ngrok config add-authtoken 1rlHSX3HqrqmOWZdeJ6bIv8rfuo_4cmS1QswRGyxcQD8NOukF

The ngrok config check command checks a configuration file for validity/correctness.

ngrok config check [flags]

The ngrok config edit command opens the configuration file in an editor defined by the EDITOR environment variable, defaulting to nano or Notepad depending on OS.

ngrok config edit [flags]

The ngrok config upgrade command upgrades a configuration file to a specific version.

You can optionally pass a version to upgrade to. If the configuration file version is missing, the upgrade command will add it. It also applies all automatic transformations between versions.

By default this command applies the transformations and display the final file. Use --dry-run to preview changes before applying.

By default this command will not move any configuration files to their new default location. Use --relocate to move the config file to the default location.

ngrok config upgrade [version] [flags]

The ngrok credits command displays the software credits and license information.

ngrok credits [flags]

The ngrok diagnose command runs a series of tests to diagnose potential connectivity issues between the ngrok agent and the remote ngrok service.

ngrok diagnose [flags]

The ngrok help command provides help for any command in the application. Simply type ngrok help [path to command] for full details.

ngrok help [command] [flags]

The ngrok http command is used to start a tunnel listening for HTTP/HTTPS traffic with a specific hostname. The HTTP Host header on incoming public requests is inspected to determine which tunnel it matches.

ngrok http [address:port | port] [flags]

ngrok http 8080                             # forwards provided ngrok URL to port 80
ngrok http example.com:9000                 # forward traffic to example.com:9000
ngrok http --subdomain=bar 80               # request subdomain name: 'bar.ngrok.io'
ngrok http --hostname=www.ex.com 1234       # request tunnel 'www.ex.com' (DNS CNAME)
ngrok http --basic-auth='falken:joshua' 80  # enforce basic auth on tunnel endpoint
ngrok http --host-header=ex.com 80          # rewrite the Host header to 'ex.com'
ngrok http file:///var/log                  # serve local files in /var/log
ngrok http https://localhost:8443           # forward to a local https server

The ngrok service command allows you to run and control an ngrok service on the operating system. For more information about running ngrok as a service, check out the ngrok service section in the secure tunnels documentation.

This command manages installation and execution of ngrok as an operating system service on Windows, MacOS and Linux systems. The service command takes a single argument which must be start, stop, restart, install, or uninstall.

When you choose install, you must specify the config flag which will define where the installed ngrok service looks for its configuration file.

When the ngrok service runs, it has the same behavior as if it were invoked from the command line with the command: ngrok start --all.

ngrok service [flags]

ngrok service install --config=C:\ngrok.yml
ngrok service start
ngrok service stop

The ngrok start command starts tunnels by name from the configuration file. You may specify any number of tunnel names. You may start all tunnels in the configuration file with the --all switch.

ngrok start [flags]

ngrok start dev        # start tunnel named 'dev' in the configuration file
ngrok start web blog   # start tunnels named 'web' and 'blog'
ngrok start --all      # start all tunnels defined in the config file

Use ngrok tcp to start a TCP tunnel which forwards all traffic on a public port to a local address. This is extremely useful for exposing services that run non-HTTP traffic (SSH, SIP, RDP, RTSP, GRPC, game servers, etc).

A TCP tunnel binds a public address on the remote ngrok server. Any services which require a stable public address should use the --remote-addr option. ngrok requires that you reserve a TCP tunnel address for your account before you can use it.

ngrok tcp [address:port | port] [flags]

# forward a port to your local ssh server
ngrok tcp 22

# expose an RDP server on a specific public address that you reserved
ngrok tcp --remote-addr=1.tcp.ngrok.io:27210 3389

The ngrok tls command starts a TLS tunnel listening for traffic on port 443 with a specific hostname. The TLS Server Name Indication (SNI) extension field in the TLS connection is inspected to determine which tunnel it matches.

The ngrok server does not terminate TLS connections forwarded with this command. Any underlying protocol may be used. You may optionally specify a TLS key/cert pair which will be used to terminate the traffic at the ngrok agent before it is forwarded. If not specified, the traffic will be forwarded still encrypted.

Using this command is only recommended with the --hostname option. Other uses will work, but will always result in certificate mismatch warnings.

ngrok tls [address:port | port] [flags]

# forward TLS traffic for www.example.com to port 443 (requires CNAME)
ngrok tls --hostname=www.example.com 443

# forward TLS traffic on subdomain (mismatch certificate warning)
ngrok tls 1234

# terminate TLS traffic for t.co before forwarding
ngrok tls --hostname=t.co --crt=/path/to/t.co.crt --key=/path/to/t.co.key 443

The ngrok tunnel command is used to start labeled tunnels for use with Tunnel Group backends and ngrok Cloud Edges.

Starts a tunnel with labels so that it can be part of a tunnel group. The tunnel group consists of all the tunnels matching all the labels of a tunnel group backend.

# tunnel-group traffic for app=foo may be forwarded to port 80
ngrok tunnel --label app=foo 80

# match tunnel-group with multiple labels
ngrok tunnel --label app=foo --label dc=bar 80

ngrok tunnel [--label key:value] ... [address:port | port] [flags]

The ngrok update command updates ngrok to the latest version.

This command checks the ngrok web service for a newer versions of the ngrok agent. If a newer version is available, it will download it an replace the ngrok binary with the new version after cryptographically verifying the update is safe to apply.

In order to update successfully, the ngrok binary must be in a directory that is writable by your current user. If you placed ngrok in a system path, you may need to run this with root or Administrator privileges.

ngrok update                     - update ngrok to the latest stable version
ngrok update --channel=beta      - update ngrok to the latest beta version

ngrok update [flags]

ngrok version [flags]