install.causet.io

Install the Causet CLI or run the local Causet core stack.

This site serves the install artifacts used by the docs, scripts, and developer workflows.

CLI available now · Docker Compose for local development

Install the CLI Get docker-compose.yml Read install docs
CLI

Install the Causet CLI

Install the Causet CLI and compiler from public GitHub Releases into ~/.causet/bin.

The installer updates your shell PATH and adds tab completion for zsh, bash, and fish.

Available now

Install command

macOS and Linux. Requires curl or wget.

$ curl -fsSL https://install.causet.io/install.sh | bash
$ causet version
https://install.causet.io/install.sh

What it installs

  • causet CLI
  • causet-compiler
  • Binaries in ~/.causet/bin
  • PATH setup
  • Shell completions for zsh, bash, and fish
Pinned release
CAUSET_VERSION=vX.Y.Z curl -fsSL https://install.causet.io/install.sh | bash
Local development

Run the local Causet stack

Run Causet locally with a self-contained Docker Compose file.

This starts the runtime, control plane API, query service, projection service, Postgres, Redis, Redpanda, and MinIO.

No monorepo build required. No hosted auth or Clerk dependency.

After it comes up

Wait for the health checks to pass, then point the CLI at:

http://localhost:8085

Local mode uses open development defaults.

You can override settings with a sibling .env file.

Do not use the default local configuration as production settings.

Health checks
Service URL
Control Plane API http://localhost:8085/actuator/health
Runtime http://localhost:8080/actuator/health
Query http://localhost:8082/actuator/health
Projection http://localhost:8083/actuator/health 
# clean slate
docker compose down -v
First run

Next: run your first Causet app

Once the CLI is installed and the local stack is healthy, create a project, deploy it, submit an intent, and inspect the decision tree on the timeline.

Setup
$ causet context use env local
$ causet init hello-causet
$ cd hello-causet
$ causet build
$ causet deploy --fork sandbox
Submit an intent
$ causet intent FOLLOW_ARTIST \
    --fork sandbox \
    --stream user_stream \
    --entity user-1 \
    --payload '{"user_id":"user-1","artist_id":"artist-pearl-jam"}'

  ✓ ACCEPTED  [hello-causet · user_stream · fork: sandbox]

  intent id     int_8f2a1c
  status        ACCEPTED
  phase         COMMITTED
  timeline id   tl_4c91e2
  message       Intent accepted and submitted for processing

  → Inspect timeline:
     causet inspect timeline --entity user-1 --stream user_stream --fork sandbox
View the decision tree
$ causet inspect timeline --entity user-1 --stream user_stream --fork sandbox --all

  entity  user-1
  stream  user_stream
  fork    sandbox

  FOLLOW_ARTIST  ✓ ACCEPTED
  payload  {"user_id":"user-1","artist_id":"artist-pearl-jam"}

  ✓  cursor 1     step 0  ACCEPT
  ✓  cursor 1     step 1  SET
         SET       /followed_artists  += artist-pearl-jam
  ·  cursor 1     step 2  EMIT
         EMIT      ARTIST_FOLLOWED
                   {"user_id":"user-1","artist_id":"artist-pearl-jam"}
  ✓  cursor 1     step 3  COMMIT

Local API default is http://localhost:8085. Walkthrough: Quickstart · Install docs