Skip to content

workspace-layout.md

Latest commit

 

History

History
63 lines (51 loc) · 3.42 KB

workspace-layout.md

File metadata and controls

63 lines (51 loc) · 3.42 KB
Raw

Workspace layout

For maintainers. Using T3 Code? See docs/user.

A pnpm workspace driven by vite-plus (vp). See scripts.md for the task commands.

apps

  • apps/server (t3): the execution runtime and the published CLI. Owns orchestration, provider drivers, checkpointing, VCS, terminals, filesystem access, auth, and the HTTP + WebSocket surface. Also serves the built web app.
  • apps/web (@t3tools/web): React + Vite UI. Consumes the shared client runtime and adds routing, components, and web-specific platform layers.
  • apps/desktop (@t3tools/desktop): Electron shell. Supervises a desktop-scoped t3 backend, loads the web bundle over the t3code:// protocol, and owns SSH-managed remote environments.
  • apps/mobile (@t3tools/mobile): Expo/React Native client. Same client runtime composition as web, different platform layer and UI.
  • apps/marketing (@t3tools/marketing): Astro marketing site.

packages

  • packages/contracts (@t3tools/contracts): shared Effect Schema definitions. RPC group, orchestration commands/events/read model, auth scopes, environment descriptors, settings.
  • packages/shared (@t3tools/shared): framework-agnostic utilities used by server and clients (DrainableWorker, git and source-control helpers, relay auth and signing, DPoP, semver, logging, observability, and more).
  • packages/client-runtime (@t3tools/client-runtime): connection lifecycle, authorization, RPC session, environment registry, and Atom-based domain state shared by web and mobile. See its README.
  • packages/ssh (@t3tools/ssh): SSH config parsing, auth prompts, command execution, and the tunnel/environment manager behind desktop-managed SSH environments.
  • packages/tailscale (@t3tools/tailscale): Tailscale CLI wrapper, including the ensureTailscaleServe / disableTailscaleServe serve lifecycle the server drives.
  • packages/effect-acp (effect-acp): Effect client and agent implementation of the Agent Client Protocol, used by ACP-speaking provider drivers.
  • packages/effect-codex-app-server (effect-codex-app-server): Effect client for the codex app-server JSON-RPC protocol.

infra

  • infra/relay (t3code-relay): the hosted T3 Connect relay, deployed with Alchemy. Handles environment discovery, cloud-side records, and mobile notifications. It is not in the hot path; after connect, client traffic goes directly to the environment. See t3-connect.md.

Other top-level directories

  • scripts/: workspace tooling run through vp run. Dev runner, desktop artifact builds, release helpers, mobile static checks and showcase capture, update-manifest merging.
  • assets/: brand and app icon sources per channel (dev, nightly, prod).
  • patches/: pnpm patches for pinned upstream dependencies.
  • oxlint-plugin-t3code/: repo-specific lint rules.
  • experiments/: throwaway prototypes. Not part of the shipped build.
  • docs/: this documentation tree.

Import conventions

@t3tools/shared and @t3tools/client-runtime use explicit subpath exports with no barrel index and no root export. Import the narrow path (@t3tools/shared/DrainableWorker, @t3tools/client-runtime/state/threads) rather than the package root. Files that are not exported are implementation details. @t3tools/contracts does export a root alongside ./settings and ./relay.