Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 78 additions & 33 deletions README.md
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.

![Xyph demo](docs/assets/title-screen.gif)
> [!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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Don't state backlog items are intent-linked

For items created through the documented intake path, inbox writes a BACKLOG task with suggested_by metadata but no authorized-by edge, 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 👍 / 👎.

* **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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Mark target runtime guarantees as future work

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 (docs/xyph-edict-integration.md:5, docs/xyph-git-warp-evolution.md:4). In the public README this will send users looking for runtime support and verification guarantees that the CLI cannot provide yet; keep these claims explicitly future-conditional or move them under the roadmap warning.

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Generate the key after selecting the identity

In a fresh checkout with no saved identity, this line runs before login human.ada, so generate-key resolves the default agent.prime identity and writes the Guild Seal key for that principal. The next line persists human.ada, leaving the documented participant without a private key for later seal/settlement commands; swap the order or pass --as human.ada when generating the key.

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Make the quick-start quest claimable

In a fresh checkout, copying this block does not produce a claimable quest: src/cli/commands/ingest.ts registers quest with a required --campaign <id> option and creates the node with status PLANNED, while src/cli/commands/coordination.ts rejects claim unless the quest is already READY. As written, the quick start exits at the missing option, and even after adding it the later claim fails unless the flow also satisfies readiness and runs ready first.

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
```

![XYPH](./docs/assets/xyph.png)
---

## 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).
2 changes: 1 addition & 1 deletion docs/diagrams/cycle-loop.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/milestone-lifecycle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/orchestration-fsm.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/planning-pipeline.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/quest-status-lifecycle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/task-lifecycle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/teardown-cli-context.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/teardown-domain-entities.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/teardown-hexagonal-arch.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/teardown-jsonl-types.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/teardown-schema.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/teardown-submission-lifecycle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/diagrams/vision-tenets.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/diagrams/xyph-edict-sequence.mmd
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
1 change: 1 addition & 0 deletions docs/diagrams/xyph-edict-sequence.mmd.sha256
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1da7fe54b522885ce6789ed228ee5c4879ffd84026a4fa227af08b26e11970a4
1 change: 1 addition & 0 deletions docs/diagrams/xyph-edict-sequence.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/diagrams/xyph-evolution-shifts.mmd
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
1 change: 1 addition & 0 deletions docs/diagrams/xyph-evolution-shifts.mmd.sha256
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
43429bf4e95415aae178acd900a961ed4f30db5eb2024f9d92faa23ee3c033ff
1 change: 1 addition & 0 deletions docs/diagrams/xyph-evolution-shifts.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading