Every Quark-scaffolded project ships with pre-configured context for popular AI coding tools. This means Claude Code, Cursor, GitHub Copilot, Continue.dev, Cody, and compatible tools understand your project's conventions, UI system, data layer, auth patterns, and deployment model from the moment you open the project.
After scaffolding, the fastest way to start building is a single focused prompt. The AI already knows your full stack from CLAUDE.md - you just tell it what to build.
Template:
I'm building [your-app-name] - [one sentence: what it does and who it's for].
The first feature I need is [describe the core thing: e.g. "a blog with posts, tags, and an author profile"].
Start by:
1. Reviewing CLAUDE.md so you understand the full stack
2. Adding the Prisma models to packages/db/prisma/schema.prisma
3. Creating query helpers in packages/db/src/queries.js
4. Building the pages in apps/web/src/app/ using our Tailwind UI componentsExample (SaaS with user workspaces):
I'm building Acme - a project management tool for small teams.
The first feature I need is a workspace + project structure: users belong to workspaces, workspaces have projects, projects have tasks.
Start by:
1. Reviewing CLAUDE.md
2. Adding Workspace, Project, and Task models to the Prisma schema (with proper relations)
3. Adding query helpers for each
4. Building a /dashboard page that lists the user's workspacesThe AI immediately produces idiomatic code: correct imports, Zod-validated Server Actions, proper error types, no console.log, Tailwind-only styles. You don't explain your stack - ever.
When you run npx @usequark/quark-create-app my-app, the following AI context files are created with your project's actual scope, selected packages, and scaffold date already substituted:
| File | Tool(s) | Purpose |
|---|---|---|
MAIN.md | Any tool / human | Project brief and "read this first" entry point routing to CLAUDE.md, docs/, openapi.yaml, and skills |
CLAUDE.md | Claude Code, Aider, any tool reading CLAUDE.md | Full project reference: stack, patterns, key files, all layers |
.cursor/rules/quark.mdc | Cursor | alwaysApply rule set - compact, actionable, fires on every file |
.github/copilot-instructions.md | GitHub Copilot, Continue.dev, Cody, Zed | Inline conventions + VS Code skill pointer |
.github/skills/project-context/SKILL.md | GitHub Copilot (VS Code) | Rich structured skill for the Copilot skill system |
All files contain your project's actual @scope, selected packages, and scaffold date - no placeholders remain after scaffolding.
Every scaffold also ships embedded skills that teach your AI tool how to extend the project using Quark's exact patterns:
| Skill | Builds |
|---|---|
add-model | A Prisma model, query helpers, and tests |
add-endpoint | An API route or Server Action with Zod, CSRF, and role guards |
add-dashboard | A metrics overview dashboard page |
payment | Stripe payments, checkout, webhooks, fulfillment |
ecommerce | Catalog, cart, checkout, orders, inventory |
i18n | Locale routing, translated content, hreflang SEO |
There is no admin, CMS, CRM, bookings, or AI skill. Those verticals are built on demand from the patterns above rather than shipped as packages. skills/quark-skills/SKILL.md is the index to read first.
Use the --harness flag to choose where skills are placed for auto-loading:
npx @usequark/quark-create-app my-app --harness claude # .claude/skills/
npx @usequark/quark-create-app my-app --harness copilot # .github/skills/
npx @usequark/quark-create-app my-app # default: .opencode/skills/Scaffolded docs (MAIN.md, CLAUDE.md, README.md) reference the selected harness's skill directory automatically.
Automatically reads CLAUDE.md at the project root. This is the most comprehensive reference - it covers every development layer at the right depth for Claude to produce idiomatic code across UI, API, database, auth, jobs, testing, and deployment without being told.
Reads .cursor/rules/quark.mdc with alwaysApply: true - applies to every file in the project. Optimised for concise, always-on rules rather than documentation prose. Cursor also reads CLAUDE.md when available.
Uses the skill system via .github/copilot-instructions.md, which declares the project-context skill pointing at .github/skills/project-context/SKILL.md. The skill file is rich, structured, and specifically formatted for VS Code Copilot's context system.
These tools read .github/copilot-instructions.md as raw markdown when they detect it. The file includes explicit inline conventions (not just a skill pointer) so these tools get useful context without needing VS Code or the Copilot skill system.
The generated files are yours to own. They are not auto-updated when you run quark update - they're living documentation. Update them when you make structural changes.
Update CLAUDE.md when you:
@scope/notifications, etc.)Update .github/skills/project-context/SKILL.md when you:
Update .cursor/rules/quark.mdc when you:
The copilot-instructions.md typically needs less frequent updates since it defers to SKILL.md for depth.
All generated files are good defaults - extend, don't replace. Add your own rules beneath the generated content.
Custom Cursor rule example:
## Custom Rules
- All date formatting must use `date-fns` - no `new Date().toLocaleDateString()`.
- Feature flags live in `packages/config/src/flags.js`.Custom CLAUDE.md section example:
## Domain Conventions
### Payment Integration
Payment integration (Stripe checkout, webhooks, customer management) is built on demand via the payment skill. When the user requests payment features, load the payment skill first. Key conventions:
- Never store payment methods in the DB — use Stripe Customer ID only.
- All Stripe interactions go through a `lib/stripe.js` helper the AI generates.
- Webhook handler lives at `apps/web/src/app/api/stripe/webhook/route.js`.The monorepo has its own AGENTS.md at the repository root targeting contributors, not app developers. It covers the monorepo architecture, template sync workflow, changeset release process, and testing requirements. Scaffolded projects still receive a CLAUDE.md, which is what the in-app tooling reads.
The scaffold template files (packages/cli/templates/base-project/CLAUDE.md, .cursor/rules/quark.mdc, copilot-instructions.md) contain __QUARK_*__ placeholders and are listed in TEMPLATE_ONLY in sync-templates.js - they are never overwritten by the contributor tool that syncs source code into templates.