Skip to main content
Groundhog stores changes from connected systems as a durable, ordered event history. It serves ingest, replay, follow, stream enumeration, and source lifecycle over a Unix socket. Groundhog stores and serves the durable event log. Applications build their own derived views from replay or follow. Groundhog 0.2 does not include local SQL or a warehouse.

​
Start here

  • Getting started covers installation, ingest, replay, follow, streams, and verification.
  • Groundhog 0.2.0 lists breaking changes and the upgrade procedure.
  • Commands documents each command accepted by the binary.
  • HTTP API documents the log API, limits, errors, and retry behavior.
  • Deployment operations explains supervision, maintenance, backup, and upgrade.
  • Python SDK documents the synchronous Unix and HTTPS client.

​
Manual organization

  • Use Groundhog covers the CLI and HTTP API.
  • Understand the system explains events and durable storage.
  • Operate a deployment covers configuration, supervision, verification, recovery, backup, and upgrade.
  • Reference provides concise CLI and SDK details.

​
Published contract

The private canonical source repository publishes the public Groundhog contract and compatibility vectors. Do not edit the public copies directly. Use groundhog --help, groundhog <COMMAND> --help, and groundhog --version to inspect the installed binary.