# Clank

> An AI-first, dependency-free full-stack TypeScript framework and open-source deployment platform.

Canonical documentation: https://docs.clank.run
Framework version: 0.7.0

## Agent entry points

- [Complete documentation corpus](https://docs.clank.run/llms-full.txt)
- [Structured documentation index](https://docs.clank.run/api/docs.json)
- [Getting started](https://docs.clank.run/docs/getting-started)
- [Deployment CLI](https://docs.clank.run/docs/cli)
- [API reference](https://docs.clank.run/docs/api-reference)

## Start with npm

Install the package, create an app, choose its shape, and ship the first working version.

- [Getting started with the npm package](https://docs.clank.run/raw/getting-started.md): Install one npm package, create an authenticated full stack application, and run it locally. You do not need to clone the Clank repository or assemble a framework toolchain.
- [Application recipes for humans and agents](https://docs.clank.run/raw/application-recipes.md): This guide is the shortest path from an application request to a readable Clank implementation.
- [AI-first contracts](https://docs.clank.run/raw/ai-first.md): Clank separates model providers from application contracts. It does not dictate which model or SDK to use. Instead, it makes capabilities discoverable, inputs deterministic, side effects explicit, and the rendered interface machine readable
- [Public beta readiness](https://docs.clank.run/raw/public-beta.md): Clank's public beta is suitable for controlled self hosted evaluation once every gate below passes. “Beta” means the contracts are usable and tested, while operators should expect upgrade work and should not place irreplaceable or highly re

## Framework

The reactive runtime, rendering model, routing, forms, UI behavior, and public APIs.

- [Architecture](https://docs.clank.run/raw/architecture.md): The reactive kernel imports nothing. DOM depends only on the kernel. Routing depends on the kernel and DOM types. AI uses the kernel for action UI state and DOM types for described views. Forms depend on the kernel and schema contracts. Hea
- [Reactivity](https://docs.clank.run/raw/reactivity.md): Clank tracks reads while a computed value or effect is running. A signal write synchronously invalidates computed values and reruns only the effects that read the changed source. Effects are deduplicated inside a batch.
- [Rendering and components](https://docs.clank.run/raw/rendering.md): Clank compiles TSX into direct DOM construction and fine grained reactive bindings. There is no virtual DOM and no whole component rerender loop. A component executes once to establish structure; expressions update independently afterward.
- [Routing](https://docs.clank.run/raw/routing.md): tsx const router = createRouter({ routes: [ { path: "/", component: Home, title: "Home" }, { path: "/users/:id", component: User, title: match = User ${match.params.id} , load: async ({ params, signal }) = { const response = await fetch( /a
- [Forms](https://docs.clank.run/raw/forms.md): Clank forms are headless: the framework owns state, validation, accessible control wiring, submission, and cancellation while the application owns its HTML and Tailwind classes.
- [Headless UI behavior](https://docs.clank.run/raw/ui.md): Clank provides small state machines for behavior that is deceptively difficult to implement correctly. They return ordinary HTML props and directives rather than styled components, so Tailwind and application markup remain fully under your 
- [Tailwind CSS](https://docs.clank.run/raw/tailwind.md): Clank preserves class strings exactly and keeps styling outside its reactive kernel. Tailwind scans ordinary TSX such as:
- [Performance model](https://docs.clank.run/raw/performance.md): Clank uses compilation and fine grained subscriptions instead of rerendering component trees. A component function runs once when mounted. Its TSX expressions become independent bindings that subscribe only to the signals they actually read
- [API reference](https://docs.clank.run/raw/api-reference.md): This is the compact index of every public export. The focused guides contain behavioral details and examples.

## Full stack

Server rendering, live SQLite data, authentication, migrations, services, and observability.

- [Full-stack SSR, SQLite, and live sync](https://docs.clank.run/raw/full-stack.md): Clank's full stack layer follows one rule: write the runtime contract once and let TypeScript infer the rest. There is no generated client, ORM model, RPC interface, or duplicate DTO type to maintain.
- [Database revisions and correctness](https://docs.clank.run/raw/database.md): Clank uses Node's built in SQLite as a transactional document store. Application fields live as validated JSON, while identity, ownership, creation time, and document version live in dedicated columns.
- [SQLite migrations](https://docs.clank.run/raw/migrations.md): Framework document tables and indexes can still be created automatically. Deployment migrations cover relational support tables, columns, constraints, indexes, and SQL data changes.
- [Authentication](https://docs.clank.run/raw/auth.md): Clank auth is built into the same zero dependency SQLite, Fetch, SSR, and live query layer as the rest of the framework. An authenticated application needs one auth definition, owned tables for private data, and the auth first browser clien
- [Advanced authentication](https://docs.clank.run/raw/authentication.md): Clank's advanced authentication features extend the framework's default email/password flow with verification, recovery, MFA, passkeys, bot protection, and distributed rate limits. Authentication uses the application SQLite database. Passwo
- [Server primitives](https://docs.clank.run/raw/server.md): Clank's server layer targets the Fetch standard, not one vendor's runtime. The same app.handle(request) works anywhere with Web Request and Response objects.
- [Service drivers](https://docs.clank.run/raw/services.md): Clank keeps external services behind explicit, inspectable drivers. Generated blueprints write src/service requirements.ts , which records every named service, kind, capability, and whether production startup should require it.
- [Observability](https://docs.clank.run/raw/observability.md): One createObservability instance provides structured logs, W3C trace propagation, metrics, and readiness checks without a runtime package.
- [Managed ingress and external data](https://docs.clank.run/raw/data-plane.md): The data plane module separates public routing and provider managed SQL from application processes.

## Agents and generation

Deterministic blueprints and contracts that make applications legible to coding agents.

- [AI application blueprints](https://docs.clank.run/raw/blueprints.md): An application blueprint is the reviewable contract between a human request, an AI planner, generated source, and deployment resources.

## Deploy and operate

The CLI, control plane, releases, custom domains, organizations, and production hosting.

- [Deployment CLI](https://docs.clank.run/raw/cli.md): The clank executable contains both the compiler and deployment client. It does not install application dependencies or execute remote build hooks.
- [Deployment platform](https://docs.clank.run/raw/deployment-platform.md): Clank Deploy is the open source control plane for turning a Clank source directory into a running release. It uses Fetch, Node, SQLite, Web Crypto, and no runtime NPM dependencies.
- [Deployment dashboard, quotas, and domains](https://docs.clank.run/raw/platform-dashboard.md): Clank includes a dependency free browser console for operating projects, traffic, releases, logs, and custom domains. It is served by the same authenticated control plane as the CLI API; there is no separate dashboard service or browser pac
- [Organizations and deployment RBAC](https://docs.clank.run/raw/organizations.md): The Clank platform isolates projects through organizations. A project belongs to one organization, and every request checks current membership before reading project metadata, logs, releases, secrets, or deployment state.
- [Durable distributed deployment](https://docs.clank.run/raw/distributed-deployment.md): Clank deployment coordination is persisted in the control database. Process local maps are still used as an optimization, but correctness is protected by authenticated leases and monotonic fencing tokens.
- [Railway production deployment](https://docs.clank.run/raw/railway.md): This profile runs the Clank control plane and its trusted application processes in one Railway service. Railway terminates TLS and forwards every control plane and application hostname to the same listener; Clank then routes application hos
- [Self-hosting Clank Deploy](https://docs.clank.run/raw/self-hosting.md): Clank Deploy is one Node control plane process plus one supervised process or container per active project.
- [Release process](https://docs.clank.run/raw/releases.md): Clank releases are built from reviewed source, submitted through npm trusted publishing without a long lived registry token, and approved by a maintainer with two factor authentication.

## Security and resilience

Threat boundaries, verification evidence, failure testing, recovery, and platform hardening.

- [Security](https://docs.clank.run/raw/security.md): Clank treats browser input, agent input, URLs, cookies, request bodies, and persisted document data as untrusted. Secure defaults are applied in the framework, but deployment configuration and application authorization remain part of the bo
- [Platform security](https://docs.clank.run/raw/platform-security.md): The deployment platform has three principals: the browser account, an approved CLI bearer token, and deployed application code.
- [Threat model](https://docs.clank.run/raw/threat-model.md): This model covers the Clank framework, generated authenticated applications, CLI, control plane, deployment artifact path, managed ingress, service drivers, and backup system.
- [ASVS-oriented verification](https://docs.clank.run/raw/security-asvs.md): Clank uses OWASP ASVS 5.0.0 as a control vocabulary for the framework, generated applications, CLI, and deployment platform. This is an engineering evidence map, not an OWASP certification and not a claim that every application built with C
- [Code and product audit](https://docs.clank.run/raw/code-audit.md): This document records what was inspected, what changed, and what remains intentionally out of scope. It is evidence for maintainers, not a claim that any framework can make every application correct automatically.
- [Chaos and failure testing](https://docs.clank.run/raw/chaos-testing.md): Clank tests failures as state machine behavior, not only happy path output. The deterministic chaos suite runs under Node's test runner as part of every npm test and npm run check .
- [Packaged-release conformance](https://docs.clank.run/raw/conformance.md): npm run conformance proves the complete Clank golden path using a clean temporary installation of the package produced by npm pack .
- [Backup and disaster recovery](https://docs.clank.run/raw/recovery.md): Clank distinguishes deployment rollback from database recovery:

## Project

Maintenance, compatibility, releases, contribution rules, and the open-source project record.

- [Maintenance and release certification](https://docs.clank.run/raw/maintenance.md): This is the repeatable maintainer checklist for substantial framework or platform updates. It keeps the zero dependency promise, runtime behavior, security evidence, and documentation in one review path.
- [Renaming from Proact](https://docs.clank.run/raw/renaming-from-proact.md): Proact was renamed to Clank in version 0.7.0. The framework, deployment platform, package, CLI, generated applications, and public protocol names now use Clank.
- [Clank](https://docs.clank.run/raw/overview.md): Clank is a dependency free, AI first full stack TypeScript framework and open source deployment platform. It combines fine grained reactivity, direct DOM rendering, SSR with node preserving hydration, inference first server functions, built
- [Changelog](https://docs.clank.run/raw/changelog.md): Clank follows semantic versioning. Entries describe user visible framework, CLI, protocol, storage, security, and deployment changes.
- [Contributing to Clank](https://docs.clank.run/raw/contributing.md): Clank favors small public contracts, explicit security boundaries, deterministic behavior, and platform primitives over hidden dependency machinery.
- [Security policy](https://docs.clank.run/raw/security-policy.md): Security fixes are made for the latest published minor release. A fix may require upgrading when preserving an older contract would leave users exposed.
- [Community conduct](https://docs.clank.run/raw/code-of-conduct.md): Clank contributors and maintainers are expected to make participation respectful, safe, and productive.

## CLI discovery

- `clank help --json` returns the stable machine-readable command manifest.
- `clank doctor --json` returns structured project-readiness diagnostics.
- Prefer raw Markdown or JSON endpoints when exact commands and contracts matter.