@inerrata-corporation/errata 2.0.0-alpha.0

package/README.txt

@@ -0,0 +1,56 @@
+errata - local-first observation engine for coding agents
+
+Requires Node.js 22 or newer on PATH (https://nodejs.org).
+
+Install (Windows, no admin rights required):
+
+    .\install.ps1
+
+This copies errata.mjs + the tree-sitter runtime to %LOCALAPPDATA%\errata
+and adds that directory to your user PATH. A small errata.cmd shim runs the
+bundle under your system Node.
+
+It also registers a Scheduled Task (\errata\ai.errata.daemon) that auto-starts
+the daemon (`errata dash`) at every logon, launched hidden via a small .vbs so
+no console window flashes. uninstall.ps1 removes it. Note: this runs the
+installed copy under %LOCALAPPDATA%\errata - re-run install.ps1 after rebuilding
+to keep the autostarted daemon current.
+
+macOS / Linux:
+
+    errata.mjs carries a `#!/usr/bin/env node` shebang. Put the dist/ folder
+    somewhere stable, then symlink the bundle onto your PATH:
+
+        chmod +x errata.mjs
+        ln -s "$PWD/errata.mjs" ~/.local/bin/errata
+
+    The resources/wasm/ folder must stay next to errata.mjs.
+
+Use:
+
+    cd C:\path\to\your\project
+    errata init         # auto-detects profile + installs harness hooks
+    errata start        # observe this repo
+    errata status       # verify the whole chain (daemon, cloud, consent)
+
+Model caveat (Claude Code + Claude Fable 5): the harness treats Fable 5's
+mid-turn assistant text (written between tool calls) as ephemeral - it reaches
+neither the session transcript nor the MessageDisplay hook, so inline tags
+written mid-turn are lost on every capture channel. errata's agent instruction
+tells the agent to restate mid-turn tags in its final message (which always
+survives), so expect reduced mid-turn capture on Fable sessions; Opus/Sonnet
+sessions are fully captured. (Verified with a 3-model matrix, 2026-07-02.)
+
+Open the dashboard: http://127.0.0.1:7891
+
+Point at a cloud (defaults to the public instance):
+
+    errata init --cloud https://your-instance --token <api-key>
+    errata login        # or browser device-code flow
+
+Per-workspace state lives at .errata/ inside each project root and is
+preserved on uninstall - delete manually if you want it gone.
+
+Uninstall (Windows):
+
+    .\uninstall.ps1