> ## Documentation Index
> Fetch the complete documentation index at: https://twenty-claude-cool-pascal-5ay683.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Scaffolding

> Gere arquivos de entidade de forma interativa com `yarn twenty dev:add` — objetos, campos, visualizações, funções de lógica e mais.

Em vez de criar arquivos de entidade manualmente, use o scaffolder interativo:

```bash filename="Terminal" theme={null}
yarn twenty dev:add
```

Ele solicita que você escolha um tipo de entidade e orienta você pelos campos obrigatórios, depois grava um arquivo pronto para uso com um `universalIdentifier` estável e a chamada correta de `defineEntity()`.

Você também pode passar o tipo de entidade diretamente para pular o primeiro prompt:

```bash filename="Terminal" theme={null}
yarn twenty dev:add object
yarn twenty dev:add logicFunction
yarn twenty dev:add frontComponent
```

## Tipos de entidade disponíveis

| Tipo de entidade                | Comando                                    | Arquivo gerado                           |
| ------------------------------- | ------------------------------------------ | ---------------------------------------- |
| Objeto                          | `yarn twenty dev:add object`               | `src/objects/\<name>.ts`                 |
| Campo                           | `yarn twenty dev:add field`                | `src/fields/\<name>.ts`                  |
| Função lógica                   | `yarn twenty dev:add logicFunction`        | `src/logic-functions/\<name>.ts`         |
| Componente de front-end         | `yarn twenty dev:add frontComponent`       | `src/front-components/\<name>.tsx`       |
| Função                          | `yarn twenty dev:add role`                 | `src/roles/\<name>.ts`                   |
| Habilidade                      | `yarn twenty dev:add skill`                | `src/skills/\<name>.ts`                  |
| Agente                          | `yarn twenty dev:add agent`                | `src/agents/\<name>.ts`                  |
| Vista                           | `yarn twenty dev:add view`                 | `src/views/\<name>.ts`                   |
| Item do menu de navegação       | `yarn twenty dev:add navigationMenuItem`   | `src/navigation-menu-items/\<name>.ts`   |
| Layout da página                | `yarn twenty dev:add pageLayout`           | `src/page-layouts/\<name>.ts`            |
| Aba Layout da Página            | `yarn twenty dev:add pageLayoutTab`        | `src/page-layout-tabs/\<name>.ts`        |
| Item do menu de comandos        | `yarn twenty dev:add commandMenuItem`      | `src/command-menu-items/\<name>.ts`      |
| Campo da Vista                  | `yarn twenty dev:add viewField`            | `src/view-fields/\<name>.ts`             |
| Provedor de conexão             | `yarn twenty dev:add connectionProvider`   | `src/connection-providers/\<name>.ts`    |
| Tipo de atividade da cronologia | `yarn twenty dev:add timelineActivityType` | `src/timeline-activity-types/\<name>.ts` |

## O que o scaffolder gera

Cada tipo de entidade tem seu próprio modelo. Por exemplo, `yarn twenty dev:add object` solicita:

1. **Nome (singular)** — por exemplo, `invoice`
2. **Nome (plural)** — por exemplo, `invoices`
3. **Rótulo (singular)** — preenchido automaticamente a partir do nome (por exemplo, `Invoice`)
4. **Rótulo (plural)** — preenchido automaticamente (por exemplo, `Invoices`)
5. **Criar uma view e um item de navegação?** — se você responder sim, o scaffolder também gera uma view correspondente e um link na barra lateral para o novo objeto.

Outros tipos de entidade têm prompts mais simples — a maioria pede apenas um nome.

O tipo de entidade `field` é mais detalhado: ele solicita o nome do campo, rótulo, tipo (a partir de uma lista de todos os tipos de campo disponíveis como `TEXT`, `NUMBER`, `SELECT`, `RELATION`, etc.) e o `universalIdentifier` do objeto de destino.

## Caminho de saída personalizado

Use a opção `--path` para colocar o arquivo gerado em um local personalizado:

```bash filename="Terminal" theme={null}
yarn twenty dev:add logicFunction --path src/custom-folder
```