-
Notifications
You must be signed in to change notification settings - Fork 1
docs: align XYPH with Continuum plans and add Edict roadmap #69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
c7f8351
895d1f8
a8095bf
761c715
e1c7d3a
c87cf91
fe2516c
065eff5
a343fb5
52708a1
4365ddf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,111 @@ | ||
| # Xyph | ||
| # XYPH | ||
|
|
||
| A planning compiler and coordination foundation for humans and agents. Xyph replaces scattered tickets and chat threads with a single, deterministic WARP graph that tracks the genealogy of intent from "why" to "shipped." | ||
| A sovereign agentic planning substrate and Edict execution runtime designed for the [Continuum](https://github.com/flyingrobots/continuum) post-Unix platform. | ||
|
|
||
| Xyph is designed for the high-output team that demands geometric lawfulness in their coordination. It scales from solo offline-first planning to multi-agent orchestrated execution with cryptographic settlement. | ||
| XYPH replaces traditional central-database ticketing systems with a distributed network of **Continuum Participants** that materialize project planning coordinates (Intents, Quests, Scrolls, and Policies) directly from an immutable, verifiable causal history. | ||
|
|
||
|  | ||
| > [!WARNING] | ||
| > **ROADMAP ALIGNMENT** | ||
| > While XYPH currently operates as a local-first TypeScript CLI and TUI over git-warp graphs, it is actively transitioning to a native Continuum Participant. The Edict compilation, capability-bound execution lanes, and peer-to-peer Continuum sync protocols described below represent our target architecture. | ||
|
|
||
| ## Why Xyph? | ||
| --- | ||
|
|
||
| Unlike traditional trackers that store status, Xyph computes reality from a shared, immutable history. | ||
| ## Why XYPH? | ||
|
|
||
| - **The Graph _is_ the Plan**: Coordination happens through **stigmergy**—participants modify the graph, and others observe the changes. The environment *is* the communication medium. | ||
| - **Causal Sovereignty**: Every unit of work (Quest) must trace back to an authoritative declaration (Intent). AI agents cannot "hallucinate" work; they must be authorized by the genealogy of intent. | ||
| - **Deterministic Convergence**: Built on [WARP (Structural Worldline Memory)](https://github.com/git-stunts/git-warp), Xyph ensures that all writers compute the same final state, even after weeks of offline work. | ||
| - **Cryptographic Settlement**: Completed work is sealed with Ed25519 Guild Seals. Trust is mathematical, not administrative. | ||
| In a post-Unix architecture, files are not fundamental; they are bounded, materialized readings over causal history. XYPH applies this tenet to coordination: | ||
|
|
||
| ## Quick Start | ||
| * **Verifiable Causal Sovereignty**: Every quest or backlog item is linked back to a human-authorized root node through the **Genealogy of Intent**. AI agents cannot hallucinate work; they can only claim and act on cryptographically signed, authorized tasks. | ||
| * **Edict Execution Sandbox**: Planning changes and graph mutations are written as **Edict Intents**—safe, statically verified operations. Edict contains the authority blast radius of prompt injections by proving exactly which graph nodes can be touched before code runs. | ||
| * **Coordination-Free Concurrency**: Built on [git-warp](https://github.com/git-stunts/git-warp), XYPH coordinates concurrent agent claims offline-first. Diverging worldlines are converged deterministically by Last-Write-Wins (LWW) CRDT semantics, or reconciled via explicit sequenced admission. | ||
| * **Cryptographic Settlement**: Quests are sealed with **Scrolls**—cryptographically signed Boundary Transition Records (BTRs). Peer participants or human operators verify quest resolution by inspecting the Scroll's self-contained signature envelope, without needing to walk or download the full repository history. | ||
|
Comment on lines
+18
to
+20
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
These bullets describe Edict intents, BTR scroll verification, and related runtime behavior as if they work today, but the roadmap docs added in this same change state that Edict Core IR/lowerers/admission/runtime execution and BTR-style scrolls are future work ( Useful? React with 👍 / 👎. |
||
|
|
||
| --- | ||
|
|
||
| ### 1. Local Setup | ||
| ## System Architecture | ||
|
|
||
| XYPH functions as a tiered planning and execution runtime: | ||
|
|
||
| ```text | ||
| ┌───────────────────────────────────────────────────┐ | ||
| │ Surface / Interface │ | ||
| │ Bijou TUI Cockpit · Actuator CLI · TUI API │ | ||
| └─────────────────────────┬─────────────────────────┘ | ||
| ▼ | ||
| ┌───────────────────────────────────────────────────┐ | ||
| │ Versioned JSONL Control Plane (XYPH) │ | ||
| │ Canonical interface for queries and commands │ | ||
| └─────────────────────────┬─────────────────────────┘ | ||
| ▼ | ||
| ┌───────────────────────────────────────────────────┐ | ||
| │ Edict Execution Runtime │ | ||
| │ Evaluates capability-bound lanes in WASM │ | ||
| │ (continuum.lane.lawful-autonomous/v1) │ | ||
| └─────────────────────────┬─────────────────────────┘ | ||
| ▼ | ||
| ┌───────────────────────────────────────────────────┐ | ||
| │ git-warp Causal History Substrate │ | ||
| │ Exchanges causal cones P2P via Continuum │ | ||
| └───────────────────────────────────────────────────┘ | ||
| ``` | ||
|
|
||
| * **The Cold Path (Authoring)**: Edict source code is statically compiled and verified against target profiles, generating a certified contract bundle stored in the Pre-Admitted Operation Registry. | ||
| * **The Hot Path (Execution)**: Autonomous agents or TUI actions invoke the pre-admitted registry using a scoped `CapabilityRef`, a basis coordinate, and an idempotency key. | ||
|
|
||
| Install dependencies and initialize your first project. | ||
| --- | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ### 1. Bootstrap Participant | ||
| Initialize your local participant node and register your Ed25519 identity keypair: | ||
|
|
||
| ```bash | ||
| npm install | ||
| npx tsx xyph-actuator.ts generate-key | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
In a fresh checkout with no saved identity, this line runs before Useful? React with 👍 / 👎. |
||
| npx tsx xyph-actuator.ts login human.ada | ||
| ``` | ||
|
|
||
| ### 2. Fast Coordination | ||
|
|
||
| Declare an intent and create a quest. | ||
| ### 2. Declare and Claim Intent | ||
| Wire a new planning requirement back to a sovereign human intent and volunteer for the quest: | ||
|
|
||
| ```bash | ||
| # Declare why work should exist | ||
| # Declare the root intent (Why the work exists) | ||
| npx tsx xyph-actuator.ts intent intent:setup \ | ||
| --title "Repository needs industrial-grade docs" \ | ||
| --title "Repository needs Edict verification targets" \ | ||
| --requested-by human.ada | ||
|
|
||
| # Create a unit of work | ||
| npx tsx xyph-actuator.ts quest task:docs-001 \ | ||
| --title "Overhaul root README and signposts" \ | ||
| # Create a scoped quest linked to the intent | ||
| npx tsx xyph-actuator.ts quest task:setup-001 \ | ||
| --title "Implement git-warp target profile schema" \ | ||
| --intent intent:setup | ||
|
Comment on lines
+77
to
79
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
In a fresh checkout, copying this block does not produce a claimable quest: Useful? React with 👍 / 👎. |
||
| ``` | ||
|
|
||
| ### 3. TUI Cockpit | ||
| # Claim the quest (Locks state to IN_PROGRESS under your capability) | ||
| npx tsx xyph-actuator.ts claim task:setup-001 | ||
| ``` | ||
|
|
||
| Open the Bijou-powered interactive dashboard to navigate the roadmap. | ||
| ### 3. Open the Cockpit | ||
| Boot the interactive Bijou-powered cockpit to manage work streams and inspect active suggestion lanes: | ||
|
|
||
| ```bash | ||
| npm run tui | ||
| ``` | ||
|
|
||
|  | ||
| --- | ||
|
|
||
| ## Documentation Map | ||
|
|
||
| ## Documentation | ||
| To orient yourself, follow the authoritative manifests in order: | ||
|
|
||
| - **[Guide](./GUIDE.md)**: Orientation, the fast path, and Digital Guild nouns. | ||
| - **[Advanced Guide](./ADVANCED_GUIDE.md)**: Deep dives into worldlines, braiding, and settlement. | ||
| - **[Architecture](./ARCHITECTURE.md)**: The authoritative structural reference (Hexagonal, Ports, WARP). | ||
| - **[Vision](./docs/VISION.md)**: Core tenets and the stigmergic mission. | ||
| - **[Method](./design/METHOD.md)**: Repo work doctrine and the cycle loop. | ||
| - **[Contributing](./CONTRIBUTING.md)**: Topic-based contract-graph documentation rules, self-hosting dogfooding loop, quality gates, and initiate glossary. | ||
| 1. **The Entrance**: | ||
| * [GUIDE.md](./GUIDE.md) — Orientation, Digital Guild nouns, and quick checklist. | ||
| 2. **The Bedrock**: | ||
| * [ARCHITECTURE.md](./docs/canonical/ARCHITECTURE.md) — Authoritative structural references (Hexagonal, Ports, WARP). | ||
| * [docs/VISION.md](./docs/VISION.md) — Stigmergic tenets and the mission. | ||
| * [METHOD.md](./docs/canonical/METHOD.md) — Work doctrine and cycle loops. | ||
| 3. **The Direction**: | ||
| * [docs/BEARING.md](./docs/BEARING.md) — Current release posture and strategic target. | ||
| * [docs/topics/git-warp-evolution/README.md](./docs/topics/git-warp-evolution/README.md) — Optical query and speculative strand roadmap. | ||
| * [docs/topics/edict-integration/README.md](./docs/topics/edict-integration/README.md) — Sandbox boundaries and Edict target profiles. | ||
|
|
||
| --- | ||
|
|
||
| Built with geometric lawfulness by [FLYING ROBOTS](https://github.com/flyingrobots) | ||
| Built with geometric lawfulness for the post-Unix era by [FLYING ROBOTS](https://github.com/flyingrobots). | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| sequenceDiagram | ||
| autonumber | ||
| participant Agent as Autonomous Agent | ||
| participant XYPH as XYPH Runtime | ||
| participant HOLMES as HOLMES (Assurance) | ||
| participant gitwarp as git-warp (Substrate) | ||
|
|
||
| Agent->>Agent: Generate Edict intent source code | ||
| Agent->>XYPH: Submit intent for compilation | ||
| XYPH->>XYPH: Compile to Core IR & verify bounds | ||
| XYPH->>HOLMES: Check verifier report & generate Lawfulness Certificate | ||
| HOLMES-->>XYPH: Certified Contract Bundle | ||
| XYPH->>gitwarp: Evaluate admission policy & execute in sandboxed WASM | ||
| gitwarp-->>Agent: Return typed obstruction or success receipt |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1da7fe54b522885ce6789ed228ee5c4879ffd84026a4fa227af08b26e11970a4 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| flowchart TD | ||
| subgraph From ["Monolithic / Local (Present)"] | ||
| A1["Monolithic Materialization (Full GraphSnapshot)"] | ||
| A2["Direct Worldline Mutations (Planning Clutter)"] | ||
| A3["Walking Full Git History (Verifying Quest Scrolls)"] | ||
| A4["Centralized Git Sync (origin/main)"] | ||
| end | ||
|
|
||
| subgraph To ["Decentralized / Post-Unix (Target)"] | ||
| B1["Bounded Quest Optics (Causal Cone Subgraphs)"] | ||
| B2["Speculative Strands (Counterfactual Lanes)"] | ||
| B3["Boundary Transition Records (Cryptographic Scrolls)"] | ||
| B4["Continuum Protocol (P2P Agent Treaties)"] | ||
| end | ||
|
|
||
| A1 -->|Shift I| B1 | ||
| A2 -->|Shift II| B2 | ||
| A3 -->|Shift III| B3 | ||
| A4 -->|Shift IV| B4 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 43429bf4e95415aae178acd900a961ed4f30db5eb2024f9d92faa23ee3c033ff |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For items created through the documented intake path,
inboxwrites aBACKLOGtask withsuggested_bymetadata but noauthorized-byedge, and the renderer explicitly treats BACKLOG tasks as genuinely lacking an intent until promotion. Saying every backlog item is linked to a human-authorized root makes unaudited suggestions look sovereign before the promote step; scope this claim to promoted/planned quests or document the triage exception.Useful? React with 👍 / 👎.