> ## Documentation Index
> Fetch the complete documentation index at: https://allbay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Editor Local (CLI)

> Edite o tema na sua máquina com o VS Code — sincronização automática.

Prefere editar na sua máquina, com o VS Code (ou qualquer editor) e as suas ferramentas? O
**editor local** baixa os arquivos do tema para uma pasta e sincroniza cada alteração com a
loja automaticamente.

```bash theme={null}
npx allbay-editor@latest login
npx allbay-editor@latest --template SEU_ID_DO_TEMPLATE
```

## Pré-requisitos

* **Node.js 18+**.
* Um editor de código (VS Code recomendado).
* A loja precisa ter a vantagem de **template próprio** no nível dela (é ela que libera editar código).

## Passo a passo

**1. Pegue o ID do template**

No painel, vá em **Aparência → Template**, abra o menu **⋮** do seu tema e escolha
**Editar no seu computador** (no Studio: botão **Sessão local**). Copie o **ID do template**.

**2. Faça login (uma vez)**

```bash theme={null}
npx allbay-editor@latest login
```

O navegador abre para você autorizar. A sessão fica salva no seu computador e é renovada
sozinha.

**3. Baixe e edite**

```bash theme={null}
mkdir meu-tema && cd meu-tema
npx allbay-editor@latest --template SEU_ID_DO_TEMPLATE
```

O CLI baixa todos os arquivos do tema para a pasta. Abra a pasta no seu editor:
**cada arquivo salvo é sincronizado** com a loja, como rascunho.

**4. Publique**

Quando estiver pronto, publique pelo painel/Studio ou pelo próprio CLI:

```bash theme={null}
npx allbay-editor@latest publish --template SEU_ID_DO_TEMPLATE
```

O comando publica o rascunho e coloca o tema no ar.

## Como funciona a sincronização

* O CLI **baixa** todos os arquivos ao iniciar (arquivos locais com o mesmo nome são substituídos).
* Enquanto roda, **observa** a pasta: a cada save, envia o tema inteiro como **rascunho**.
* Só envia arquivos `.html`, `.liquid`, `.css`, `.js` e `.json`. Arquivos começando com `.`,
  `node_modules` e outros tipos ficam só na sua máquina.
* **Apagar** um arquivo da pasta apaga do tema no próximo envio.

> [!WARNING]
>
> Não edite o mesmo tema no painel e no editor local ao mesmo tempo: a cópia da sua pasta
> **substitui** o que foi alterado no painel.

## Comandos e opções

| Comando / opção | Descrição |
| - | - |
| `login` | Autoriza o CLI pelo navegador |
| `--template <id>` | Edita o template `<id>` (rascunho) |
| `publish --template <id>` | Publica o rascunho e coloca no ar |
| `logout` | Apaga a sessão salva neste computador |
| `--dir`, `-d` | Pasta local do tema (padrão: pasta atual) |
| `--pull` | Só baixa os arquivos e sai (não observa) |
| `--help`, `-h` | Ajuda |

## Limites

* Até **100 arquivos** por tema, **5 MiB** no total.
* Extensões e nomes de arquivo: ver [Estrutura](https://allbay.mintlify.site/editor/estrutura.md#tipos-de-arquivo).

> [!WARNING]
>
> A sessão do editor local dá acesso de edição aos temas de **todas as lojas** em que você pode
> editar o tema — trate seu computador como confiável. Para encerrá-la, rode `logout` e, se
> necessário, saia de todos os dispositivos na sua conta.

## Editar com IA

Com os arquivos na sua máquina, você pode usar assistentes de IA:

> [card] [Claude Code](https://allbay.mintlify.site/editor/ia/claude.md)

> [card] [Cursor](https://allbay.mintlify.site/editor/ia/cursor.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.