Documentation Index
Fetch the complete documentation index at: https://docs.aiparlance.org/llms.txt
Use this file to discover all available pages before exploring further.
Sintaxe
Referência dos blocos Core e Infra (estável em v0.1). Gramática: Especificação. CRM: crm-reference.aip.
Blocos Security e Behavior: Segurança, Workflows.
Convenções
- Campos declarados dentro de
entity (nome: tipo modificadores).
- Ordem:
required | optional → unique → default(valor).
- Identificadores:
PascalCase para entidades e eventos; snake_case para campos.
app
app CRM @0.1 {
database postgres
auth jwt
}
| Membro | Valores iniciais |
|---|
database | postgres, mysql |
auth | jwt, session, api_key, oauth |
auth em app é o padrão; api { } pode sobrescrever detalhes HTTP. Toda spec v0.1 exige um bloco app.
entity
entity User {
name: string required
email: email required unique
role: enum(admin, manager, seller) default(seller)
active: bool default(true)
}
entity User {
timestamps // marcador opcional; created_at/updated_at sempre injetados
soft_delete // adiciona deleted_at
}
Tipos
string | text | int | float | bool
datetime | date | uuid | email | phone | json
status: enum(new, assigned, won, lost) default(new)
relation
entity Lead {
seller: belongs_to User optional
}
| Relação (inline, v0.1) | Uso |
|---|
belongs_to | FK para outra entidade |
has_one | 1:1 inversa (roadmap) |
has_many | 1:N (roadmap) |
many_to_many | N:N (roadmap) |
optional marca FK nullable.
crud
Rotas típicas:
POST /leads
GET /leads
GET /leads/:id
PUT /leads/:id
DELETE /leads/:id
Validação
Prefira modificadores inline:
entity User {
name: string required
email: email required unique
}
validation (equivalente, para muitas regras):
validation User {
name required
email required unique
}
index
index Lead {
status
created_at
}
unique no campo já cria constraint; use index para buscas compostas ou não únicas.
api
api {
prefix "/v1"
format json
}
app.auth salvo override. Rate limit e CORS: Segurança.
Tabela resumo (Core + Infra)
| Bloco | Nível | Função |
|---|
app | Core | Aplicação e defaults |
entity | Core | Modelo de dados |
enum(…) inline | Core | Tipos enumerados |
belongs_to inline | Core | Relações (v0.1) |
crud | Core | Operações REST |
inline / validation | Core | Regras de campo |
index | Infra | Índices |
api | Infra | HTTP |
seed | Infra | Dados iniciais — Banco |
Blocos em outros capítulos
| Bloco | Capítulo |
|---|
policy, auth | Segurança |
workflow, event, lifecycle, job, queue | Workflows |
ai_context | Agentes |
Exemplo Core
app Shop @0.1 {
database postgres
auth jwt
}
entity Product {
name: string required
price: float required
sku: string required unique
}
crud Product
api {
prefix "/v1"
format json
}
