Honeybadger CLI Reference
The Honeybadger CLI provides a Command Line Interface for various
Honeybadger-related programs and utilities. All features are available through
honeybadger command and can be used independently of Bundler/Rails.
When using the honeybadger gem with Bundler, run
bundle exec honeybadger.
To use outside of bundler, install the Honeybadger gem with
honeybadger and then run
The following commands are available through the
||Notify Honeybadger of deployment|
||Execute a command. If the exit status is not 0, report the result to Honeybadger|
||Describe available commands or one specific command|
||Manage Honeybadger on Heroku|
||Install Honeybadger into a new project|
||Notify Honeybadger of an error|
||Send a test notification from Honeybadger|
For additional info about each command, run
honeybadger command optionally reads configuration from the following
locations. Each location in the list takes precedence over the previous
- Rails/Ruby configuration (only when called from a Rails app root)
- Environment variables
- Command-line flags (i.e.
The following configuration options are used by the CLI when applicable:
env. See Configuration Options
All other options must be passed as command-line flags.
When run from the root of a Rails project, the
honeybadger command will load
the Rails environment so that any framework/programmatic configuration is picked