Installation
Prerequisites, the install command, what the CLI asks, and what to do next.
Quick start
The templates need Node.js ^22.22.2, ^24.15.0 or 26 and newer. pnpm is recommended; npm, yarn, and bun are also supported.
$ pnpm dlx virastack@latestThis opens the interactive menu. For silent installs and every flag, see the CLI page.
What does the CLI ask?
- Project name: folder name
- Template: Next.js App Router or TanStack Start
- AI coding tools: Claude Code, Cursor or both (both are preselected). Selecting none installs plain rules in
.agents/rules/. - i18n: do you want the multi-language template?
- Tools: optional packages like
@virastack/mask,@virastack/passwordand@virastack/address.
After installation
The CLI then sets up the project in this order:
- Creates the git repository and installs dependencies, so husky can set up its hooks.
- Next.js only: writes the Next.js block to
AGENTS.md, which points agents to the docs innode_modules/next/dist/docs/. - Runs ViraStack AI with your AI tool choice: rules in
.claude/rules/virastack/and.cursor/rules/virastack/, plus the rule map inAGENTS.md. See installed files. - Installs three design skills.
- Makes the first commit, so
git statusis clean.
Design skills
The three skills are copied to .agents/skills/, which Cursor and other agents read. With Claude Code they also go to .claude/skills/; if Claude Code is your only tool, only there. Skills are copied as files, not symlinks.
emil-design-eng(emilkowalski/skills): Emil Kowalski’s design engineering for animation, interaction and polish.better-ui(jakubkrehel/skills): Jakub Krehel’s interface polish for surfaces, icons and motion, with exact values.better-accessibility(jakubkrehel/skills): accessible components, focus handling and semantic markup.
Each skill installs on its own, so one failure does not stop the others. Skills are skipped only when you are offline; the CLI then prints the command to add them later. --skip-install does not skip them.
Why .prettierignore lists AI files
The template’s .prettierignore excludes AGENTS.md, CLAUDE.md, .agents, .claude, .cursor, .virastack and skills-lock.json. ViraStack AI tracks these files by hash; if Prettier reformatted them, the next update would treat them as your edits and stop updating them. It also keeps lint:ci from failing on files you did not write.
Run the project
Enter the project directory and start the dev server:
$ pnpm devThe homepage is a short start page in src/features/home. Delete it when you build your product.
First steps (FIXME)
Templates mark the first steps with FIXME: comments. Search the repo for that marker, then update these in order:
- Step 1: Site metadata (
src/config/site.config.ts): replace the default description and social links with your product name, copy, and URLs. Name and base URL come from.env:- For Next.js:
NEXT_PUBLIC_APP_NAME,NEXT_PUBLIC_APP_URL - For TanStack Start:
VITE_APP_NAME,VITE_APP_URL
- For Next.js:
- Step 2: Remote images (Next.js only) (
next.config.ts): add your CDNs or media hosts underimages.remotePatterns. This FIXME exists only in Next templates; TanStack Start has no equivalent. - Step 3: API auth header (
src/lib/api.ts): this step has no FIXME marker, because auth is optional. When you pick an auth solution, passgetHeaderstocreateApi. Those headers go only to your own API. Shared across all templates. - Step 4: Env and assets: update name/URL in
.env; when adding variables, keepsrc/env.tsand.env.examplein sync with your template’s prefix (NEXT_PUBLIC_*orVITE_*). Swap favicon and static files underpublic/, and add the 192x192 and 512x512 icons the web manifest FIXME asks for.