Skip to content

Astro + shadcn + Tailwind rules for AI coding agents

Full stack: Astro + Tailwind CSS v4 + shadcn/ui

Ready-to-commit rules for Astro + Tailwind CSS v4 + shadcn/ui in every major format: AGENTS.md (Codex, Cursor, Copilot), CLAUDE.md (Claude Code), Cursor .mdc project rules, legacy .cursorrules, Copilot instructions, Windsurf rules and GEMINI.md. An Astro site using shadcn/ui React components on Tailwind v4: static pages by default, with interactive islands only where they are needed.

Last reviewed 2026-11-11 · Customise in the generator · Raw: AGENTS.md, CLAUDE.md

The mistake agents make most on this stack

shadcn/ui components are React, so agents either drop interactive ones such as Dialog into `.astro` files with no `client:` directive (they render but never respond) or put `client:load` on everything.

Generated files

AGENTS.md
# AGENTS.md - this project

Instructions for AI coding agents working in this repository.

## Project

A Astro + Tailwind CSS v4 + shadcn/ui project.

Stack: Astro, Tailwind CSS v4, shadcn/ui.

## Commands

- Dev server: `npm run dev`
- Build: `npm run build`
- Type and template check: `npx astro check`
- Add a component: `npx shadcn@latest add <component>`

## Project structure

- Routes in `src/pages/`, layouts in `src/layouts/`, components in `src/components/`.
- Markdown/MDX content lives in content collections with a schema in `src/content.config.ts`.

## How to work in this repo

- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.

## Astro

- `.astro` components ship zero JavaScript by default. Keep it that way unless interactivity is needed.
- Add interactivity with framework islands and the lightest directive that works: prefer `client:visible` or `client:idle` over `client:load`.
- Define a Zod schema for every content collection and query it with `getCollection()`.
- Use `astro:assets` `<Image />` for local images.
- Generate dynamic routes with `getStaticPaths()` in static mode.
- Set a unique `<title>` and meta description per page through the shared layout.

## Tailwind CSS v4

- Tailwind v4 is configured in CSS: `@import "tailwindcss";` plus `@theme { ... }` for design tokens. Do not create a `tailwind.config.js` unless the project already has one.
- Use theme tokens (colors, spacing) instead of arbitrary values like `w-[37px]`.
- Build responsive layouts mobile-first with `sm:`, `md:`, `lg:` prefixes.
- Extract repeated class lists into components, not `@apply` chains.
- Support dark mode with the `dark:` variant when the project uses it.

## shadcn/ui

- Before building a UI primitive, check whether a shadcn/ui component exists and add it with `npx shadcn@latest add <component>`.
- Components live in `components/ui/` and are owned code: customize them there rather than wrapping them in more layers.
- Merge class names with the `cn()` helper from `lib/utils`.
- Keep accessibility props from Radix (labels, `aria-*`, focus handling) intact.

## Reference docs

- [Astro docs](https://docs.astro.build)
- [Tailwind CSS docs](https://tailwindcss.com/docs)
- [shadcn/ui docs](https://ui.shadcn.com/docs)

Commands your agent should run

TaskCommand
Dev servernpm run dev
Buildnpm run build
Type and template checknpx astro check
Add a componentnpx shadcn@latest add <component>

What the rules cover

Astro

Content-first static or hybrid sites with Astro islands. Scoped to src/**/*.astro, src/**/*.ts, src/content/** in Cursor, Copilot and Windsurf.

  • .astro components ship zero JavaScript by default. Keep it that way unless interactivity is needed.
  • Add interactivity with framework islands and the lightest directive that works: prefer client:visible or client:idle over client:load.
  • Define a Zod schema for every content collection and query it with getCollection().
  • Use astro:assets <Image /> for local images.
  • Generate dynamic routes with getStaticPaths() in static mode.
  • Set a unique <title> and meta description per page through the shared layout.

Source docs: Astro docs

Tailwind CSS v4

Utility-first styling with Tailwind CSS v4. Scoped to **/*.css, **/*.tsx, **/*.vue, **/*.svelte, **/*.astro, **/*.html, **/*.blade.php, **/*.erb in Cursor, Copilot and Windsurf.

  • Tailwind v4 is configured in CSS: @import "tailwindcss"; plus @theme { ... } for design tokens. Do not create a tailwind.config.js unless the project already has one.
  • Use theme tokens (colors, spacing) instead of arbitrary values like w-[37px].
  • Build responsive layouts mobile-first with sm:, md:, lg: prefixes.
  • Extract repeated class lists into components, not @apply chains.
  • Support dark mode with the dark: variant when the project uses it.

Source docs: Tailwind CSS docs

shadcn/ui

Copy-in React components built on Radix and Tailwind. Scoped to components/ui/**/*.tsx, src/components/ui/**/*.tsx in Cursor, Copilot and Windsurf.

  • Before building a UI primitive, check whether a shadcn/ui component exists and add it with npx shadcn@latest add <component>.
  • Components live in components/ui/ and are owned code: customize them there rather than wrapping them in more layers.
  • Merge class names with the cn() helper from lib/utils.
  • Keep accessibility props from Radix (labels, aria-*, focus handling) intact.

Source docs: shadcn/ui docs

How to install

  1. Copy AGENTS.md to your repo root. That covers Codex, Cursor, GitHub Copilot and most other agents.
  2. Using Claude Code? Add a CLAUDE.md with the single line @AGENTS.md, or use the standalone CLAUDE.md tab above.
  3. Want rules that only load for certain files in Cursor? Add the .cursor/rules/*.mdc files.
  4. Commit the files so your whole team (and every agent) shares them.

Format guides: AGENTS.md · CLAUDE.md · Cursor rules (.mdc) · .cursorrules (legacy) · Copilot instructions · Windsurf rules · GEMINI.md

FAQ

Where do I put the AGENTS.md for Astro + Tailwind CSS v4 + shadcn/ui?

Save it as AGENTS.md in the root of your repository, next to your main config file. Codex, Cursor and GitHub Copilot pick it up automatically. For Claude Code, add a CLAUDE.md containing @AGENTS.md (or use the standalone CLAUDE.md on this page).

What is the most common mistake AI agents make with Astro?

shadcn/ui components are React, so agents either drop interactive ones such as Dialog into .astro files with no client: directive (they render but never respond) or put client:load on everything.

Which commands should the agent run to check its work?

For this stack: npm run dev, npm run build, npx astro check, npx shadcn@latest add <component>. They are listed in the generated files so the agent runs them before finishing a task.

Do these Astro + Tailwind CSS v4 + shadcn/ui rules work with Cursor and Claude Code?

Yes. This page includes the same rules as AGENTS.md, CLAUDE.md, Cursor .mdc project rules, a legacy .cursorrules file, GitHub Copilot instructions, Windsurf rules and GEMINI.md.

Can I customise these rules?

Yes. Open this stack in the generator to add or remove libraries, set your project name and package manager, switch beginner explanations on, and download everything as a zip.

Related stacks