CLI overview

The elmah.io CLI lets you execute common tasks against elmah.io.

Installing the CLI

The elmah.io CLI can be installed in several ways. To set up everything automatically, execute the following script from the command line:

dotnet tool install --global Elmah.Io.Cli

or make sure to run on the latest version if you already have the CLI installed:

dotnet tool update --global Elmah.Io.Cli

If you prefer downloading the CLI as a zip you can download the latest version from GitHub. To clone and build the CLI manually, check out the instructions below.

Run the CLI

The CLI supports a range of root commands. Some commands execute an action directly while others open up for a range of sub-commands related to the root command.

Run the CLI to get help:

elmahio --help

Help similar to this is outputted to the console:

Description:
  CLI for executing various actions against elmah.io

Usage:
  elmahio [command] [options]

Options:
  --nologo        Doesn't display the startup banner or the copyright message
  -?, -h, --help  Show help and usage information
  --version       Show version information

Commands:
  login        Authenticate with elmah.io and store your API key locally
  logout       Remove the locally stored elmah.io API key
  deployments  Work with deployments
  diagnose     Diagnose potential problems with an elmah.io installation
  logs         Work with logs
  messages     Work with log messages

(deprecated commands have been left out for better overview)

Cloning the CLI

Create a new folder and git clone the repository:

git clone https://github.com/elmahio/Elmah.Io.Cli.git

Building the CLI

Navigate to the root repository of the code and execute the following command:

dotnet build

This article was brought to you by the elmah.io team. elmah.io is the best error management system for .NET web applications. We monitor your website, alert you when errors start happening, and help you fix errors fast.

See how we can help you monitor your website for crashes Monitor your website