cartorio-plataforma-cli/INSTALL.md

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

# Instalação da Plataforma CLI

Este documento contém instruções simplificadas para instalação e uso da CLI da Plataforma do Cartório de Criciúma.

## Instalação via NPM (recomendado)

A forma mais simples de instalar a CLI é através do npm:

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

Após a instalação, você poderá usar o comando `plataforma` de qualquer diretório.

## Instalação a partir do código-fonte

Caso prefira instalar a partir do código-fonte, siga estes passos:

1. Clone o repositório
   ```bash
   git clone https://github.com/cartoriocriciumasc/plataforma-cli.git
   ```

2. Entre no diretório do projeto
   ```bash
   cd plataforma-cli
   ```

3. Instale as dependências
   ```bash
   npm install
   ```

4. Instale globalmente
   ```bash
   npm install -g .
   ```

## Verificação da instalação

Para verificar se a instalação foi bem-sucedida, execute:

```bash
plataforma help
```

Deve aparecer a tela de ajuda com todos os comandos disponíveis.

## Comandos principais

- `plataforma start --interactive`: Inicia a plataforma em modo interativo
- `plataforma stop`: Para os serviços da plataforma
- `plataforma status`: Verifica o status dos serviços
- `plataforma logs`: Visualiza logs dos serviços

## Documentação completa

Para a documentação completa, consulte o arquivo README.md ou execute `plataforma help` no terminal.