Skip to main content
Use project instructions when Veryfront Agent needs project-specific rules. Veryfront Agent already understands Veryfront. Use AGENTS.md for local commands, architecture rules, naming conventions, release constraints, and product context. Do not put secrets or credentials in AGENTS.md.

Add instructions

In your project root, create AGENTS.md:
AGENTS.md
# Project instructions

## Code style

- Use TypeScript for new code.
- Match existing file and component patterns.
- Keep user-facing copy short and direct.

## Commands

- Run tests before opening a pull request.
- Run the project lint command after changing shared code.

## Architecture

- Keep route code separate from shared library code.
- Put reusable UI in the existing component directories.
- Do not add dependencies without approval.

Keep instructions specific

IncludeAvoid
Test and lint commandsGeneral TypeScript or React lessons
Naming and folder conventionsVeryfront framework basics
Deployment or release constraintsSecrets or credentials
Product-specific rulesLong process documents
Known architecture boundariesTemporary notes that expire quickly

Make rules actionable

WeakBetter
Write good tests.Run npm test after changing shared logic.
Follow the design system.Use components from components/ui/ before adding new UI primitives.
Be careful with auth.Do not change auth middleware without updating tests/auth.test.ts.
Keep copy concise.Keep user-facing copy under two sentences per state.

Check the result

Ask Veryfront Agent to summarize the active project instructions:
Summarize the project instructions you are following.
If it misses a rule, make the rule shorter and more direct.

Update instructions

Review AGENTS.md after major project changes. Update it when commands, deployment targets, folder ownership, or product constraints change.

What to include

SituationAdd this
New test commandThe exact command and when to run it.
New folder conventionThe owning folder and what belongs there.
New release ruleThe release target and required validation.
New product constraintThe rule and an example of when it applies.

Next

GoalPage
Add reusable workflowsSkills
Understand Agent contextVeryfront Agent