Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.94 KB

README.md

File metadata and controls

67 lines (43 loc) · 1.94 KB
Raw

Heroku-audit

CIPyPI PyPI - Python Version PyPI - Wheel PyPI - Status PyPI - License

Command-line tool for reporting on specific attributes of a Heroku environment.

Components

  • Apps
  • Users
  • Environment Variables
  • Heroku Postgres
  • Heroku Data for Redis

Installation

PyPI

pip install heroku-audit

Homebrew

Heroku Audit can be installed from Torchbox's Homebrew tap.

brew tap torchbox/tap
brew install heroku-audit

Arch Linux

Arch users can install heroku-audit from the AUR.

paru -S heroku-audit

Pre-compiled binaries

You can download the pre-compiled binary from the releases, built with pyinstaller.

Usage

Note: See heroku-audit --help for further details.

Authentication is handled through the $HEROKU_API_KEY environment variable, which must be set to a valid Heroku API key. Alternatively, you can create a config.env file in the config directory (heroku-audit --show-config-dir).

Each components is its own sub-command, containing a number of pre-made reports. heroku-audit --list will list all available commands.

To audit for a single team, add --team=<team>.

Output Format

By default, a pretty table is output, for easy consumption by humans. --format can be specified to all commands to change the format:

  • table (Default)
  • csv
  • json
  • count

Progress output is automatically removed when running non-interactively.