Installation

How to install Trellis globally or as a project dependency.

Prerequisites

Install Trellis globally to use the CLI anywhere:

npm install -g trellis
trellis -h

Or use npx without installing:

npx trellis -h

Add Trellis to your project:

npm install trellis

Then import the engine programmatically:

import { TrellisVcsEngine } from "trellis";

const engine = new TrellisVcsEngine({ rootPath: "/my/project" });
await engine.initRepo();

Trellis exposes modular subpaths so you can depend on only what you need:

Subpath	Use
`trellis`	Full platform engine, including `TrellisVcsEngine`.
`trellis/cms`	TrellisDB collections through `createCmsClient`.
`trellis/core`	EAV store, kernel, facts, and query primitives.
`trellis/vcs`	Version control types and helpers.
`trellis/server`	Server runtime entry points.
`trellis/client`	Network client for Trellis server instances.
`trellis/react`	React provider and hooks.
`trellis/ai`	Embeddings and intelligence utilities.
`trellis/links`	File reference parsing and resolution.
`trellis/decisions`	Decision trace recording and querying.

trellis --version

Introduction

Discover the Agentic State Engine — an event-sourced causal graph with branching, decision traces, and realtime sync.

Quick Start

Initialize your first Trellis repository, watch for changes, and create a milestone in under five minutes.