Name: uDos expands to Universal Device Operating Surface. The capital D is intentional (uDos, not udos or uDOS in new copyβsee docs/dev-process-v4.md).
GitHub: https://github.com/fredporter/uDosGo β clone locally as ~/Code/uDosGo/ (family convention).
Integration release line: VERSION (0.1.0) + CHANGELOG.md describe Round 9 β integration tests, ops endpoints (/health, /ready, /metrics), Docker Compose under docker/, backup/restore scripts, monitoring templates, and doc set under docs/ (see docs/integration-architecture.md). This is demo / staging readiness, not a full production warranty.
Repo meta / dev standard: root package.json version 4.x tracks the family dev process (see docs/dev-process-v4.md). v3.0.1 below is the planning / demo release name for this integration monorepo β not the same axis as UniversalSurfaceXDβs release line or uDosDev governance versioning.
v3.0.1 is the first public-facing planning release for a single, runnable local loop: ThinUI submits and inspects work, Hivemind plans and routes it, Host executes and persists it, WordPress provides local identity, privacy, and restricted pages, and everything lands on a mounted vault/workspace.
This repository is the v3 monorepo target. Implementation may start empty; the planning pack lives under docs/ and packages/schemas/.
Family v4 β Cursor / VS Code: open uDosGo.code-workspace at the repo root (simple ../ paths to ~/Code/ siblings). The same folder set is also available as ~/Code/uDosGo.code-workspace when you open the workspace file next to your sibling clones (no ../ in paths). Focused lanes (same repos, paths from workspaces/): workspaces/README.md β uDOS-v4.code-workspace, Linkdown-v4.code-workspace, uMacDown-v4.code-workspace.
A local-first orchestration demo where ThinUI submits and inspects work, Hivemind plans it, Host executes it, WordPress handles identity/privacy/restricted local pages, and all outputs persist to a mounted vault/workspace.
udos-empire-local./udos-data layout: vault, spool, events, exports, wordpress, backups.Not the whole uDOS family. Not the full product vision. One clean loop.
Full index: docs/README.md β sections for start-here, system design, specifications, style guide, delivery, schemas.
| Doc | Purpose |
|---|---|
| docs/QUICKSTART.md | First-time setup + install/run path |
| docs/SCOPE-v3.0.1.md | In scope / out of scope (locked) |
| docs/ARCHITECTURE.md | Boundaries, data flow, module contracts |
| docs/specs/README.md | Specifications hub (USXD, engines, schema paths, ThinUI lab) |
| docs/specs/RETRO_COMMAND_ALIASES_v4.md | Locked β retro CLI aliases (PEEK/POKE, β¦) + @udos/shared resolver; ThinUI feed + npm run retro:line |
| Sonic v4 brief (family) | uDosDev SONIC_SCREWDRIVER_v4_COMPLETE_BRIEF.md Β· flashable OS: SONIC_v4_FLASHABLE_OS_IMAGES.md Β· npm run blocktext |
| uCode v4 implementation lock (family) | uDosDev UCODE_v4_IMPLEMENTATION_LOCK.md |
| docs/GRID-GRAPHICS-CANON.md | Locked 80Γ30, 16Γ24, teletext bridge, UniversalSurfaceXD pairing |
| docs/style-guide.md | Style guide β tokens, typography, USXD usxd/0.1 frontmatter, ASCII vs teletext |
| TUI β ASCII animation (family) | uDosDev TUI_ASCII_ANIMATION_TOOLKIT_v1.0.0.md β packages/tui-ascii (@udos/tui-ascii); Host GET /api/v1/meta/shell-palette; Sonic sonic palette / sonic ascii |
| docs/DEMO.md | Gold-path scenario, expected outputs, operator steps |
| docs/DATA-MODEL.md | Persistence layout, schemas, truth model |
| docs/WP-BRIDGE.md | Empire β WordPress bridge design |
| docs/MILESTONES.md | Build order + checklist |
| docs/BACKLOG.md | v3.0.1 closure + deferred work |
| docs/ROADMAP.md | After v3.0.1 (split repos, depth) |
| docs/REPO-SPLIT-PREP.md | Checklist for extracting Host / ThinUI / hivemind repos |
| docs/FILE-TREE.md | Exact monorepo tree + scaffold notes |
JSON Schema drafts live in packages/schemas/: usxd-surface (usxd/0.1), feed, task, event, contact, user-link, provider-policy. Example surfaces: examples/usxd-surface-canonical.example.json, examples/usxd-surface-minimal.example.json (npm run validate:usxd checks all USXD surfaces under examples/).
The broader uDos family workspace may keep historical modules (uDOS-host, uDOS-thinui, β¦). v3.0.1 consolidates the demo into this monorepo shape first; split back to separate repos only after the demo is solid.
See also: ../uDosConnect/uDosDev/docs/v3-system-brief.md (bootstrap brief; sibling under ~/Code/).
Portable surface vocabulary, interchange JSON, Figma handoff, and the browser UX designer live in the open-source repo github.com/fredporter/UniversalSurfaceXD (MIT). Optional local checkout: sibling ../UniversalSurfaceXD under ~/Code/ (same level as this repo). This monorepo is the runnable uDos integration; UniversalSurfaceXD is the composer + lab + interchange side. Keep packages/schemas and ThinUI copy aligned with UniversalSurfaceXD/interchange/ when contracts change.
Use docs/QUICKSTART.md for complete first-time installation and setup.
Fast path:
npm install
npm run doctor
npm run launch:open
Round 9 checks: make test-all (workspace unit tests + integration), npm run health (Host liveness), docker compose -f docker/docker-compose.yaml config (validate stack file). Contributor setup: ./scripts/dev-setup.sh β see CONTRIBUTING.md.
http://127.0.0.1:8787http://127.0.0.1:5173Optional WordPress (steps 8-9):
npm run wp:up
npm run demo:wp-bootstrap
npm run demo:wp-link
Convenience launchers:
uDOS-Dev.command / uDOS-Dev+WP.commanduDOS-Dev.cmd / uDOS-Dev+WP.cmdnpm run dev # Host + ThinUI (watch) β same as launch after install
npm run start # build, then Host (node) + ThinUI (vite preview) β no watch
npm run host:dev # Host only (tsx watch)
npm run thinui:dev # ThinUI only
npm run host:start # Host only (run `npm run build` first)
npm run demo:seed # POST gold-path input to Host (needs Host running); --dry-run supported
npm run demo:seed:inbox # POST inbox-thread sample β `thread-{id}.md` vault stem
npm run build # sdk + hivemind + host + thinui (starts with validate:usxd)
npm run validate:usxd:verbose # USXD validation + log skipped JSON under examples/
WordPress (Docker, optional): persistent tree matches Host at ./.udos-data/wordpress.
npm run wp:up # WordPress http://127.0.0.1:8080 + MySQL (see infra/docker/README.md)
npm run wp:down
Requires Docker. Fast path (no browser wizard): after npm run wp:up, run npm run demo:wp-bootstrap then log in as Subscriber demo (password printed to the terminal; also in demo/.wp-demo.env). For the contact link, run npm run demo:wp-link. Alternatively, complete the WordPress install wizard in the browser and activate uDOS Empire Local under Plugins.
Bridge: Host probes WordPress at UDOS_WP_BASE_URL (default http://127.0.0.1:8080) via GET /api/v1/bridge/wordpress β GET /wp-json/udos-empire/v1/health. ThinUI shows the JSON when VITE_UDOS_WP_URL is set (see apps/thinui/.env.development).
Note: @udos/thinui depends on @udos/sdk via file:../../packages/sdk for broad npm compatibility.