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.
npm install --global @clank.run/frameworkBuild with your agent
Copy this prompt into your coding agent, add your app idea, and let it set up Clank and build your first working flow.
Read the setup walkthroughSet up my development environment and start building an app with Clank.
App name: [My App]
Project directory: [my-app]
App idea and first useful user flow: [Describe who it is for and what they should be able to do.]
Do the setup and implementation, not just a plan. Use the published
@clank.run/framework npm package; the unscoped clank package is unrelated.
Do not clone the framework repository to build my application.
1. Inspect the environment.
Identify the OS, shell, working directory, and any existing application.
Read relevant README.md and AGENTS.md files and inspect existing changes.
Reuse an existing Clank app when present; do not overwrite unrelated work.
If my app idea is still a placeholder, ask what I want to build while
completing the environment checks that do not depend on that answer.
2. Install missing prerequisites.
Run node --version and npm --version. Prefer Node 24 LTS with npm 10+;
Clank supports Node >=22.16 and <27. Keep an existing supported version.
If Node/npm is missing or unsupported, use the existing version manager
or an official installer appropriate to this OS. Explain any step that
needs my administrator access, then resume after I complete it. Verify
the installed versions and PATH in the shell that will run the app.
SQLite and the TypeScript/TSX compiler are included. Do not install a
separate database server, Docker, or another framework toolchain for
the default starter.
3. Install and inspect Clank.
Run npm install --global @clank.run/framework@latest, then clank --version
and clank templates --json. If global installation is unavailable, use
npm exec --yes --package=@clank.run/framework@latest -- clank <arguments>
for these CLI commands instead of using sudo or installing unscoped clank.
Read https://docs.clank.run/llms.txt and the relevant current guides;
verify available commands with clank help --json rather than guessing APIs.
4. Create the application and install its dependencies.
For a new app, use auth-todo as the default authenticated full-stack
starter unless another listed template better fits my request:
clank create <project-directory> --template auth-todo --name "<app-name>" --json
Enter the generated directory and run npm install. This also installs
the starter's Tailwind build dependencies. Keep package-lock.json.
Run npm audit, review any findings, apply compatible fixes, and report
unresolved advisories. Do not force breaking dependency changes.
If this is an existing Clank app, follow its setup instructions instead
of scaffolding over it. Read its generated README.md and AGENTS.md.
5. Verify the starter before changing it.
Run npm test, npm run doctor, and npm run deploy:check. Fix local setup
failures first. These checks do not require a hosted Clank account;
report optional login/project-link notices separately from failures.
Keep this application separate from Clank's own source repository.
6. Build the first useful flow from my app idea.
Edit src/, not generated dist/. Put schemas, validation, permissions,
and trusted data operations in src/backend.ts; UI in src/view.tsx;
browser coordination in src/app.tsx; and routes/SSR in src/server.tsx.
Preserve authentication, user-owned data isolation, live updates, and
the shared typed browser/MCP action contract. Use explicit workspace
authorization for shared data. Add numbered migrations without changing
applied migrations. Keep secrets and local databases out of source control.
Add or update the app-owned tests for the behavior I asked for.
7. Run and test the actual app.
Run npm run dev -- --host=127.0.0.1 and verify its reported local URL
and /healthz. Use disposable local accounts to check registration/login,
the main user flow, and account isolation. Check browser errors and a
phone-width layout when browser tools are available; otherwise state
which browser checks you could not perform. If the app uses queued
jobs, run npm run jobs:worker in a separate terminal.
Re-run npm test, npm run doctor, and npm run deploy:check after changes.
8. Hand over a working development app.
Leave the development server available and report the project directory,
Node/npm/Clank versions, local URL, implemented flow, commands and results,
and any remaining blockers. Include how to restart the app and its worker.
Do not create cloud resources or deploy publicly unless I ask for that.Replace the three bracketed values before sending. You can also select and copy the prompt below its copy button.
Running in four commands.
The npm package creates a complete application with safe defaults. Install, scaffold, resolve the one dependency, and start the server.
- 01Install the CLI
npm install --global @clank.run/framework - 02Create an app
clank create my-app - 03Install its locked package
cd my-app && npm install - 04Run it locally
npm run dev
Everything needed to build.
The browser, server, database, agent contract, and deployment artifact use one versioned TypeScript package.
Continue from a working app.
Start with the generated application, then open only the guide needed for the next product change.
Edit typed TSX, add signals and forms, preserve SSR, and style with Tailwind.
Open the framework guide →Add product dataBackend, auth, and SQLiteDeclare validated functions and user-owned tables with inferred client types and live queries.
Open the full-stack guide →DeployShip from the terminalLogin, projects, secrets, migrations, verified artifacts, logs, backups, and rollback.
Read the guide →Connect an agentUse the app's queries and mutationsEvery backend is its own authenticated MCP server, with typed tools that stay aligned with the UI.
Open the MCP guide →Every maintained guide.
109 documents and 202,200 words, versioned with the npm package and built from the canonical source.
Start with npm
Install the package, create an app, choose its shape, and ship the first working version.
Framework
The reactive runtime, rendering model, routing, forms, UI behavior, and public APIs.
Full stack
Server rendering, live SQLite data, authentication, migrations, services, and observability.
Agents and generation
Deterministic blueprints, authenticated application actions, and contracts that make applications legible to agents.
Deploy and operate
The CLI, control plane, releases, custom domains, organizations, and production hosting.
Security and resilience
Threat boundaries, verification evidence, failure testing, recovery, and platform hardening.
Project
Maintenance, compatibility, releases, contribution rules, and the open-source project record.