# Tau Documentation

## Agent Tools
- [Agent Tools](https://docs.tau.new/editor/agent-tools): Use arrange_workbench to show views, files, and panes while preserving a person's current Tau arrangement.

## External Agents
- [External Agents](https://docs.tau.new/editor/external-agents): Run Codex, Claude Code, or Grok Build inside a Tau project through its own CLI and login.

## Documentation
- [Editor](https://docs.tau.new/editor): The browser-based parametric CAD workspace at tau.new, pairing a code editor, 3D viewport, and AI chat.
- [Runtime](https://docs.tau.new/runtime): A multi-kernel CAD runtime for browser, Node.js, and native desktop hosts.

## Workbench Records
- [Workbench Records](https://docs.tau.new/editor/workbench-records): Read and author portable layout, view, and per-entry JSON records with @taucad/workbench.

## Api
- [Bundler API](https://docs.tau.new/runtime/api/bundler): defineBundler, esbuild factory, and bundler types for JS/TS kernel input processing.
- [Client API](https://docs.tau.new/runtime/api/client): Create typed runtime clients, open documents, subscribe to views, and export committed evaluations.
- [Compute Reuse API](https://docs.tau.new/runtime/api/compute-store): Bind an authority-owned compute store and distinguish resident reuse, batched publication, and durable retention.
- [Configuration API](https://docs.tau.new/runtime/api/configuration): Define, admit, project, and validate versioned runtime configuration without treating form metadata as authority.
- [Electron Runtime API](https://docs.tau.new/runtime/api/electron): Broker isolated utility hosts through main, preload, renderer, and utility process boundaries.
- [Filesystem API](https://docs.tau.new/runtime/api/filesystem): Filesystem constructors, bridge adapters, and types for connect-time handles plus kernel I/O.
- [Framework Integrations API](https://docs.tau.new/runtime/api/frameworks): Vite, React Router, Next.js, Electron, and browser-worker helpers for configuring and hosting @taucad/runtime.
- [Host Authority API](https://docs.tau.new/runtime/api/host): Admit scoped jobs and machines sessions, advertise capabilities, and own a Node machine host.
- [Jobs API](https://docs.tau.new/runtime/api/jobs): Job submission, provider declarations, lifecycle projections, and recovery contracts.
- [Kernel Plugins](https://docs.tau.new/runtime/api/kernels): First-party kernel toolkits and role factories.
- [Machine Provider API](https://docs.tau.new/runtime/api/machine-providers): Declare physical machine capabilities and implement bounded discovery, connection, observation, and effects.
- [Machines API](https://docs.tau.new/runtime/api/machines): Discover and bind physical machines, read their directory, and preflight, transfer, or control prints.
- [Middleware API](https://docs.tau.new/runtime/api/middleware): Declare operation wrappers, file dependencies, content providers, and typed middleware state.
- [Runtime Protocol API](https://docs.tau.new/runtime/api/protocol): Schema-derived document calls, commands, notifications, and binary delivery for custom transports.
- [Testing Utilities](https://docs.tau.new/runtime/api/testing): Public-client test harnesses, mocks, and geometry assertions for runtime plugin authors.
- [Transport API](https://docs.tau.new/runtime/api/transport): Consumer topology helpers and author-facing transport contracts for document delivery, timeout recovery, and typed closure.
- [Core Types](https://docs.tau.new/runtime/api/types): Operation results, artifacts, kernel authoring contracts, issues, and capability types.

## Concepts
- [Architecture](https://docs.tau.new/runtime/concepts/architecture): How documents, plugins, transports, and rooted filesystems compose a kernel-independent runtime.
- [Interactive Architecture](https://docs.tau.new/runtime/concepts/interactive-architecture): An interactive, explorable version of the runtime's three-thread architecture diagram.
- [Kernel Selection](https://docs.tau.new/runtime/concepts/kernel-selection): How the runtime selects the right kernel for each file.
- [Middleware Model](https://docs.tau.new/runtime/concepts/middleware-model): The onion-model middleware pattern used for intercepting and transforming kernel operations.
- [Path Namespaces](https://docs.tau.new/runtime/concepts/path-namespaces): How consumer source paths, plugin entry paths, and host filesystem roots relate.
- [Plugin System](https://docs.tau.new/runtime/concepts/plugin-system): Toolkit factories, presets, capability expansion, and direct buckets.
- [Render Lifecycle](https://docs.tau.new/runtime/concepts/render-lifecycle): How document evaluation, independent views, exports, and cancellation share runtime ownership.
- [Worker Model](https://docs.tau.new/runtime/concepts/worker-model): How execution hosts isolate kernels, own document resources, and connect to rooted filesystems.

## Getting Started
- [Installation](https://docs.tau.new/runtime/getting-started/installation): Install @taucad/runtime and wire it into your framework.
- [LLMs.txt](https://docs.tau.new/runtime/getting-started/llms-txt): Feed Tau Runtime docs into AI tools via llms.txt and per-page markdown endpoints.
- [Quick Start](https://docs.tau.new/runtime/getting-started/quick-start): Render your first 3D model with @taucad/runtime in under 4 minutes.
- [Your First Kernel](https://docs.tau.new/runtime/getting-started/your-first-kernel): Build a parametric model with the Replicad kernel, override its parameters, and export glTF and STEP.

## Guides
- [Configure the Bundler](https://docs.tau.new/runtime/guides/bundler-configuration): Configure the esbuild bundler for TypeScript and JavaScript kernel inputs, or define a custom bundler.
- [Bundling](https://docs.tau.new/runtime/guides/bundling): One plugin import per supported bundler ships the runtime's WASM kernels and dynamic assets.
- [Choose a Kernel](https://docs.tau.new/runtime/guides/choosing-a-kernel): Select and compose first-party CAD kernel plugins.
- [Cooperate with Cancellation](https://docs.tau.new/runtime/guides/cooperate-with-cancellation): Use the operation-scoped AbortSignal in middleware, kernels, dependency hooks, and custom bundlers.
- [Cross-Origin Isolation](https://docs.tau.new/runtime/guides/cross-origin-isolation): Configure COOP, COEP, and CORP headers so SharedArrayBuffer-backed kernels (multi-threaded WASM and geometry pool) load on every browser, including Safari.
- [Create a Custom Kernel](https://docs.tau.new/runtime/guides/custom-kernel): Build a kernel plugin using defineKernel to integrate a new CAD engine.
- [Create Custom Middleware](https://docs.tau.new/runtime/guides/custom-middleware): Build middleware with defineMiddleware to intercept and transform kernel operations.
- [Embedding in a Host](https://docs.tau.new/runtime/guides/embedding-in-a-host): Wire @taucad/runtime into an editor host with opaque rooted filesystems and explicit transport ownership.
- [Handle Errors](https://docs.tau.new/runtime/guides/error-handling): Distinguish model issues, normal supersession, cancellation, deadlines, and transport termination.
- [Set Up the Filesystem](https://docs.tau.new/runtime/guides/filesystem-setup): Configure Node.js, in-memory, or browser-based filesystems for kernel input.
- [Capture Camera Views](https://docs.tau.new/runtime/guides/headless-camera-capture): Render fitted views, exact viewer cameras, and editable preset batches to lossless images.
- [Live Rendering](https://docs.tau.new/runtime/guides/live-rendering): Open a watched document, subscribe to independent views, and update parameters or projection options.
- [Configure Render Timeouts](https://docs.tau.new/runtime/guides/render-timeouts): Set operation deadlines, handle typed timeout failures, and recover isolated runtime hosts.
- [Test Kernels](https://docs.tau.new/runtime/guides/testing-kernels): Test runtime plugins through the public client path and unit-test definitions with focused mocks.
- [Use Middleware](https://docs.tau.new/runtime/guides/using-middleware): Add caching, parameter resolution, and glTF edge detection to your kernel pipeline.

## Reference
- [Build123d](https://docs.tau.new/runtime/reference/build123d): Author trusted native Python CAD projects in Tau Desktop.
- [Replicad Examples](https://docs.tau.new/runtime/reference/replicad): Replicad model reference with runtime setup and source samples.
- [tscircuit](https://docs.tau.new/runtime/reference/tscircuit): Author electronics boards in TSX and render them as 3D, schematic, or PCB.