trellis 2.1.4 → 2.1.6

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 +47 -43
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,20 +1,22 @@
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" />
3
- </p>
4
-
5
1
  # Trellis
6
2
 
7
3
  > **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.
4
+
5
+ | Capability | Description |
6
+ | :--------------------- | :------------------------------------------------------------ |
7
+ | **Graph-Native VCS** | Immutable causal ops, semantic patching, narrative milestones |
8
+ | **Knowledge Graph** | EAV store, wiki-links, embeddings, ontology validation |
9
+ | **Intelligent Agents** | Tool registry, decision traces, agent orchestration |
10
+ | **Collaboration** | Peer sync, multi-repo federation, HTTP/WebSocket transports |
9
11
 
10
12
  ---
11
13
 
12
14
  ## Table of Contents
13
15
 
16
+ - [Quick Start](#quick-start)
14
17
  - [Platform Overview](#platform-overview)
15
18
  - [Core Capabilities](#core-capabilities)
16
19
  - [Project Surfaces](#project-surfaces)
17
- - [Quick Start](#quick-start)
18
20
  - [Package Architecture](#package-architecture)
19
21
  - [CLI Overview](#cli-overview)
20
22
  - [VS Code Extension](#vs-code-extension)
@@ -24,6 +26,44 @@
24
26
 
25
27
  ---
26
28
 
29
+ ## Quick Start
30
+
31
+ ### Install
32
+
33
+ Global install:
34
+
35
+ ```bash
36
+ npm install -g trellis
37
+ trellis -h
38
+ ```
39
+
40
+ Or use npx:
41
+
42
+ ```bash
43
+ npx trellis -h
44
+ ```
45
+
46
+ ### Initialize a repository
47
+
48
+ ```bash
49
+ # With the CLI
50
+ npx trellis init
51
+ npx trellis watch
52
+
53
+ # Or programmatically
54
+ import { TrellisVcsEngine } from 'trellis';
55
+ const engine = new TrellisVcsEngine({ rootPath: '/my/project' });
56
+ await engine.initRepo();
57
+ ```
58
+
59
+ ### Import from Git
60
+
61
+ ```bash
62
+ npx trellis import --from /path/to/git-repo
63
+ ```
64
+
65
+ ---
66
+
27
67
  ## Platform Overview
28
68
 
29
69
  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 +117,6 @@ The platform consists of multiple integrated surfaces:
77
117
 
78
118
  ---
79
119
 
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
120
  ## Package Architecture
117
121
 
118
122
  ```
@@ -310,7 +314,7 @@ The `trellis` package is intentionally split into subpaths so consumers can depe
310
314
  ### Published Package Surface
311
315
 
312
316
  ```bash
313
- bun add trellis
317
+ npm install trellis
314
318
  ```
315
319
 
316
320
  ```typescript
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "trellis",
3
- "version": "2.1.4",
3
+ "version": "2.1.6",
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",