Package Exports
- trellis
- trellis/ai
- trellis/client
- trellis/core
- trellis/db
- trellis/decisions
- trellis/links
- trellis/persist/better-sqlite
- trellis/react
- trellis/server
- trellis/vcs
Readme
Trellis
The Agentic Framework — A structured runtime for building agents that understand code, remember everything, and explain themselves.
| Use Case | How |
|---|---|
| Agentic State Engine | Tool registry + decision traces + branching — agents operate on state they can fork, audit, and roll back |
| Building Agents End-to-End | Unified LLM abstraction + context management + RAG + orchestration |
| Autonomous Code Editing | Semantic patching + AST-aware tools + causal history |
| Auditable Reasoning | Immutable op log + decision traces + precedent search |
Why Trellis?
Most agent frameworks focus on the reasoning engine (the LLM) but treat state as an afterthought. Trellis reverses this. It is the System of Record for Decisions, providing agents with a persistent, queryable, and auditable memory that compounds over time.
- Durable Memory: Every thought, tool call, and file change is an immutable operation in a causal graph
- Explainability by Default: Decision traces don't just store what happened, but why
- Safe Exploration: Agents can "fork" state to explore multiple paths
Quick Start
# 1. Install
npm install -g trellis
# 2. Initialize a repository
mkdir my-project && cd my-project
trellis init
# 3. Create content (tracked automatically)
echo "# My Project" > README.md
# 4. Add structured entities
trellis issue create --title "Bootstrap Visualization"
trellis milestone "Initial Release"
# 5. Create coding session with trellis harness
trellis codeSee the CLI guide for complete documentation.
What is Trellis?
Trellis is an event-sourced causal graph engine that unifies version control, knowledge management, and semantic analysis. Every action is an immutable operation in a causal stream:
interface VcsOp {
hash: string; // content-addressed
kind: VcsOpKind; // e.g. 'vcs:fileModify'
timestamp: string; // ISO 8601
agentId: string; // Author identity
previousHash?: string; // Causal chain link
vcs: VcsPayload; // Op-specific data
signature?: string; // Ed25519 signature
}Ops are written to .trellis/ops.json and never rewritten or deleted.
Platform Surfaces
| Surface | Purpose |
|---|---|
trellis npm package |
Core platform APIs via subpaths |
trellis CLI |
Repository management and automation |
| VS Code extension | Visual timeline and knowledge navigation |
Documentation
- Full documentation — Complete guides and API reference
- CLI reference — Command details (archived)
- API modules — Subpath imports (archived)
- DESIGN.md — Architecture specification
Development
# Prerequisites
# Requires Bun ≥ 1.0
# Install dependencies
bun install
# Run tests
bun test
# Build for npm
bun run buildStatus
| Phase | Deliverable | Status |
|---|---|---|
| P0 | Causal stream + CLI | ✅ |
| P0.5 | VS Code extension | ✅ |
| P1 | Git import bridge | ✅ |
| P2 | Branches, milestones | ✅ |
| P2.5 | Blob store, modularization | ✅ |
| P3 | File-level diff + merge | ✅ |
| P4 | Identity + governance | ✅ |
| P5 | Idea Garden | ✅ |
For comprehensive documentation including detailed CLI commands, API examples, and subsystem guides, see README-ARCHIVED.md.