whirl README

The project's README from github.com/whirlchat/whirl. As one markdown file: README.md.

The Whirl mark

Whirl

The AI chat app that sweats the details. Every top model, real memory,
living documents, and your own tools, in one fast and friendly place.

whirl.chat · Self-hosting · Architecture · Contributing

Whirl is a full-stack AI chat app built on Next.js and Convex. It's the code behind whirl.chat, published in full under the MIT license. Read it, run your own, or help make it better.

Features

Tech stack

Layer What it uses
Web app Next.js 16, React 19, Tailwind CSS v4, Motion
Backend Convex: database, functions, streaming, crons
Auth Clerk
Models OpenRouter via the AI SDK
Tooling Bun workspaces, TypeScript

Everything beyond Convex, Clerk, and OpenRouter is optional and switches on with its own keys: billing (Autumn), web search (Exa), memory (Supermemory), analytics (PostHog, Axiom), tracing (Braintrust), email (Resend), and the support agent (Median). Leave them out and Whirl hides the features they power. See docs/configuration.md.

Quick start

You'll need Bun, a free Convex account, a Clerk application, and an OpenRouter API key.

git clone https://github.com/whirlchat/whirl.git
cd whirl
bun install

# 1. Create a Convex dev deployment and push the backend.
cd packages/backend
bunx convex dev            # first run walks you through creating a project

# 2. In another terminal, give the backend its secrets.
bunx convex env set CLERK_JWT_ISSUER_DOMAIN https://your-instance.clerk.accounts.dev
bunx convex env set OPENROUTER_API_KEY sk-or-v1-...

# 3. Point the web app at Convex and Clerk.
cd ../../apps/v2
cp .env.example .env.local  # then fill in the four required values

# 4. Run everything from the repo root.
cd ../..
bun run dev

Open localhost:3000 and say hi. The self-hosting guide covers each step in detail, including the Clerk JWT template Convex needs and how to deploy to production.

Repository layout

apps/
  v2/         The web app (Next.js). This is the one in production.
  console/    Admin console for models, integrations, and skills (Vite)
  mobile/     Native app (Expo)
  waitlist/   Standalone waitlist page
  remotion/   Promo video compositions
  legacy/     The previous web app, kept for reference. Not maintained.
packages/
  backend/    Convex backend: schema, functions, and the AI pipeline
docs/         Guides for self-hosting, configuration, and architecture
brand/        Logo, colors, banners, and app icons

Documentation

Contributing

Bug reports, ideas, and pull requests are all welcome. Start with CONTRIBUTING.md, and please follow the code of conduct. Found a security issue? See SECURITY.md.

License

MIT © Anterra

whirl (whirlchat/whirl)

Searching Database…

508 ·GitHub
Whirl
What is this?Whirl is a full-stack AI chat app built on Next.js and Convex. It is the open-source code behind whirl.chat, routing conversations through OpenRouter to top models while adding memory, living documents, and tool integrations.
Is this just the code for whirl.chat, or can I run my own copy?It is the full source behind whirl.chat, published under MIT so you can read it, self-host your own instance, or contribute back.
How do I get it running, and what accounts do I need first?You need Bun, a free Convex account, a Clerk application, and an OpenRouter API key; after wiring those up you open localhost:3000. The self-hosting guide covers the Clerk JWT template Convex needs and production deployment.
What happens if I skip the optional integrations like billing or web search?Everything beyond Convex, Clerk, and OpenRouter (billing via Autumn, web search via Exa, memory via Supermemory, analytics, tracing, email, support agent) is optional and keyed separately; if you leave a key out, Whirl simply hides the feature it powers.
Can I use it on my phone?Yes, Whirl can be installed as a mobile web app (PWA) in addition to running in a desktop browser.
What happens to data in locked chats?Locked chats are encrypted on your device with a password the server never sees, and they are only answered by zero-retention AI models.
What is a living document in Whirl?Living artifacts are documents, charts, and full interactive pages that stay editable in a side panel and can be shared by link, instead of being static chat replies.
How does Whirl connect to my own tools?Through MCP integrations with OAuth support, plus installable skills that teach Whirl new abilities beyond basic chat.
Does Whirl remember things across conversations?Yes, it has long-term memory that carries your preferences and projects across chats, optionally backed by the Supermemory service.
Which AI models can I talk to?Every top model is available in one conversation, routed through OpenRouter, with adjustable thinking levels per model.
What are similar projects?open-glean, LibreChat, onyx, boardui, searchmirror, crm, os, jevbox
Which topics is it in?ai-chat, mobile-web, billing, web-search, voice, openrouter, pwa, bun, chat, analytics, agent-memory, tailwindcss
Creator
whirlchat
Size
5.1 MB
Stars
508
Updated
CommitOct 14
Age
15d
Commits · 90 Days