Repository navigation
Route Snap
Route::snap($options) declares, in one line of web.php, every capability of the app as a card and an assistant that
answers with them. Since 2.23.0. This page is about the declaration; what people get, the card types, card views and
hints are in Snap Cards and the assistant.
Auth::authentication('User', 'users');
Route::snap();"Add Snap Cards and the assistant to the app."
Check before you say OK:
-
Route::snap();is belowAuth::authentication(...); -
php caligrafer.php snap installwas run (thecaligrafy_snap_*tables); -
/assistantopens for a signed-in person and/snaplists the cards.
-
One line in
application/config/routing/web.php, afterAuth::authentication(...):Route::snap();
-
Its tables, and a starter hints file:
php caligrafer.php snap install
It creates the
caligrafy_snap_*tables (they also come withphp caligrafer.php platform install, and with every deploy) andapplication/config/snap.php, then prints what is ready. -
Open
/assistant. The rest is optional: thequeue_workjob for background tasks, thesnap_routines_duejob for routines, andANTHROPIC_API_KEYin.envfor the assistant's model (without it, the assistant answers from the cards' names).
| Address | What it is |
|---|---|
GET /assistant |
Home (what needs you, insights, things to browse, shortcuts) and the task space; signed-in people only (comeBack) |
POST /assistant/ask |
what the person typed, said, attached or clicked (snap_ask, a Route::action) |
GET /assistant/noticed |
what the assistant noticed, and the person's routines (a settings page); signed-in people only |
GET /snap |
every card the person may use (a gallery); visitors see the public capabilities |
GET /snap/c/{capability} |
one card at its own address |
POST /snap/run |
a card sent (snap_run, a Route::action) |
POST /snap/call/{name} |
the snap_* capabilities the pages call, and only them, as the signed-in person |
Changes only ever run from a Confirm the person clicks.
| Option | Default | What it does |
|---|---|---|
assistant |
'/assistant' |
the path of the assistant and its pages |
cards |
'/snap' |
the path of the cards and their routes |
Route::snap(['assistant' => '/help', 'cards' => '/cards']);-
"Snap is almost ready" (503) on every Snap page: its
caligrafy_snap_*tables are missing. Runphp caligrafer.php snap installorplatform install(after anupdateto 2.23.0, run one of them locally). -
Route::snap()withoutAuth::authentication(...)above it:/assistantand/assistant/noticedare signed-in pages, and opening them stops with "'signedIn', 'level' and 'visitorsOnly' need Auth::authentication(...) in web.php". -
Expecting
async: trueto change REST or MCP:#[Capability(..., async: true)]only changes Snap, where the card runs in the background as a Track: Task card.
Caligrafy: Describe it. Approve it. Ship it. Your idea turned into a complete app: every feature built once, for web pages, Vue apps, a REST API and AI agents, and online.
Why Caligrafy: the benefits, the measurements, and what it is not yet
-
Quickstart with Claude: describe it, approve it, ship it
or the Quickstart: the same three steps by hand, in 5 minutes
- How Caligrafy works: the ideas in 5 minutes
- Your first capability: build a feature, page included
-
Capabilities in depth
-
#[Capability]: every option - Scheduled jobs: capabilities on a timer
- Notifications: web push and email
- Background jobs: capabilities run later
- Migrations: database changes, in order
- The cache
-
Testing your app
- Dependency injection
- Validation rules
-
Web pages
- Views and page components
- Design styles: another look, one setting
- Declarative routes: every request, in one line
-
Route::page·Route::form·Route::auth·Route::webhook·Route::download·Route::redirect·Route::action·Route::snap· capability routes - How to export a list as CSV
- Controllers: moving one to a declared route · how to, step by step
- Forms and helpers
-
Vue apps
-
Mobile and tablet
-
REST API
-
AI agents
-
Snap Cards and the assistant
- Payments: Stripe and crypto
- Face detection and face login
- OpenAI: chat and images · Assistants
- Open models: Llama, Mistral...
- Chatbots with Watson
- Machine learning in the browser
- Metadata and social cards · search and analytics
-
Putting it online: the production image, the database at every start
-
API reference: every class and method
-
Routing ·
Route·AuthRoutes· pages ·Controller· capabilities -
Data ·
Model·Query· sign-in · jobs ·Notify· payments · AI -
Interfaces · Snap ·
Snap\Cards·Snap\Conversation· testing · tooling · helper functions
-
Routing ·
-
Caligrafer: every command
- Project · build · data · agents · jobs and tests · maintenance · deploy
- Installation, configuration and Caligrafer
- Routing · Request · Controllers · Views
- Vue: flow of information · routes · validations
- Security and upgrading
- Release notes: 2.26 · 2.25 · 2.24 · 2.23 · 2.22 · 2.21 · 2.20 · 2.19 · 2.18 · 2.17 · 2.16 · 2.15 · 2.14 · 2.13 · 2.12 · 2.11 · 2.10 · 2.9 · 2.8 · 2.7 · 2.6 · 2.5 · 2.4 · 2.3 · 2.1 · October 2026 · changelog
- Testing Caligrafy (contributors)