heimdallgov 0.1.0

Heimdall Federal Intelligence Platform — command-line client

heimdallgov

Heimdall is a federal oversight data platform, delivered through a CLI and an MCP server. This package (heimdallgov on PyPI, installs the heimdall command) is the CLI client — it talks to the Heimdall API (https://api.heimdallgov.com) to search oversight findings, look up contractor profiles, and pull compliance intel.

Install

pip install heimdallgov

Requires Python 3.10 or newer.

Authenticate

Get an API key by signing up at https://heimdallgov.com. Then either export it as an environment variable:

export HEIMDALL_API_KEY=hml_sk_...

…or save it with the CLI (stored at your user-config dir, e.g. ~/.config/heimdall/config on Linux, %APPDATA%\heimdall\config on Windows):

heimdall auth login hml_sk_...
heimdall auth whoami

Example commands

Search oversight findings

heimdall findings search cybersecurity --limit 10

Returns recent GAO / Inspector General / FAC findings that mention the keyword, with agency, severity, source, and report number.

Look up a contractor

# Search contractors_master by name
heimdall risk search "Booz Allen"

# Fetch a full profile by UEI
heimdall risk ABCDEF123456

Compliance profile

# Full compliance overview for a UEI
heimdall compliance profile ABCDEF123456

# Federal Audit Clearinghouse timeline
heimdall compliance fac ABCDEF123456 --limit 20

# Program / CFDA exposure
heimdall compliance programs ABCDEF123456

# Latest federal grant opportunities
heimdall compliance opportunities --limit 50

Check subscription / usage

heimdall auth whoami           # tier, status

Output formats

Every command renders a rich terminal table by default. Pipe through jq or use the --format json flag on most commands to get machine-readable output.

Environment variables

Variable	Purpose	Default
HEIMDALL_API_KEY	Bearer token used for every request	(none — required)
HEIMDALL_API_URL	Override the API base (mostly for local dev / QA)	https://api.heimdallgov.com

Full docs

https://heimdallgov.com/docs

License

MIT. Copyright 2026 Heimdall Analytics Corporation.