Skip to content

VS Code extension (Narrator)

Tools

Explore Chronicle from your editor

When you’re deep in a slice and something looks wrong, the question is usually “what’s actually in the event log?” Narrator answers it without a context switch: it adds a Chronicle Explorer to the VS Code activity bar, so you can browse your event store, page through a sequence, and inspect event and read-model schemas right next to the code you’re writing.

Narrator is published on the Visual Studio Marketplace as Narrator – Chronicle Explorer (publisher cratis).

  1. Open the Extensions view in VS Code (⇧⌘X / Ctrl+Shift+X).

  2. Search for Narrator and install Narrator – Chronicle Explorer by Cratis — or install it from the Marketplace listing.

  3. Open the Narrator icon in the activity bar. It connects to your active Chronicle context on startup.

The source lives at github.com/Cratis/Narrator.

Narrator reads the same configuration the CLI uses~/.cratis/config.json — so if you’ve already pointed the CLI at a store, the extension just works. A config looks like:

{
"activeContext": "default",
"contexts": {
"default": {
"server": "chronicle://localhost:35000",
"managementPort": 8080
}
}
}

It auto-connects to the active context on startup and watches the file, reloading when it changes. To use a config in a non-standard location, set the narrator.configPath setting; leave it empty to auto-detect from ~/.cratis/config.json.

A Details pane sits below the explorer and shows the selected node’s context and content as key/value tables — so selecting an event or read model shows its data inline.