mirror of
https://github.com/EvolutionAPI/evolution-manager.git
synced 2025-12-21 20:22:17 -06:00
add doc
This commit is contained in:
@@ -1,7 +1,9 @@
|
||||
# Evolution-Manager CLI
|
||||
|
||||
## Instalação
|
||||
|
||||
Para instalar o Evolution-Manager CLI, execute o seguinte comando:
|
||||
|
||||
```
|
||||
npm install -g evolution-manager
|
||||
```
|
||||
@@ -9,14 +11,18 @@ npm install -g evolution-manager
|
||||
## Comandos Disponíveis
|
||||
|
||||
### Geral
|
||||
|
||||
- `help`: Exibe uma lista de comandos disponíveis. Para mais detalhes sobre cada comando, consulte este documento.
|
||||
|
||||
### Server
|
||||
|
||||
- `server start [--port=9615]`: Inicia um servidor temporário no terminal, ideal para execução local. O parâmetro `--port` define a porta do servidor, sendo `9615` o valor padrão.
|
||||
- `server build`: Realiza o build do servidor, mas não o executa. (Atualmente sem uso específico).
|
||||
|
||||
### PM2
|
||||
|
||||
O CLI interage com o PM2 para gerenciar processos do Evolution Manager.
|
||||
|
||||
- `pm2 setup`: Configura o PM2 para hospedar o Evolution Manager. Se o PM2 não estiver instalado, o CLI o instalará automaticamente.
|
||||
- `pm2 start`: Inicia o processo do Evolution Manager no PM2.
|
||||
- `pm2 stop`: Para o processo do Evolution Manager no PM2.
|
||||
@@ -33,10 +39,10 @@ A seção API do Evolution-Manager CLI inclui várias funções para gerenciar a
|
||||
|
||||
Esses comandos fornecem uma interface de linha de comando flexível e poderosa para gerenciar as versões e a configuração do manager na sua instalação da Evolution API.
|
||||
|
||||
|
||||
## Fluxo de Uso Típico
|
||||
|
||||
1. Instale o CLI globalmente.
|
||||
2. Utilize o comando `help` para ver a lista de comandos disponíveis.
|
||||
3. Para hospedar o Evolution Manager, use os comandos sob `PM2`.
|
||||
4. Use o comando `server start` para rodar um servidor temporário localmente.
|
||||
5. Utilize `api setup` para interagir com o projeto "evolution-api" e configurar o manager.
|
||||
5. Utilize `api setup` para interagir com o projeto "evolution-api" e configurar o manager.
|
||||
|
||||
Reference in New Issue
Block a user