cratis-chronicle-client-elixir

The Chronicle client for Elixir

cratis_chronicle is a standalone client SDK. It is a library, not a framework: it starts no supervision tree of its own, you add Chronicle.Client to yours, and everything after that is ordinary OTP.

Verified product sources

Source: Cratis/Chronicle.Elixir (Hex package cratis_chronicle). Source paths below are relative to Source/chronicle/.

Read references/upgrading.md when moving an application from an older client. Requires Elixir ~> 1.18; read references/product-sources.md for the package and contracts dependency facts.

A git tag is not a Hex release. mix deps.get fetches only published versions, and the repository's VERSION file is a build-time placeholder: never quote it. Use namespaced modules (Chronicle.Events.EventType, not Chronicle.EventType); older READMEs got this wrong. Maintained snippets live in Documentation/client-snippets/.

Chronicle.Concept (use Chronicle.Concept, type: :string) is the preferred way to classify a personal value once, mirroring ConceptAs<T>; it requires cratis_chronicle 3.0.0, and an older client annotates fields with pii/1,2.

Adding it

# mix.exs
defp deps do
  [
    {:cratis_chronicle, "~> 3.13"}
  ]
end

The library declares extra_applications: [:logger, :inets, :ssl] and no mod: (Source/chronicle/mix.exs), so nothing starts on its own. :inets and :ssl back the least-connections load balancer's HTTP probes.

Starting the client

Chronicle.Client is a Supervisor (lib/chronicle/client.ex) with start_link(opts \\ []). Put it in your application's tree — this is the CI-validated snippet from Documentation/client-snippets/get-started/console/connect.md:

defmodule MyApp.Application do
  use Application

  @impl true
  def start(_type, _args) do
    children = [
      {Chronicle.Client,
       connection_string: Chronicle.Connections.ConnectionString.development(),
       event_store: "quickstart",
       otp_app: :my_app}
    ]

    Supervisor.start_link(children, strategy: :one_for_one, name: MyApp.Supervisor)
  end
end