Portfolio site rules: AGENTS.md, CLAUDE.md & Cursor rules
A portfolio should be easy for you to update without the AI. These rules keep content in Markdown files and the code out of your way.
Stack these rules assume: Astro (static output), Markdown for project write-ups. Different stack? Customize it in the generator.
Quick start
- Copy the
AGENTS.mdbelow into your project's root folder. - Fill in the three
[bracketed]lines under "Project". Delete any rule that doesn't fit. - Start your first chat with: "Read AGENTS.md and follow it for this whole session."
AGENTS.md (works across tools)
Read by OpenAI Codex, Cursor, GitHub Copilot, Claude Code (when there's no CLAUDE.md) and many other agents.
# AGENTS.md: Portfolio site
Instructions for AI coding agents working on this project. Replace anything in [brackets].
## Project
- What it is: [one sentence: what you are building and who it is for]
- Stack: Astro (static output), Markdown for project write-ups
- Version 1 only needs to: [the ONE thing it must do]
## Commands
- Create the project: `npm create astro@latest`
- Run locally: `npm run dev`
- Build the static site: `npm run build`
## Project rules
- Each project is a Markdown file in one content folder. Pages read from those files. No project text hard-coded in components.
- Static output only. No server, database, or login.
- Images go in one folder with descriptive file names and alt text.
- Keep the design to one font pair and a small color palette defined in one CSS file.
- Every page needs a unique <title> and meta description.
- Ask before adding a CSS framework, UI library, or animation library.
## How to work
- Do one task per request. If my request is really several tasks, list them and do only the first.
- Before writing code, give a 3-line plan: what you'll change, which files, and how I'll test it.
- Make the smallest change that works. Don't refactor, rename, or reformat code I didn't ask about.
- Ask before adding a dependency, deleting or moving files, changing the data/database structure, or touching more than 3 files.
- If you're not sure a library, API, or setting exists in the version we use, say so and check the installed package or the docs instead of guessing.
- Never say something works unless you ran it or I confirmed it. Report errors exactly.
- Secrets (API keys, tokens, passwords) live only in environment variables or a .env file listed in .gitignore. Never print, hardcode, or commit them.
- Never run destructive commands (rm -rf, git reset --hard, force-push, dropping tables) without asking first.
## Finish every task with
1. What changed (list the files).
2. How to run or test it in under a minute, and what I should see.
3. A suggested git commit message.
Want a step-by-step kit?
Our paid templates ($6 to $9) add a full prompt sequence and a worked example on top of rules like these, for games, Discord bots, email triage, MVPs and fixing messy code.
Why each rule exists
- Portfolio site ruleEach project is a Markdown file in one content folder. Pages read from those files. No project text hard-coded in components.Why: Adding a project should mean adding one file, not asking the AI to edit three components.
- Portfolio site ruleStatic output only. No server, database, or login.Why: A portfolio doesn't need a backend, and static sites host free almost anywhere.
- Portfolio site ruleImages go in one folder with descriptive file names and alt text.Why: You'll swap images often. One folder and clear names make that painless.
- Portfolio site ruleKeep the design to one font pair and a small color palette defined in one CSS file.Why: Changing your look later should be a 5-line edit.
- Portfolio site ruleEvery page needs a unique <title> and meta description.Why: That's what shows up in Google and in link previews when you share your site.
- Portfolio site ruleAsk before adding a CSS framework, UI library, or animation library.Why: Each one adds weight and a new set of conventions the AI has to follow.
- How to workDo one task per request. If my request is really several tasks, list them and do only the first.Why: Big multi-part requests are where AI tools change 12 files and you can't tell which change broke things.
- How to workBefore writing code, give a 3-line plan: what you'll change, which files, and how I'll test it.Why: A plan you can read in 10 seconds catches the wrong approach before it costs you an hour or a pile of credits.
- How to workMake the smallest change that works. Don't refactor, rename, or reformat code I didn't ask about.Why: Drive-by "cleanups" are the #1 cause of "it was working yesterday".
- How to workAsk before adding a dependency, deleting or moving files, changing the data/database structure, or touching more than 3 files.Why: These are the changes that are hard to undo. One quick question is cheaper than a rollback.
- How to workIf you're not sure a library, API, or setting exists in the version we use, say so and check the installed package or the docs instead of guessing.Why: AI tools confidently invent functions and config options. Making it check is the cure.
- How to workNever say something works unless you ran it or I confirmed it. Report errors exactly.Why: "Should work now" isn't a test result. You want facts, not optimism.
- How to workSecrets (API keys, tokens, passwords) live only in environment variables or a .env file listed in .gitignore. Never print, hardcode, or commit them.Why: Leaked keys get found by bots within minutes of a public push. This rule is the cheapest insurance you'll ever buy.
- How to workNever run destructive commands (rm -rf, git reset --hard, force-push, dropping tables) without asking first.Why: One bad command can delete the only copy of your work.
- Finish every task withWhat changed, how to test it, and a commit message.Why: This turns every task into a checkpoint: you test it, you commit it, and you always have a last good version to go back to.
Use it as CLAUDE.md (Claude Code)
Pick one:
- Do nothing. Current Claude Code versions read
AGENTS.mdwhen the project has noCLAUDE.md. Run/memoryin a session to check it loaded. - Import it (best if you want Claude-only extras, or you're on an older Claude Code). Create
CLAUDE.mdnext toAGENTS.md:
@AGENTS.md
## Claude Code
- Use plan mode before any change that touches more than 3 files.
- Claude only? Save the same AGENTS.md text as
CLAUDE.mdinstead. Don't keep two separate copies; they drift apart.
Heads-up: if a project has both files and CLAUDE.md doesn't import AGENTS.md, Claude Code reads only CLAUDE.md by default. More in AGENTS.md vs CLAUDE.md.
Use it as Cursor rules (.cursor/rules/*.mdc)
Cursor reads AGENTS.md too, so the file above already works. If you prefer Cursor's own Project Rules, split it into two .mdc files. The .mdc extension and frontmatter are required; Cursor ignores plain .md files in .cursor/rules.
---
description: Project overview and working rules for Portfolio site
alwaysApply: true
---
# Portfolio site
Instructions for AI coding agents working on this project. Replace anything in [brackets].
## Project
- What it is: [one sentence: what you are building and who it is for]
- Stack: Astro (static output), Markdown for project write-ups
- Version 1 only needs to: [the ONE thing it must do]
## Commands
- Create the project: `npm create astro@latest`
- Run locally: `npm run dev`
- Build the static site: `npm run build`
## How to work
- Do one task per request. If my request is really several tasks, list them and do only the first.
- Before writing code, give a 3-line plan: what you'll change, which files, and how I'll test it.
- Make the smallest change that works. Don't refactor, rename, or reformat code I didn't ask about.
- Ask before adding a dependency, deleting or moving files, changing the data/database structure, or touching more than 3 files.
- If you're not sure a library, API, or setting exists in the version we use, say so and check the installed package or the docs instead of guessing.
- Never say something works unless you ran it or I confirmed it. Report errors exactly.
- Secrets (API keys, tokens, passwords) live only in environment variables or a .env file listed in .gitignore. Never print, hardcode, or commit them.
- Never run destructive commands (rm -rf, git reset --hard, force-push, dropping tables) without asking first.
## Finish every task with
1. What changed (list the files).
2. How to run or test it in under a minute, and what I should see.
3. A suggested git commit message.
The project rules only attach when a matching file is in the chat (globs with alwaysApply: false). Want them on all the time? Change it to alwaysApply: true.
---
globs: src/**/*.astro, src/**/*.md, src/**/*.css
alwaysApply: false
---
# Project rules: Portfolio site
- Each project is a Markdown file in one content folder. Pages read from those files. No project text hard-coded in components.
- Static output only. No server, database, or login.
- Images go in one folder with descriptive file names and alt text.
- Keep the design to one font pair and a small color palette defined in one CSS file.
- Every page needs a unique <title> and meta description.
- Ask before adding a CSS framework, UI library, or animation library.
Use either AGENTS.md or these .mdc files, not both, so you don't send the same rules twice. See Cursor rules vs AGENTS.md.
Use it in Lovable or Bolt
Browser builders don't read files from your computer, so paste the rules into the project's persistent instructions:
- Lovable: Project settings → Knowledge (up to 10,000 characters). This version is 1,910 characters. If your Lovable project is connected to GitHub, Lovable's docs say it also reads a root-level
AGENTS.md. - Bolt: Project settings → Knowledge.
This version drops the Commands section, since the builder runs the project for you.
# Project rules: Portfolio site
Instructions for AI coding agents working on this project. Replace anything in [brackets].
## Project
- What it is: [one sentence: what you are building and who it is for]
- Stack: Astro (static output), Markdown for project write-ups
- Version 1 only needs to: [the ONE thing it must do]
## Project rules
- Each project is a Markdown file in one content folder. Pages read from those files. No project text hard-coded in components.
- Static output only. No server, database, or login.
- Images go in one folder with descriptive file names and alt text.
- Keep the design to one font pair and a small color palette defined in one CSS file.
- Every page needs a unique <title> and meta description.
- Ask before adding a CSS framework, UI library, or animation library.
## How to work
- Do one task per request. If my request is really several tasks, list them and do only the first.
- Before writing code, give a 3-line plan: what you'll change, which files, and how I'll test it.
- Make the smallest change that works. Don't refactor, rename, or reformat code I didn't ask about.
- Ask before adding a dependency, deleting or moving files, changing the data/database structure, or touching more than 3 files.
- If you're not sure a library, API, or setting exists in the version we use, say so and check the installed package or the docs instead of guessing.
- Never say something works unless you ran it or I confirmed it. Report errors exactly.
- Secrets (API keys, tokens, passwords) live only in environment variables or a .env file listed in .gitignore. Never print, hardcode, or commit them.
- Never run destructive commands (rm -rf, git reset --hard, force-push, dropping tables) without asking first.
## Finish every task with
1. What changed (list the files).
2. How to run or test it in under a minute, and what I should see.
3. A suggested git commit message.
Building this in a browser app builder? These rules work as Project Knowledge in both. Try Lovable · Try Bolt
Disclosure: the Bolt link is an affiliate (referral) link. If you sign up or buy through it, VibeKits may earn a commission at no extra cost to you. The Lovable link is a plain link. It never changes our pick.
Related
- Best AI tool to build a landing page (which tool to use, real prices)
- Lovable vs Bolt vs Replit for beginners (honest picks, real prices)
- AGENTS.md, CLAUDE.md and Cursor rules formats explained