Skip to main content

​
Install

Follow the Agent CLI Quickstart or visit the download page to install and set up the ngrok agent.

​
System requirements

​
Supported platforms

The ngrok Agent CLI runs on all major platforms including Linux, MacOS, Windows, and most CPU architectures. See the ngrok agent download page for details. It’s also distributed as a Docker container. If the Agent CLI does not run on your target platform, you can still use ngrok via the Agent SDKs or the SSH Reverse Tunnel Agent.

​
Resource requirements

The ngrok Agent CLI is lightweight enough to run most everywhere, even on many embedded platforms. Its resource usage depends on how much concurrent traffic you drive through it. If you have stricter resource requirements, you can still use ngrok via the Agent SDKs or the SSH Reverse Tunnel Agent.
You can reduce memory usage in the ngrok agent by disabling inspection in the configuration file.

​
Tab completion

The ngrok agent has built-in tab completion which makes it easy to navigate its command and flags by hitting tab in your terminal when using a bash or zsh shell. Add tab-completion to your shell session with:
Install it permanently by following the documentation for the ngrok completion command.

​
Updates

The ngrok agent can update itself even if you didn’t install it with a package manager. Update the ngrok agent with the ngrok update command.
By default, the ngrok agent automatically checks for available updates when it runs. If an update is available, it will prompt you to update by pressing Ctrl+U. You can configure whether the agent checks for updates via the update_check config parameter. You can configure which release channel (for example, stable, beta) the agent uses for updates via the update_channel config parameter.