Getting Started

Install

Current release:

python -m pip install groundguard-ai

Development install:

git clone https://github.com/chasen2041maker/GroundGuard.git
cd GroundGuard
python -m pip install -e ".[dev]"
python -m pytest

Run the Demo

Create starter files for a CI fact gate:

groundguard-init --template github-action

groundguard-demo

Expected signal:

Before GroundGuard correction: passed False, omitted_required 2
After fact-key correction: passed True, verified 2

Run the packaged benchmark:

groundguard-benchmark

Use a Config File

required_facts:
  - revenue_2025
  - net_profit_2025
policy:
  on_unverified: block
  max_unverified_ratio: 0.0
report:
  schema: assertion
  fail_on_policy: true

groundguard-report \
  --config groundguard.yml \
  --ledger-jsonl facts.jsonl \
  --answer-file answer.txt