textus 0.54.1 → 0.54.2
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -1
- data/README.md +53 -26
- data/SPEC.md +141 -297
- data/docs/reference/conventions.md +39 -55
- data/lib/textus/action/ingest.rb +103 -35
- data/lib/textus/action/pulse.rb +1 -1
- data/lib/textus/boot.rb +3 -3
- data/lib/textus/cursor_store.rb +1 -1
- data/lib/textus/init.rb +1 -1
- data/lib/textus/layout.rb +15 -7
- data/lib/textus/manifest/entry/publish/to_paths.rb +1 -4
- data/lib/textus/ports/raw_index.rb +61 -0
- data/lib/textus/version.rb +1 -1
- metadata +2 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 53f01828833f9c5e6cb0249fe513b92d6afbb210d90cfca10f51c560c8b2e2ca
|
|
4
|
+
data.tar.gz: 1956232435c941479290225e20168979beb270a6e2f5874df37c302e170a43e7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c086755b90faab7ecebdeebd722e9458dbede54c5efa9be212d6d861c999655093166a1f61826aa9e09ebee8cd1cf57996d958bd410c3b682763d911ed44abe5
|
|
7
|
+
data.tar.gz: aad04f9470c3de178ad6c762ef3102528cbdc94922fedb79d121ffbadc23acc5dd3f52871f6b3c0c75664afdb968c12fa814b88fbedcbd0d914161e4e1f337ab
|
data/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,19 @@ The **gem version** (`0.x.y`) is distinct from the **protocol version**
|
|
|
9
9
|
bump is a breaking change that requires a store migration; the gem version
|
|
10
10
|
tracks both additive improvements and breaking protocol bumps independently.
|
|
11
11
|
|
|
12
|
+
## 0.54.2 — 2026-06-18 — ingest dedup, .run → .state rename
|
|
13
|
+
|
|
14
|
+
### Added
|
|
15
|
+
|
|
16
|
+
- **Content-hash dedup in `Action::Ingest`**: re-ingesting the same URL or file bytes silently creates a supersede chain — new entry with full content, old stripped to tombstone with a `superseded_by` pointer.
|
|
17
|
+
- **`Ports::RawIndex`**: lightweight YAML-based O(1) index for raw lane content-hash/URL lookups, stored at `.textus/.state/indexes/raw.yaml`.
|
|
18
|
+
- **`content_hash` field**: every new raw entry stores a `sha256:` content hash for fast dedup lookups.
|
|
19
|
+
- **Asset file move on re-ingest**: asset files are moved (not copied) to the new date path on supersede.
|
|
20
|
+
|
|
21
|
+
### Changed
|
|
22
|
+
|
|
23
|
+
- **`.run` → `.state` rename**: the runtime artifact directory is renamed from `.textus/.run/` to `.textus/.state/`. The `state/` subdirectory becomes `cursors/`. Layout path methods follow automatically. Manual migration step: `mv .textus/.run .textus/.state`.
|
|
24
|
+
|
|
12
25
|
## 0.54.1 — 2026-06-17 — MCP SDK, dry ecosystem, ERB templates
|
|
13
26
|
|
|
14
27
|
### Added
|
|
@@ -406,7 +419,7 @@ No `textus/3` wire-format change. Manifest schema gains one optional, backward-c
|
|
|
406
419
|
segment-wise globstar — `**` spans zero or more path segments; within a
|
|
407
420
|
segment `*` is anchored and `{a,b}` alternates (stdlib `File.fnmatch`,
|
|
408
421
|
no new dependency). Documented in
|
|
409
|
-
[`docs/reference/zones.md`](docs/reference/
|
|
422
|
+
[`docs/reference/zones.md`](docs/reference/lanes.md#nested-entries).
|
|
410
423
|
|
|
411
424
|
### Internal
|
|
412
425
|
|
data/README.md
CHANGED
|
@@ -39,6 +39,9 @@ flowchart LR
|
|
|
39
39
|
agent -->|keep| notebook["notebook<br/>(workspace)"]
|
|
40
40
|
agent -->|propose| proposals["proposals<br/>(queue)"]
|
|
41
41
|
automation -->|drain| artifacts["artifacts<br/>(machine)"]
|
|
42
|
+
human -->|ingest| raw["raw<br/>(intake)"]
|
|
43
|
+
agent -->|ingest| raw
|
|
44
|
+
automation -->|ingest| raw
|
|
42
45
|
|
|
43
46
|
proposals ==>|human accept| knowledge
|
|
44
47
|
knowledge -.->|projection source| artifacts
|
|
@@ -46,13 +49,15 @@ flowchart LR
|
|
|
46
49
|
classDef actor fill:#238636,stroke:#2ea043,color:#fff;
|
|
47
50
|
classDef gate fill:#9e6a03,stroke:#bb8009,color:#fff;
|
|
48
51
|
classDef anchor fill:#1f6feb,stroke:#388bfd,color:#fff;
|
|
52
|
+
classDef intake fill:#6e40c9,stroke:#8b5cf6,color:#fff;
|
|
49
53
|
class human,agent,automation actor;
|
|
50
54
|
class proposals gate;
|
|
51
55
|
class knowledge anchor;
|
|
56
|
+
class raw intake;
|
|
52
57
|
```
|
|
53
58
|
|
|
54
59
|
*Each actor writes only into its own lane; low-trust input climbs to authoritative lanes only by passing a guarded transition (an agent's proposal needs a human `accept`).*
|
|
55
|
-
*Colour legend: **green** = writers · **amber** = the review gate (`proposals`) · **blue** = the trust anchor (`knowledge`).*
|
|
60
|
+
*Colour legend: **green** = writers · **amber** = the review gate (`proposals`) · **blue** = the trust anchor (`knowledge`) · **purple** = write-once intake (`raw`).*
|
|
56
61
|
|
|
57
62
|
The point of those lanes is to **build context you can trust**. Place each lane on two axes — how durable it is, and how much you can rely on it without review — and the value shows up as a climb: the high-trust corner (durable *and* authoritative = `knowledge`) is the one place nothing is *written* directly. It's *earned* by crossing the `accept` gate.
|
|
58
63
|
|
|
@@ -64,9 +69,10 @@ DURABLE │ notebook │ knowledge ★ the goal
|
|
|
64
69
|
(kept) │ agent's working truth │ canon — a human authors │
|
|
65
70
|
│ durable, but low-trust │ here · the context you ship │
|
|
66
71
|
├──────────────────────────┼───────────────────────────────┤
|
|
67
|
-
TRANSIENT │ artifacts
|
|
68
|
-
(staging) │ computed
|
|
69
|
-
│
|
|
72
|
+
TRANSIENT │ artifacts (outputs) │ proposals (queue) │
|
|
73
|
+
(staging) │ computed, machine-made │ a candidate, in review │
|
|
74
|
+
│ raw (inputs) │ ▲ climbs via human accept │
|
|
75
|
+
│ ingested, write-once │ │
|
|
70
76
|
└──────────────────────────┴───────────────────────────────┘
|
|
71
77
|
raw material ──── propose ────► a human accept lifts it to canon
|
|
72
78
|
```
|
|
@@ -135,7 +141,7 @@ bundle exec exe/textus --help
|
|
|
135
141
|
|
|
136
142
|
## What `textus init` gives you
|
|
137
143
|
|
|
138
|
-
You get `.textus/` with all
|
|
144
|
+
You get `.textus/` with all five lane directories under `data/`, baseline schemas, a starter manifest, and a gitignored `.state/` for disposable runtime state (the audit log, per-role cursors, produce locks). Roles declare capabilities; each lane declares a `kind:`, and write authority is derived from the role's capabilities crossed with the lane's kind:
|
|
139
145
|
|
|
140
146
|
```yaml
|
|
141
147
|
roles:
|
|
@@ -156,17 +162,18 @@ lanes:
|
|
|
156
162
|
schemas/ # YAML field shapes per entry family
|
|
157
163
|
templates/ # ERB templates for produced entries
|
|
158
164
|
workflows/ # Ruby workflow files (Textus.workflow DSL) for data acquisition
|
|
159
|
-
.gitignore # generated — ignores .
|
|
165
|
+
.gitignore # generated — ignores .state/ and any tracked:false entries
|
|
160
166
|
data/ # one dir per lane; kinds + capabilities are in the manifest above
|
|
161
167
|
knowledge/ # e.g. identity (knowledge.identity.*), voice, decisions, notes
|
|
162
168
|
notebook/
|
|
163
169
|
proposals/
|
|
164
170
|
artifacts/ # machine lane: computed outputs + external inputs
|
|
165
|
-
.
|
|
171
|
+
.state/ # disposable runtime state — gitignored, safe to delete (ADR 0038)
|
|
166
172
|
audit/audit.log # append-only NDJSON event ledger, every write (rotates at ~10 MB)
|
|
167
|
-
|
|
173
|
+
cursors/<role> # per-role pulse cursor — where `pulse --since` resumes
|
|
168
174
|
locks/ # per-key produce locks + the produce mutex
|
|
169
175
|
sentinels/ # publish bookkeeping (target sha) — regenerated on drain (ADR 0070)
|
|
176
|
+
indexes/raw.yaml # raw lane content-hash/URL index — regenerable cache
|
|
170
177
|
```
|
|
171
178
|
|
|
172
179
|
Manifest `path:` fields are relative to `.textus/data/`. So `knowledge.notes.org.jane` lives at `.textus/data/knowledge/notes/org/jane.md`.
|
|
@@ -195,14 +202,14 @@ For a worked store — knowledge entries, a staged proposal, schemas, ERB templa
|
|
|
195
202
|
- **Agent loop.** `textus boot` orients a fresh session; `textus pulse --since=N` is the per-turn heartbeat (changed entries, pending proposals, index etag for catalog drift detection). ([docs/how-to/agents-mcp.md](docs/how-to/agents-mcp.md))
|
|
196
203
|
- **MCP surface.** The official `mcp` Ruby SDK drives the stdio JSON-RPC server; protocol version auto-negotiated up to `2025-11-25`. Wire textus into Claude Code, Cursor, or any MCP host in one config block.
|
|
197
204
|
- **`textus doctor`.** Health checks across schemas, workflow registrations, keys, sentinels, and the audit log.
|
|
198
|
-
- **`raw` lane
|
|
205
|
+
- **`raw` lane and `ingest` verb.** Write-once intake lane for external URL bookmarks, files, and binary assets. Three source kinds (`url`/`file`/`asset`); daily key derivation; notebook stub per ingest. See "Intake and ingest" section below.
|
|
199
206
|
|
|
200
207
|
## CLI and lanes
|
|
201
208
|
|
|
202
209
|
Every command operates on one store, located in this order: `--root <path>` flag → **`TEXTUS_ROOT`** env → walk up from the working directory for a `.textus/` ([SPEC §3.1](SPEC.md)). Write verbs require `--as=<role>`, resolved as: `--as` flag → **`TEXTUS_ROLE`** env → `.textus/role` file → default `human` ([SPEC §5.1](SPEC.md)). Default roles: `human`, `agent`, `automation` (rename or add your own in the manifest's `roles:` block). All verbs accept `--output=json` and return the envelope defined in [SPEC §8](SPEC.md).
|
|
203
210
|
|
|
204
211
|
- Full verb table — read, write, health, scaffolding — is in [SPEC §9](SPEC.md).
|
|
205
|
-
- Lane semantics and the capability × lane-kind mapping live in [SPEC §5](SPEC.md), with the reference in [`docs/reference/
|
|
212
|
+
- Lane semantics and the capability × lane-kind mapping live in [SPEC §5](SPEC.md), with the reference in [`docs/reference/lanes.md`](docs/reference/lanes.md).
|
|
206
213
|
|
|
207
214
|
`textus boot` prints the same information for the current store: lanes, entry families with schemas, registered workflows, write flows, and the verb catalog. Run it inside a store and you get the live picture; reach for the SPEC when you want the contract.
|
|
208
215
|
|
|
@@ -213,7 +220,7 @@ Produced entries (`kind: produced`) declare how they're acquired in one `source:
|
|
|
213
220
|
- **`source: { from: external, command: "...", sources: [...] }`** — *externally managed*: an out-of-band command or workflow writes the file; textus tracks staleness via declared `sources`.
|
|
214
221
|
- **`source: { from: external, command: "true", sources: [] }` + a workflow** — *workflow-driven*: a `Textus.workflow` block (in `.textus/workflows/`) acquires and shapes the data on `drain`.
|
|
215
222
|
|
|
216
|
-
Publishing is one typed `publish:` block (ADR 0052/0094). Each target is either `{ to: path, template?: name }` for a single file (optionally rendered through an ERB template) or `{ tree: "dir" }` to mirror a whole stored subtree. Sentinels for every published file live under `.textus/.
|
|
223
|
+
Publishing is one typed `publish:` block (ADR 0052/0094). Each target is either `{ to: path, template?: name }` for a single file (optionally rendered through an ERB template) or `{ tree: "dir" }` to mirror a whole stored subtree. Sentinels for every published file live under `.textus/.state/sentinels/` (git-ignored, regenerated on drain). See SPEC §5.2, §5.3, §5.12.
|
|
217
224
|
|
|
218
225
|
Templates live in `.textus/templates/` as ERB files (`.erb`). The template receives the entry's `content` hash as local variables via `ERB#result_with_hash`. If `inject_boot: true`, a `boot` variable is also available with the live orientation context.
|
|
219
226
|
|
|
@@ -222,7 +229,7 @@ Templates live in `.textus/templates/` as ERB files (`.erb`). The template recei
|
|
|
222
229
|
textus extends through **workflows** — a `Textus.workflow` block placed in `.textus/workflows/**/*.rb`. Each workflow matches a produced entry by key glob, then runs one or more named steps to acquire its data:
|
|
223
230
|
|
|
224
231
|
```ruby
|
|
225
|
-
# .textus/workflows/
|
|
232
|
+
# .textus/workflows/docs/my_report.rb
|
|
226
233
|
Textus.workflow "my_report" do
|
|
227
234
|
match "artifacts.my-report"
|
|
228
235
|
|
|
@@ -238,27 +245,47 @@ end
|
|
|
238
245
|
|
|
239
246
|
`drain` discovers all workflow files, matches them against produced entries, and runs the steps. The result is written back to the entry's data path; `publish:` then copies it to its consumer paths.
|
|
240
247
|
|
|
241
|
-
##
|
|
248
|
+
## Intake and ingest
|
|
242
249
|
|
|
243
|
-
|
|
250
|
+
The `raw` lane is the inbound counterpart to `artifacts`: where `drain` materialises
|
|
251
|
+
**outbound** computed outputs, `ingest` receives **inbound** external source material.
|
|
244
252
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
+
**The ingest principle:** prefer a reference over a copy. Store body or asset only when the
|
|
254
|
+
content itself is the value — human-authored notes, brainstorm outputs, context you want to
|
|
255
|
+
annotate. For everything else, the URL is enough. If the source is private or
|
|
256
|
+
access-restricted, set `access: private` in `source:` so downstream workflows can handle it
|
|
257
|
+
appropriately.
|
|
258
|
+
|
|
259
|
+
**Three source kinds:**
|
|
260
|
+
|
|
261
|
+
| Kind | Stores | Use when |
|
|
262
|
+
|------|--------|----------|
|
|
263
|
+
| `url` | URL reference only (`body: null`) | Bookmarking a page, skill, or doc for later annotation |
|
|
264
|
+
| `file` | File body text | Valuable human-authored content (brainstorm notes, meeting summaries) |
|
|
265
|
+
| `asset` | Binary at `assets/raw/` | Screenshots, PDFs — only when the asset itself is the artefact |
|
|
253
266
|
|
|
254
|
-
|
|
267
|
+
**Write-once** — the same slug on the same day cannot be overwritten. Delete and re-ingest to replace.
|
|
268
|
+
|
|
269
|
+
```sh
|
|
270
|
+
# bookmark a skill reference — URL only, body stays null
|
|
271
|
+
textus ingest url agentskills-io-brainstorming \
|
|
272
|
+
--url=https://agentskills.io/skills/brainstorming \
|
|
273
|
+
--label="brainstorming skill" \
|
|
274
|
+
--as=agent
|
|
275
|
+
|
|
276
|
+
# see what landed in the raw lane
|
|
277
|
+
textus list --lane=raw
|
|
278
|
+
|
|
279
|
+
# a notebook stub was created alongside — annotate it
|
|
280
|
+
textus get notebook.notes.raw
|
|
281
|
+
```
|
|
255
282
|
|
|
256
|
-
Stale produced entries are re-materialised by `drain`, not by reads — `get` is a pure read
|
|
283
|
+
Stale produced entries are re-materialised by `drain`, not by reads — `get` is a pure read (ADR 0089).
|
|
257
284
|
|
|
258
285
|
```sh
|
|
259
286
|
textus drain --as=automation # re-materialise every stale produced entry
|
|
260
|
-
textus drain artifacts.feeds --as=automation
|
|
261
|
-
textus get artifacts.feeds.
|
|
287
|
+
textus drain artifacts.feeds.skills --as=automation # scope to one prefix
|
|
288
|
+
textus get artifacts.feeds.skills # a pure read; carries a freshness verdict
|
|
262
289
|
```
|
|
263
290
|
|
|
264
291
|
Schemas (`.textus/schemas/<name>.yaml`) declare field shapes, per-field `maintained_by:` ownership, and an `evolution:` block (`added_in`, `deprecated_at`, `migrate_from`). Full contract in SPEC §5.8.
|