Skip to main content

CLI for haluguard — verify LLM output for hallucinations from your terminal or CI/CD.

Project description

haluguard CLI

PyPI version License

Verify LLM output for hallucinations directly from your terminal or CI/CD pipeline. Plugs into the haluguard hosted API.

Install

pip install haluguard

Zero runtime dependencies — pure stdlib, installs in seconds.

Quick start

# 1. Save your API token (get one at haluguard.com)
haluguard auth login

# 2. Verify a file
haluguard check report.md

# 3. Or pipe input
echo "Microsoft was founded in 1981 by Bill Gates." | haluguard check

# JSON output for scripts / CI
haluguard check report.md --json | jq .

# Exit non-zero only above a confidence threshold (useful in CI)
haluguard check report.md --threshold 0.7

Output

Human-readable by default:

✗ HALLUCINATIONS    severity=clear  score=0.95  claims=1/2  latency=4ms
verdict source: data_contradicted

  [CONTRADICTED] high · wikidata
    claim:    Microsoft was founded in 1981
    evidence: Wikidata confirms Microsoft was founded in 1975
    source:   https://www.wikidata.org/wiki/Q2283
    fix:      1975

--json returns the raw API response (verdict, severity_tier, score, findings, etc).

Exit codes

Code Meaning
0 Clean / no hallucinations above threshold
1 Hallucinations detected
2 Transient API error (rate-limited, 5xx, network)
3 Auth error (no token / invalid token)
4 Bad input / usage

CI/CD example — GitHub Actions

- name: Verify generated docs
  env:
    HALUGUARD_TOKEN: ${{ secrets.HALUGUARD_TOKEN }}
  run: |
    pip install haluguard
    haluguard check generated/release-notes.md --threshold 0.7

For a dedicated GitHub Action with richer output, see haluguard-action.

Env vars

Var Default Purpose
HALUGUARD_TOKEN (required) Bearer token. Used in CI. Overrides ~/.haluguard/config.json.
HALUGUARD_API_URL https://api.haluguard.com Override for self-host / dev.
NO_COLOR unset Disable ANSI colors.

License

MIT (the CLI itself). The hosted API behind it is a paid subscription service — see haluguard.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

haluguard-0.1.0.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

haluguard-0.1.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file haluguard-0.1.0.tar.gz.

File metadata

  • Download URL: haluguard-0.1.0.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for haluguard-0.1.0.tar.gz
Algorithm Hash digest
SHA256 85ba4674fff422538a09720df9a0a3bff5c1db887cac96d7e57e427605496be1
MD5 345ff13febbe9592bae029cb85aae8c6
BLAKE2b-256 b23b13cb404df808410e080ab5f53cb88cdb7b147caac82252ee6c253d0f8621

See more details on using hashes here.

File details

Details for the file haluguard-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: haluguard-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for haluguard-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 568f4dcd9163cc624748f3a6bd192226d99c993c04fe391c768445d9ab5a6751
MD5 d314d115827fa443766eaba31bf4d8fe
BLAKE2b-256 ab7266a0ed8314bff8b20decdf4e9ff83c740f0dadeea406ad2965dbec2f7286

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page