Cratis CLI: Chronicle inspection and project creation
Cratis CLI gives you the cratis command to inspect Cratis Chronicle from a terminal, discover a running Cratis Arc application’s commands and queries, or create a project. For Chronicle, use it to trace a stale read model back through observer state and recorded events, including when you are connected over SSH.
Start here
Section titled “Start here”Follow Getting started for the installation-to-connection tutorial. Once connected, use the Chronicle command reference for lookup or the operational scenarios for a specific investigation. To create an application instead, start with project creation.
Why use the CLI
Section titled “Why use the CLI”A read model is the state your application queries. If it looks stale, you need to know whether the expected events arrived and whether an observer, the process that handles those events, stopped. cratis chronicle diagnose checks the connection, observer state, failed partitions, and recommendations in one report. A failed partition identifies the part of an observer’s work that failed; the scenarios take you from that report to the recorded failure and the next investigation command.
When you work with more than one server, save each connection as a named context. Switching contexts saves retyping the URL. Before replaying or changing data, confirm your permissions, the selected event store, namespace, target, current state, and documented operational procedure.
Install
Section titled “Install”For prerequisites and the full installation procedure, follow the getting-started tutorial. These are the package-manager commands for quick reference.
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”For your first connection check, follow Getting started. Connection strings and context files can contain credentials; keep them out of source, public issues, and shared logs.
For a named development connection, the context and diagnostic commands are:
-
Create a named Chronicle connection context.
Create a development context cratis context create dev --server chronicle://localhost:35000 -
Select that context.
Select the context cratis context set dev -
Check the connection and processing state.
Inspect Chronicle health cratis chronicle diagnose
Read the report for failed checks, then follow the command it names or choose a scenario for the problem you are investigating. Use command help for the options and output available in your installed CLI version.
Before scripting a command, select an output format and bind your parser to the CLI version you use. Output formats can change between versions.
Product relationship
Section titled “Product relationship”If you prefer a browser, Chronicle Workbench is bundled with Chronicle for authorized local inspection of runtime state and for trying supported projection behavior. Use the CLI for terminal inspection and diagnosis of that same runtime.
For application endpoint discovery, cratis arc reads a running Arc application’s HTTP catalogs without a Chronicle connection. To start a project, cratis new creates application files from a template and attempts to synchronize the template’s configured Cratis AI guidance. Neither step is required for inspecting Chronicle.
Continue
Section titled “Continue”Check the CLI repository for source and releases, or the Cratis.Cli package for published .NET tool versions. Product documentation covers Chronicle and Arc; the command groups above link to their CLI workflows.