Documentation Index
Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
Use this file to discover all available pages before exploring further.
Pré-requisitos
- Node.js 24+ — Baixar
- Yarn 4 — Vem com o Node.js via Corepack. Ative-o:
corepack enable - Docker — Baixar. Necessário para executar um servidor Twenty local. Ignore se você já tiver o Twenty em execução em outro lugar.
| Fase | O que você faz | Ferramenta | Resultado |
|---|---|---|---|
| 1. Criar scaffolding | Gerar o código-fonte do aplicativo | npx create-twenty-app | Um projeto TypeScript em disco |
| 2. Executar um servidor | Iniciar um servidor Twenty para o qual sincronizar | Docker + yarn twenty server | Uma instância Twenty em execução |
| 3. Sincronizar | Sincronize seu código em tempo real com o servidor | yarn twenty dev | Suas alterações aparecem na interface |
Fase 1 — Fazer scaffolding do seu projeto
Crie um novo aplicativo a partir do modelo:my-twenty-app/ com um application-config.ts inicial, um papel padrão, um fluxo de trabalho de CI e um teste de integração.
Após esta fase: você tem o código-fonte de um aplicativo na sua máquina. Ele ainda não está em execução — isso é a Fase 2.
Fase 2 — Executar um servidor Twenty local
Seu aplicativo precisa de um servidor Twenty para o qual sincronizar. O servidor é uma instância completa do Twenty — interface, API GraphQL, PostgreSQL — executando localmente no Docker. Seu código local envia suas definições para esse servidor, o que faz com que elas apareçam na interface. A ferramenta de scaffolding oferece iniciar um para você:Você gostaria de configurar uma instância local do Twenty?
- Sim (recomendado) — baixa a imagem Docker
twentycrm/twenty-app-deve a inicia na porta2020. Certifique-se de que o Docker esteja em execução primeiro. - Não — escolha isto se você já tiver um servidor Twenty ao qual deseja se conectar. Você pode conectá-lo depois com
yarn twenty remote add.
- E-mail:
tim@apple.dev - Senha:
tim@apple.dev
Se o Docker não estiver instalado ou em execução, a ferramenta de scaffolding informará o comando de inicialização correto para o seu sistema operacional. Quando o Docker estiver ativo, você pode retomar com
yarn twenty server start — sem necessidade de recriar o scaffolding.Fase 3 — Sincronizar suas alterações
Este é o ciclo interno no qual você passará a maior parte do tempo.src/, recompila a cada alteração e sincroniza o resultado com o servidor. Edite um arquivo, salve e, em um segundo, o servidor refletirá a alteração. Você verá um painel de status em tempo real no seu terminal.
Para uma saída mais detalhada (logs de build, solicitações de sincronização, rastros de erro), adicione --verbose.
src/ e ele aparecerá na interface.
Sincronização única para CI e scripts
Passe--once para executar uma única compilação + sincronização e sair — mesmo pipeline, sem watcher:
| Comando | Comportamento | Quando usar |
|---|---|---|
yarn twenty dev | Monitora e ressincroniza a cada alteração. Fica em execução até você interrompê-lo. | Desenvolvimento local interativo. |
yarn twenty dev --once | Executa uma única compilação + sincronização e, em seguida, encerra com o código 0 em caso de sucesso ou 1 em caso de falha. | Scripts, CI, hooks de pre-commit, agentes de IA e fluxos de trabalho com script. |
Começando a partir de um exemplo
Use--example para começar com um projeto mais completo (objetos personalizados, campos, funções de lógica, componentes de front-end):
yarn twenty add — veja Scaffolding.
O que você pode criar
Os aplicativos são compostos por entidades — cada uma definida como um arquivo TypeScript com um únicoexport default:
| Entidade | O que faz |
|---|---|
| Objetos e campos | Modelos de dados personalizados (Cartão postal, Fatura etc.) com campos tipados |
| Funções lógicas | Funções TypeScript do lado do servidor acionadas por rotas HTTP, agendamentos do cron ou eventos de banco de dados |
| Componentes de front-end | Componentes React que são renderizados na UI do Twenty (painel lateral, widgets, menu de comandos) |
| Habilidades e agentes | Recursos de IA — instruções reutilizáveis e assistentes autônomos |
| Exibições e navegação | Exibições de lista pré-configuradas e itens de menu da barra lateral |
| Layouts de página | Páginas de detalhes de registros personalizadas com abas e widgets |
Próximos passos
Configuração
Identidade do aplicativo, função padrão, hooks de instalação, recursos públicos.
Data
Objetos, campos e relações bidirecionais.
Lógica
Funções lógicas, habilidades, agentes e conexões OAuth.
Layout
Exibições, navegação, layouts de página, componentes de front-end.
Operações
CLI, testes, remotos, CI e publicação do seu aplicativo.