Cratis CLI
CLI
Inspect and diagnose Chronicle from a terminal
The Cratis CLI provides terminal workflows for inspecting and diagnosing Chronicle. Use the exact CLI version and documented command scope for the environment you inspect.
Start here
Section titled “Start here”Choose a current distribution path for the machine running the terminal.
Connect and inspectCreate a context, select it, and run the bounded diagnostic summary.
Keep the limits visibleSeparate inspection from mutation authority, support, and machine-contract claims.
Install
Section titled “Install”brew tap cratis/cratisbrew install cratisdotnet tool install -g Cratis.CliThe .NET tool requires the runtime declared by the current package. Native release assets and platform coverage vary by release; verify the exact artifact before installation.
Connect and inspect
Section titled “Connect and inspect”-
Create a named Chronicle connection context.
Terminal window cratis context create dev --server chronicle://localhost:35000 -
Select that context.
Terminal window cratis context set dev -
Run the documented diagnostic summary.
Terminal window cratis chronicle diagnose
The diagnostic command reports its documented connection, observer, failed-partition, and recommendation checks. Use command help and the exact CLI version to inspect the current command and output surface.
Product relationship
Section titled “Product relationship”Chronicle Workbench provides a bundled local browser surface for authorized inspection of Chronicle runtime state and preview of supported projection behavior. The CLI provides the terminal inspection and diagnosis path around the same product family.
The CLI also contains separately documented command groups for other Cratis products. Their presence does not establish those products’ maturity, support, compatibility, or availability.
Current boundaries
Section titled “Current boundaries”- Ordinary output formats are not an unversioned stable machine contract.
- Command availability does not establish support, an SLA, reliability, security, compatibility, or production suitability.
- Connection strings and context files can contain credentials; keep them out of source, public issues, and shared logs.
Continue
Section titled “Continue”Repository README, current releases, operational cautions, and contribution paths.
CLI packagePublished .NET tool metadata and versions.
ChronicleThe event-sourcing database and runtime the CLI inspects — kernel, protocol, and runtime documentation.
Chronicle WorkbenchThe bundled browser surface for authorized inspection of Chronicle runtime state.
ArcThe CQRS application framework whose running commands and queries the cratis arc group inspects.