Official npm package · Clank 0.22.1

Install one package.
Ship the whole app.

@clank.run/framework includes the reactive TypeScript runtime, compiler, authenticated starter, live SQLite data, and deployment CLI. Create a working full-stack app without cloning this repository or assembling a toolchain.

Get started with npm →Choose an app shape
$npm install --global @clank.run/framework
1application dependency
0transitive dependencies
Built inauth, SSR, SQLite, live sync
Includedcompiler and deploy CLI
01 / Quick start

Running in four commands.

The npm package creates a complete application with safe defaults. Install, scaffold, resolve the one dependency, and start the server.

  1. 01
    Install the CLInpm install --global @clank.run/framework
  2. 02
    Create an appclank create my-app
  3. 03
    Install its locked packagecd my-app && npm install
  4. 04
    Run it locallynpm run dev
02 / One package

Everything needed to build.

The browser, server, database, agent contract, and deployment artifact use one versioned TypeScript package.

RuntimeSignals + TSXTyped UI and fine-grained updates→StarterAuth + live dataSSR and user-owned SQLite→CLIBuild + verifyCompiler, doctor, and artifacts→ShipVerified releasesMigrate, health-check, activate
03 / Learn by task

Continue from a working app.

Start with the generated application, then open only the guide needed for the next product change.

Build the UIComponents and reactivity

Edit typed TSX, add signals and forms, preserve SSR, and style with Tailwind.

Open the framework guide →Add product dataBackend, auth, and SQLite

Declare validated functions and user-owned tables with inferred client types and live queries.

Open the full-stack guide →DeployShip from the terminal

Login, projects, secrets, migrations, verified artifacts, logs, backups, and rollback.

Read the guide →Connect an agentUse the app's queries and mutations

Every backend is its own authenticated MCP server, with typed tools that stay aligned with the UI.

Open the MCP guide →
Machine-readable by default

Give your agent the whole framework.

Use the compact map for routing, the complete corpus for grounding, or the JSON endpoints for precise retrieval.

/llms.txtConcise guide map →/llms-full.txtComplete documentation →/api/docs.jsonStructured index →
04 / Complete reference

Every maintained guide.

77 documents and 135,359 words, versioned with the npm package and built from the canonical source.