Skip to content

System overview ​

Requireganizer is a Next.js application with a MobX State Tree project model, an agentic AI conversation runtime, IndexedDB recovery/activity stores, and a VitePress documentation site.

Main boundaries ​

BoundaryResponsibility
Screens and componentsReview and edit artifacts, show statuses and impact, issue conversation commands.
Project storeOwn schema-v2 artifacts, exact revision bindings, fingerprints, the conversation transcript, virtual files, import/export, and atomic state transitions.
Contract domainDefine boundary, formal-contract, structured-test, setup types and authoritative validation.
AI agent (app/ai-agent/)Run a continuous pi-agent conversation: one system prompt, short structured commands per user action, artifact reads through tools, and validated result tools that apply proposals.
AI proxy (app/api/ai/proxy)Stream LLM requests to the OpenCode Zen gateway with the server-held credential; never expose keys to the browser.
Browser databasesPartition provider calls and recovery snapshots per project.

Request path ​

text
User action → prerequisite check → structured command ({"kind":"generate","stage":...})
→ continuous conversation turn (pi agent loop)
→ read tools fetch live artifacts from the store → model reasons
→ submit_* result tool → authoritative parse + semantic validation
→ proposal applied atomically (or validation error returned to the model for self-repair)

The conversation transcript persists with the project; thinking and tool activity stream into the overlay dialog while a command runs.

Source layout ​

text
app/contract-domain/   revisioned artifact types, schema projection, validation, hashing
app/ai-harness/        formal tool schemas, parsers, workflow definitions, test-code guards
app/ai-agent/          conversation engine: system prompt, commands, read/result tools, proxy client
app/api/ai/proxy/      credential-holding streaming proxy to the LLM gateway
app/store/             project model, status, client orchestration, import/export
app/lib/               browser persistence and safe filesystem utilities
docs/                  VitePress product and engineering contracts
tests/                 agent tools, domain, state, persistence, and rendering tests

Design principles ​

  • Ground implementation formalization in complete, validated upstream artifacts; a newer revision supersedes the old one.
  • Generate tests only from exact approved contract revisions.
  • Treat provider schemas as transport hints and runtime validation as authoritative.
  • Commands say when to work; artifacts are read through tools, never embedded in prompts.
  • Validation errors flow back into the conversation so the model repairs its own proposals.
  • Keep project behavior out of scaffold seams.
  • Preserve stale work for inspection and block it from further generation.
  • Snapshot before applying a revision with downstream impact.
  • Keep the virtual project filesystem separate from the Code workflow stage.

Released under the MIT License.