puter/paseo
1
0
Fork 0
mirror of https://github.com/getpaseo/paseo.git synced 2026-07-29 12:01:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c65a851205a611ce0e06c8f67d33fed9b9efa878
paseo/CLAUDE.md
Mohamed Boudra 1e9b7f1157 fix: make worktreeRoot backward-compatible for old clients/daemons 
worktreeRoot was added as a required field in 9154f8fc, which breaks
old clients parsing new daemon responses and new clients parsing old
daemon responses. Made it .optional() with .transform() fallbacks.

Also added a critical rule to CLAUDE.md: schema changes must always
be backward-compatible in both directions.
2026-04-04 20:29:44 +07:00

3.1 KiB
Raw Blame History

CLAUDE.md

Paseo is a mobile app for monitoring and controlling your local AI coding agents from anywhere. Your dev environment, in your pocket. Connects directly to your actual development environment — your code stays on your machine.

Supported agents: Claude Code, Codex, and OpenCode.

Repository map

This is an npm workspace monorepo:

  • packages/server — Daemon: agent lifecycle, WebSocket API, MCP server
  • packages/app — Mobile + web client (Expo)
  • packages/cli — Docker-style CLI (paseo run/ls/logs/wait)
  • packages/relay — E2E encrypted relay for remote access
  • packages/desktop — Electron desktop wrapper
  • packages/website — Marketing site (paseo.sh)

Documentation

Doc What's in it
docs/ARCHITECTURE.md System design, package layering, WebSocket protocol, agent lifecycle, data flow
docs/CODING_STANDARDS.md Type hygiene, error handling, state design, React patterns, file organization
docs/TESTING.md TDD workflow, determinism, real dependencies over mocks, test organization
docs/DEVELOPMENT.md Dev server, build sync gotchas, CLI reference, agent state, Playwright MCP
docs/RELEASE.md Release playbook, draft releases, completion checklist
docs/ANDROID.md App variants, local/cloud builds, EAS workflows
docs/DESIGN.md How to design features before implementation
SECURITY.md Relay threat model, E2E encryption, DNS rebinding, agent auth

Quick start

npm run dev                          # Start daemon + Expo in Tmux
npm run cli -- ls -a -g              # List all agents
npm run cli -- daemon status         # Check daemon status
npm run typecheck                    # Always run after changes

See docs/DEVELOPMENT.md for full setup, build sync requirements, and debugging.

Critical rules

  • NEVER restart the main Paseo daemon on port 6767 without permission — it manages all running agents. If you're an agent, restarting it kills your own process.
  • NEVER assume a timeout means the service needs restarting — timeouts can be transient.
  • NEVER add auth checks to tests — agent providers handle their own auth.
  • Always run typecheck after every change.
  • NEVER make breaking changes to WebSocket or message schemas. The mobile app in the App Store always lags behind the daemon, and daemons in the wild lag behind new app releases. Both directions must work. Every schema change MUST be backward-compatible:
    • New fields: always .optional() with a sensible default or .transform() fallback.
    • Never change a field from optional to required.
    • Never remove a field — deprecate it (keep accepting it, stop sending it).
    • Never narrow a field's type (e.g. string → enum, nullable → non-null).
    • Test with: "does a 6-month-old client still parse this?" and "does a 6-month-old daemon still send something this client accepts?"

Debugging

Find the complete daemon logs and traces in the $PASEO_HOME/daemon.log