goribu
Docs

AI coding

Your agent will get up to speed automatically so you only have to provide a clear description of what the app should do.

On this page

Start with the project instructions

  • Project instructions: The starter's AGENTS.md covers routes, handlers, forms, resources and project commands. If your tool doesn't automatically load it, ask it to read it before working. Most modern harnesses load it by default.
  • One source of guidance: If your tool uses another instructions file, point it to AGENTS.md.
  • Framework overview: At a glance gives a practical overview of Goribu you can also point when there is confusion.
  • Documentation context: Use Copy page as Markdown on any docs page to bring its contents into a chat or coding session.

Describe the behavior

A useful request names the feature, its data and what success looks like:

Add a feedback page where visitors enter a name and message. Store submissions in D1, show validation errors beside the fields and redirect to the feedback list after saving. Add a migration for the table.

This maps directly to a route, a React page, a handler, a database declaration and a migration. The agent can prepare those files. Goribu supplies local resources during development and creates or reuses production resources on deployment.

For an existing feature, include its route and describe the current and desired behavior. A reproducible error is more useful than “fix the form.”

Add your app's rules

Keep a short section in AGENTS.md for decisions specific to your app:

AGENTS.md
## App conventions

- Use pnpm for package commands.
- Keep shared UI in src/components/.
- Feedback is plain text, with a maximum of 2,000 characters.
- Validate writes in server handlers.
- Run the relevant checks and pnpm build before handoff.

Update these rules when the app changes. When upgrading Goribu, review the starter's instructions and merge useful changes with your own rules or ask your agent to do it for you.

Review the result

  • Change review: Ask the agent to explain the changed behavior and the checks it ran.
  • Form checks: Check success, validation errors, and pending state.
  • Database checks: Inspect both the query and its migration.
Terminal
pnpm typecheck
pnpm build
pnpm check
Terminal
pnpm build
pnpm check
  • JavaScript projects: Skip pnpm typecheck in JavaScript projects.
  • Read-only plan: pnpm check inspects the production plan without actually changing resources.

Schema migrations and Worker deployments are separate operations. A successful build does not mean that a destructive migration is safe for existing data. See D1 migrations.

Working in a chat

  • Code context: If the assistant cannot read the project (is web-based, etc), provide the relevant route and related helpers.
  • Behavior context: Include the error or desired behavior and matching docs.
  • Project context: Include AGENTS.md for conventions and configuration or middleware when they affect the request.

Never paste credentials or local environment files. Describe the required variable names and use placeholder values instead.