trellis 2.1.4 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +48 -40
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,20 +1,26 @@
1
1
  <p align="center">
2
- <img src="https://trentbrew.pockethost.io/api/files/swvnum16u65or8w/75p6fv4xnwa3mq7/logomark_alpha_green_T3C3ypsMwI.png?token=" alt="Trellis" width="128" />
2
+ <img src="https://trentbrew.pockethost.io/api/files/swvnum16u65or8w/0rxgb6qsb1bi6xa/slide_16_9_1_2bvtP0lHrN.png?token=" alt="Trellis" width="100%" />
3
3
  </p>
4
4
 
5
5
  # Trellis
6
6
 
7
7
  > **A comprehensive graph-native platform for code, knowledge, and collaboration.**
8
- > Trellis combines version control, semantic analysis, knowledge graphs, and intelligent automation into a unified system that treats every action as a first-class graph entity.
8
+
9
+ | Capability | Description |
10
+ | :--------------------- | :------------------------------------------------------------ |
11
+ | **Graph-Native VCS** | Immutable causal ops, semantic patching, narrative milestones |
12
+ | **Knowledge Graph** | EAV store, wiki-links, embeddings, ontology validation |
13
+ | **Intelligent Agents** | Tool registry, decision traces, agent orchestration |
14
+ | **Collaboration** | Peer sync, multi-repo federation, HTTP/WebSocket transports |
9
15
 
10
16
  ---
11
17
 
12
18
  ## Table of Contents
13
19
 
20
+ - [Quick Start](#quick-start)
14
21
  - [Platform Overview](#platform-overview)
15
22
  - [Core Capabilities](#core-capabilities)
16
23
  - [Project Surfaces](#project-surfaces)
17
- - [Quick Start](#quick-start)
18
24
  - [Package Architecture](#package-architecture)
19
25
  - [CLI Overview](#cli-overview)
20
26
  - [VS Code Extension](#vs-code-extension)
@@ -24,6 +30,44 @@
24
30
 
25
31
  ---
26
32
 
33
+ ## Quick Start
34
+
35
+ ### Install
36
+
37
+ Global install:
38
+
39
+ ```bash
40
+ npm install -g trellis
41
+ trellis -h
42
+ ```
43
+
44
+ Or use npx:
45
+
46
+ ```bash
47
+ npx trellis -h
48
+ ```
49
+
50
+ ### Initialize a repository
51
+
52
+ ```bash
53
+ # With the CLI
54
+ npx trellis init
55
+ npx trellis watch
56
+
57
+ # Or programmatically
58
+ import { TrellisVcsEngine } from 'trellis';
59
+ const engine = new TrellisVcsEngine({ rootPath: '/my/project' });
60
+ await engine.initRepo();
61
+ ```
62
+
63
+ ### Import from Git
64
+
65
+ ```bash
66
+ npx trellis import --from /path/to/git-repo
67
+ ```
68
+
69
+ ---
70
+
27
71
  ## Platform Overview
28
72
 
29
73
  Trellis is a comprehensive platform that unifies version control, knowledge management, semantic analysis, and intelligent automation. Built on a graph-native foundation, it treats every action—code changes, decisions, links, and embeddings—as first-class entities in a causal graph.
@@ -77,42 +121,6 @@ The platform consists of multiple integrated surfaces:
77
121
 
78
122
  ---
79
123
 
80
- ## Quick Start
81
-
82
- ### Use the npm package
83
-
84
- ```bash
85
- bun add trellis
86
- ```
87
-
88
- ```typescript
89
- import { TrellisVcsEngine } from 'trellis';
90
-
91
- const engine = new TrellisVcsEngine({ rootPath: '/my/project' });
92
- engine.open();
93
- ```
94
-
95
- ### Work on the repo locally
96
-
97
- ```bash
98
- # Install dependencies
99
- bun install
100
-
101
- # Initialize a new Trellis repo in the current directory
102
- bun run src/cli/index.ts init
103
-
104
- # Watch for file changes (continuous op stream)
105
- bun run src/cli/index.ts watch
106
-
107
- # Check status
108
- bun run src/cli/index.ts status
109
-
110
- # Import an existing Git repo
111
- bun run src/cli/index.ts import --from /path/to/git-repo
112
- ```
113
-
114
- ---
115
-
116
124
  ## Package Architecture
117
125
 
118
126
  ```
@@ -310,7 +318,7 @@ The `trellis` package is intentionally split into subpaths so consumers can depe
310
318
  ### Published Package Surface
311
319
 
312
320
  ```bash
313
- bun add trellis
321
+ npm install trellis
314
322
  ```
315
323
 
316
324
  ```typescript
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "trellis",
3
- "version": "2.1.4",
3
+ "version": "2.1.5",
4
4
  "description": "A comprehensive graph-native platform for code, knowledge, and collaboration — version control, semantic analysis, knowledge graphs, embeddings, and decision traces",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",