README

AI-native, local-first personal knowledge management for writers and worldbuilders.

---

Quick Start

pnpm install
pnpm generate:types
pnpm desktop:dev

See CONTRIBUTING.md for full prerequisites (Node.js ≥22, pnpm ≥10, Rust stable, gitleaks, dprint, uv) and platform-specific setup details.

---

Architecture at a Glance

---

Documentation Map

Surface	Location	Description
Architecture	Inklings Codex / apps/codex/src/content/docs/	Architecture overview, systems, data flows
Getting Started	CONTRIBUTING.md	Prerequisites, setup, verification
Development Guide	docs/guides/development-guide.md	Methodology, vertical slicing, patterns
How-To Guides	docs/guides/	Task-oriented guides for common operations
Decisions	docs/ADR/	Architecture Decision Records (ADRs)
Solutions	docs/solutions/	Institutional knowledge base (85+ docs)
API Reference	cargo doc --open	Generated Rust API documentation
Contributing	CONTRIBUTING.md	Commit conventions, PR process, code standards
Agent Context	AGENTS.md	AI agent instructions and project context

---

Principles

Principle	What it means
Creation not configuration	Start creating immediately — customize later if you want
Local-first, portable by design	Data lives on the machine as a SQLite database — always available, no cloud required
AI-native from day one	AI is the primary interface, not an add-on
Seamless collaboration	Multi-device sync when chosen, offline always

---

Under the Hood

Each workspace is a single SQLite database. Tauri provides the desktop shell and IPC bridge between the Rust backend and the React frontend. An in-process MCP server exposes workspace content to external tools and AI agents without special integration. Rust types are projected to TypeScript via Specta (Rust-to-TypeScript type generation). The block editor is backed by a Loro CRDT (Conflict-free Replicated Data Type — enables offline editing with seamless sync), enabling persistent undo history across sessions and a path to real-time collaboration. Pages connect through wiki-links with bidirectional backlink tracking.

---

License

Proprietary software. See LICENSE for details.