HG-CLI
Our recommended command line tool that's fun and easy-to-use - for installing and configuring agents in your systems.
Last updated
Was this helpful?
Our recommended command line tool that's fun and easy-to-use - for installing and configuring agents in your systems.
Last updated
Was this helpful?
Contents
Our HG command line tool is an interactive way to install an agent on your system, without ever needing to touch a configuration file! This tool currently supports , with more agents to be added in the future (like ).
Once you've installed HG-CLI, you can run it as a TUI (Terminal User Interface) or in CLI (Command Line Interface) mode. See our list of commands below for all available installation options and command examples.
See our handy blog article for step-by-step details on how to get this up in running in just a couple of minutes.
You can find all current .
Run this command in your terminal (Linux/MacOS/Windows).
This will install the latest released version's binaries into your /usr/local/bin directory.
Add tap:
Install:
Ubuntu/Debian
RedHat/CentOS/Fedora
[Optional] Add to system PATH:
Install using go install
Example:
Download the checksum.txt file from the releases listed assets.
Once HG-CLI is installed, you can run it as a TUI application, or in CLI mode (for automated installs). Below are all available options and command examples for using this tool.
Run the interactive TUI application (recommended):
Run it in CLI mode with the default configuration:
CLI mode for a custom install - to specify which plugins you want:
CLI mode to update an API key in an existing config (telegraf):
To uninstall an agent (telegraf):
Available flags for CLI mode:
--api-key (required)
--plugins (plugins to be added during installation)
--config (config path for updating apikey - required)
--list (list available monitoring agents)
Once you have run the HG-CLI and installed an agent, the terminal output will show you that the installation was successful, which plugins were enabled, where your configuration file is located, and the command needed to start the service (required for collecting and forwarding metrics to your HG account).
Once the agent service has been started, you'll be able to locate your system metrics in our Metrics Search UI (with the telegraf prefix). Once telegraf.* metrics have been sent to your account, a Telegraf dashboard will be automatically created and can be located in your HG account (Dashboards ⇒ Telegraf). This auto-dash offers a great starting point and can be customized further!
If you need help enabling additional plugins or have feedback on the HG-CLI tool, please send us a message: support@metricfire.com
You can use Homebrew to tap and install the HG-CLI packages for MacOS/Linux. This method supports AMD64/ARM64 architectures and the official GitHub tap can be found .
Locate the official release assets , and below are some example installation commands:
Locate the official release assets , and below are some example installation commands:
To manually install, download a preferred version (that matches your OS & ARCH), extract and move the binary file into a desired install location.