Skip to main content

Name

groundhog: maintain and serve a durable append-only event log.

Synopsis

Description

groundhog is one local binary with a durable event log and a Unix-socket HTTP service. Connectors append source changes. Applications replay events, follow new commits, enumerate streams, and build their own derived views. One groundhog.toml file selects a deployment. The event log is the durable record and uses storage schema version 1.

Global option

--config <PATH> selects the configuration file. The default is ./groundhog.toml. Every command except init loads this file. init accepts the global option but writes <DIR>/groundhog.toml instead.

Commands

Groundhog 0.2 removes project and rebuild.

Ownership

Only one process can own the writer.

Standard streams

Lifecycle output and diagnostics use standard error. verify writes its machine-readable JSON report to standard output. init, serve, and seal have no machine-readable standard output. Help and version requests write to standard output and exit successfully.

Exit status

Files

Groundhog 0.2 does not create or open warehouse.duckdb. It ignores warehouse files left by Groundhog 0.1.

Configuration

The configuration file sets the data directory, security mode, integrity anchor, server socket, bearer token, and replay limits. Groundhog rejects unknown keys. serve, seal, and verify --chain support only anchor mode none. Plain verify checks storage without enforcing the configured anchor mode. The removed [query] section produces this error:
See Configuration.

HTTP service

serve provides four log API routes: The service does not provide /v1/query or /v1/catalog.

Unsupported surface

The binary does not accept project, rebuild, import, query, catalog, erase-payload, export-key, or verify --clean. It does not provide a TCP listener, local SQL, automatic derived views, payload erasure, key export, external anchors, or governed operation. Use groundhog --help, groundhog <COMMAND> --help, and groundhog --version to inspect an installed build.

Examples

See also

Getting started, configuration, events, storage, deployment operations