cartorio-plataforma-cli/PUBLISH.md

CLI para gerenciar a Plataforma do Cartório de Criciúma com sistema de módulos

# Guia de Publicação no NPM

Este documento contém os passos para publicar a Plataforma CLI no registro do NPM.

## 1. Preparação

Antes de publicar, verifique se:

1. O arquivo `package.json` está configurado corretamente:
   - Nome: "cartorio-plataforma-cli"
   - Versão: Seguindo semântica (major.minor.patch)
   - Descrição, autor e repositório estão corretos

2. O arquivo `README.md` contém documentação atualizada

3. O arquivo `.npmignore` está configurado para excluir arquivos desnecessários

## 2. Verificação do Pacote

Verifique quais arquivos serão incluídos no pacote:

```bash
npm pack --dry-run
```

Isso mostrará a lista de arquivos que serão publicados.

## 3. Testar Localmente

Antes de publicar, teste a instalação local:

```bash
# Instalar globalmente a partir do diretório local
npm install -g .

# Ou usar o script de instalação local
./install-local.sh

# Teste o comando
plataforma help
```

## 4. Publicação

### 4.1. Criar conta no NPM (uma única vez)

Se você ainda não tem uma conta no NPM:

```bash
npm adduser
```

Siga as instruções para criar usuário, inserir e-mail e senha.

### 4.2. Login no NPM

Se você já tem uma conta:

```bash
npm login
```

### 4.3. Publicar o Pacote

```bash
npm publish
```

O NPM irá empacotar e enviar seu pacote para o registro público.

### 4.4. Verificar a Publicação

Após a publicação, você pode verificar se o pacote foi publicado corretamente:

```bash
npm view cartorio-plataforma-cli
```

## 5. Atualizações Futuras

Para atualizar o pacote no futuro:

1. Altere a versão no `package.json` seguindo o versionamento semântico:
   - Atualizações de patch (correções de bugs): 1.0.0 → 1.0.1
   - Atualizações menores (novas funcionalidades): 1.0.0 → 1.1.0
   - Atualizações maiores (mudanças que quebram compatibilidade): 1.0.0 → 2.0.0

2. Publique a nova versão:
   ```bash
   npm publish
   ```

## 6. Instalação para Usuários

Após a publicação, os usuários podem instalar seu pacote com:

```bash
npm install -g cartorio-plataforma-cli
```