GEMINI.md
GEMINI.md for Astro
GEMINI.md is the project context file the Gemini CLI reads from the repository root. It should say how this codebase is built, tested, and reviewed so Gemini does not guess. This copy is written for a Astro project. This repository is an Astro site. Pages ship zero client JavaScript unless an island needs it. Content lives in content collections when the repo already uses them.
The example uses a balanced, readable style, pragmatic tests, and comments only where the intent is not obvious. Open the generator to make the agent stricter, switch to test-first, quiet the comments, or pick a different file.
The example assumes Astro. It does not assume React, Vue, or a particular UI framework for islands. Use the integration already in astro.config.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: GEMINI.md
# GEMINI.md
Project context for the Gemini CLI in this Astro repository. Read it before editing.
Other agents can follow the same rules, but Gemini loads this filename automatically.
## Stack
This repository is an Astro site. Pages ship zero client JavaScript unless an island needs it. Content lives in content collections when the repo already uses them.
## Layout
- Routes live in `src/pages` or the content-driven routing the project uses.
- Shared UI lives in `src/components`. Interactive islands are the exception.
- Content collections and their schemas live in `src/content` when the project has them.
## Commands
- Dev server: `npm run dev`
- Build: `npm run build`
- Check: `npm run check`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Do the data load in the frontmatter of the Astro component.
- Add `client:*` only when the component needs state or browser APIs.
- Validate content with the collection schema. Do not cast frontmatter.
- Use Astro's image and font helpers if the project already does.
- Keep endpoints in `src/pages` as `.ts` routes or the project's action style.
- Match the CSS approach already configured. Do not add a second one.
## Testing
Add or update tests when behavior changes.
Test a pure helper or a content schema. Do not require a browser for a markdown change.
## Style
- Optimize for the next reader over the shortest diff.
- Comment only when the why is non-obvious.
- Name things the way neighboring files already do.
- Do not reformat code you did not change.
## Errors
- Fail at the boundary. Do not swallow errors.
- Return a 404 via `Astro.redirect` or the response status the project uses when content is missing. Do not render an empty shell.
## Scope
- Do the requested task. Do not refactor unrelated code.
- Match the rigor already in the repo. Fix what you touch.
- Ask one clarifying question only when the task cannot be finished without it. Otherwise state the assumption and continue.
## Avoid
- Do not mark a whole layout as a client island to use one hook.
- Do not import server-only secrets into an island.
- Do not fetch in `useEffect` inside an island when the Astro page can load the data.
- Do not bypass the content schema with a raw glob.
## Done when
- The requested behavior works.
- `npm run build` succeeds for the routes you touched.
- The diff stays inside the task.
- You list anything you could not run.
Add it to the project
01
Copy a starting file
Copy the example GEMINI.md on this page, or open the generator if you want different testing, strictness, or comment rules.
02
Save it at GEMINI.md
Save it as `GEMINI.md` at the root of the Astro repo. Start a new Gemini CLI session so it picks up the file.
03
Start a fresh agent session
Rules files are read when a session starts. A chat that is already open may still be using the old instructions.
04
Give it one small task
Ask for one change a Astro agent often gets wrong, such as a page that renders content on the server instead of fetching it in a client island. If it ignores the file, confirm the path and start a new session.
Questions about this file
Where do I put GEMINI.md in a Astro repo?
Save it as `GEMINI.md` at the root of the Astro repo. Start a new Gemini CLI session so it picks up the file.
Which tools read this GEMINI.md?
The Gemini CLI reads GEMINI.md as project context. Claude Code reads CLAUDE.md instead, and most other agents read AGENTS.md.
What does the Astro example assume?
The example assumes Astro. It does not assume React, Vue, or a particular UI framework for islands. Use the integration already in astro.config.
Does VibeSpell upload my repository?
No. Recipe pages are static, and the generator builds the file in your browser from the options you pick. Your source code never leaves the machine.
Other files for Astro
Cursor rules
.cursor/rules/project.mdc
AGENTS.md
AGENTS.md
CLAUDE.md
CLAUDE.md
system prompt
system-prompt.md
Copilot instructions
.github/copilot-instructions.md
Windsurf rules
.windsurf/rules/project.md
Cline rules
.clinerules
Cursor testing rule
.cursor/rules/testing.mdc
Cursor security rule
.cursor/rules/security.mdc
GEMINI.md for other stacks
- GEMINI.md for Next.js
- GEMINI.md for React
- GEMINI.md for Vue
- GEMINI.md for SvelteKit
- GEMINI.md for Node.js
- GEMINI.md for FastAPI
- GEMINI.md for Django
- GEMINI.md for Go
- GEMINI.md for Rust
- GEMINI.md for Unity
- GEMINI.md for Godot
- GEMINI.md for Laravel
- GEMINI.md for Rails
- GEMINI.md for Flutter
- GEMINI.md for Swift
- GEMINI.md for Kotlin
- GEMINI.md for Unreal
- GEMINI.md for Next.js + Supabase
- GEMINI.md for T3
- GEMINI.md for Remix
- GEMINI.md for Nuxt
- GEMINI.md for Electron
- GEMINI.md for Tauri
- GEMINI.md for Expo
- GEMINI.md for Spring Boot
- GEMINI.md for .NET
- GEMINI.md for Phaser
- GEMINI.md for Bevy
- GEMINI.md for Roblox
- GEMINI.md for Python ML
- GEMINI.md for LangChain