AvelonDocs

Lookup

Avelon

One place for each kind of thing. Search a name, then open the guide or the package README.

CLI

15 names

CLI
reeve
Bare reeve opens a TUI; arguments skip it.
REPL
reeve tinker
about
reeve about
route list
reeve route:list
migrate
reeve migrate
Migrations are driver-owned.
seed
reeve db:seed
publish stubs
reeve stub:publish
Ejects generator templates.
make model
reeve make:model -mfcpw
Adds a policy and a ward.
make controller
reeve make:controller --resource
make request
reeve make:request
make policy
reeve make:policy
make errand
reeve make:errand
make listener
reeve make:listener --queued
make auth
reeve make:auth
new project
create-avelon
D19 packaging; not a Wave D work package.

HTTP

10 names

web routes
routes/web.ts
Source of truth; codegen is one-way.
resource routes
Route.resource
Seven REST actions.
route binding
.bind(param, Model)
A miss is 404 before your code runs.
controllers
app/Http/Controllers
TypeScript classes in a fixed directory.
form requests
app/Http/Requests
Zod parse plus an authorize hook.
middleware
app/Http/Middleware
Kernel runs aliases, including auth.
serializers
app/Http/Views
Models never cross the view boundary.
views
view(ref, props)
Opaque view references; the adapter renders.
route helper
route(name, params)
From the generated manifest.
writes
generated server actions
Writes leave the GET URL (D9).

Data

14 names

models
Scrivener (@avelon/orm)
Produces Query IR; never a vendor builder.
query IR
Query IR
Drivers compile it. Semantics are frozen.
transactions
DB.transaction
Missing on drivers with transactions: false.
row access
Wards
Declared once, enforced as IR and as RLS.
soft deletes
softDeletes
fillable
static fillable
casts
static casts
eager load
with() → RelationLoad
Eager loads are explicit IR.
paginate
paginate()
Count mode plus a page of rows.
findOrFail
findOrFail
Raises NotFound, mapped to 404.
lifecycle hooks
ModelLifecycle events
migrations
driver-owned migrations
plan, apply, rollback, status (D13).
factories
assay defineFactory
seeds
database/seeds

Auth and authorization

7 names

policies
Policies
May this actor perform this action.
gate
Gate
can and authorize.
row access
Wards
Which rows may this actor reach.
identity
identity driver + reeve make:auth
social login
social driver
API tokens
tokens driver (Signet)
current user
Auth.user() / Gate.actor()
Never call the identity vendor from app/.

Async work

8 names

background work
Errands
Three delivery modes: sync, after, queued.
queued delivery
delivery: 'queued'
drain worker
reeve errand:work
Drain-and-exit on serverless.
failed jobs
reeve errand:failed
events
Events / Listeners
Sync and ordered by default (D16).
notices
Notices + notifications driver
mail
@avelon/resend
Mail driver; vendor stays in config.
queue dashboard
Vigil
Named, not in the v1 build plan.

Frontend and runtime

7 names

pages
RSC via @avelon/next
Next is the first adapter, not the core.
bundler
Next bundler
Tailwind
Tailwind 4
No bundled UI kit (D20). reeve ui:install is opt-in.
files
storage driver
Signed uploads are deferred (D28).
cache
cache contract + fake
v1 ships the contract and a fake.
realtime
Peal
Named, not in the v1 build plan.
local serve
bun + next dev
Node is the default deployed runtime (D27).

Tooling and packaging

15 names

package manager
bun / npm @avelon
The framework is a dependency (D19).
formatter
Prettier
Shipped config. Formatting is not a decision.
tests
bun test + Assay
typecheck
tsc strict
plus noUncheckedIndexedAccess.
architecture lint
Bailiff
Opinions in a linter, not a README.
service registry
typed registry + providers
No IoC container (D17).
providers
providers listed in config
D18. Explicit, tree-shakeable.
facades
capability-narrowed facades
Missing methods are compile errors.
config
config/ + avelon.config.ts
Vendor names only in config and drivers.
local environment
Hearth
The local environment name.
admin panel
Moot
Named, not in the v1 build plan.
introspection
Lantern
Named, not in the v1 build plan.
feature flags
Banner
Named, not in the v1 build plan.
search
search contract + fake
payments
payments contract + fake