Skip to content

Chronicle

The cratis chronicle command group provides the primary interface for interacting with a Chronicle server. Every sub-command connects to a Chronicle management API, authenticates if required, and operates on the event store you specify.

Most commands accept the following connection flags:

FlagDescription
--server <CONNECTION_STRING>Chronicle server connection string. Overrides the active context and the CHRONICLE_CONNECTION_STRING environment variable.
--management-port <PORT>Management API port. Defaults to the port embedded in the connection string.

For the full connection string format, see the Connection reference page.

Commands that operate within a specific event store or namespace accept the following flags:

FlagDescription
-e, --event-store <NAME>Event store name. Defaults to default.
-n, --namespace <NAME>Namespace within the event store. Defaults to Default.
Sub-commandDescription
event-storesList event stores registered on the server.
namespacesList namespaces within an event store.
event-typesList and inspect registered event type definitions.
eventsQuery events from an event sequence or retrieve the tail sequence number.
observersList, inspect, replay, retry, and clear quarantine for observers.
subscriptionsManage cross-event-store subscriptions for event forwarding.
failed-partitionsList and inspect partitions where an observer has failed.
projectionsList and inspect projection definitions.
read-modelsList, query, and inspect read model instances and snapshots.
recommendationsList, perform, and ignore server-generated recommendations.
identitiesList principals that have interacted with the event store.
jobsList, inspect, resume, and stop long-running server-side jobs.
authCheck authentication status.
applicationsManage OAuth client applications authorized to connect to Chronicle.
usersManage human users who can log in to Chronicle.
diagnoseRun a health check against the connected Chronicle server.

All cratis chronicle commands also inherit the top-level global flags:

FlagDescription
-o, --output <FORMAT>Output format: table, plain, json, json-compact.
-q, --quietOutput only key identifiers, one per line. Useful for piping.
-y, --yesSkip confirmation prompts.
--debugEnable verbose debug output.