Guides / Working with an agent

Give your agent a map.

The same conventions, release context, and proof commands that make Caramel easier for a person to learn.

Proposed generated app guideTarget: 0.4.0

Orient before editing

Read the application’s shard.lock for its pinned release. Use the matching documentation, then inspect the command manifest and relevant routes.

Terminal

frappe agent-manifest
frappe routes books

Choose the application file

config/routes.crEndpoint declarations

app/actions/Contracts and request behavior

app/models/ + app/changesets/Data and write rules

app/views/Typed HTML views

app/jobs/Background work

spec/requests/Request behavior tests

Make the result reviewable

Terminal

frappe check
frappe corretto
frappe lint

Report the files changed, checks run, and any unsupported requirement. Link the task recipe and its exact release. Treat framework-source edits as a signal that the extension path needs review.

# Working in this Caramel application

Read shard.lock for the pinned framework version.
Use documentation for that exact release.

Routes: config/routes.cr
Actions and contracts: app/actions/
Data: app/models/ and app/changesets/
HTML: app/views/
Jobs: app/jobs/
Request specs: spec/requests/

Discover: frappe agent-manifest; frappe routes
Verify: frappe check; frappe corretto; frappe lint

Surface unsupported requirements before editing
framework internals. Link the matching task recipe.

Documentation: https://caramelize.dev/docs/0.4.0/agents/
Cookbook: https://caramelize.dev/cookbook/0.4.0/

← All recipes Explore the project map →