@wppconnect/server-cli 1.3.58 → 1.3.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +73 -41
  3. package/README.pt-BR.md +103 -0
  4. package/documentation/readme-reference.md +78 -0
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,7 @@
1
+ ## [1.3.60](https://github.com/wppconnect-team/server-cli/compare/v1.3.59...v1.3.60) (2026-11-01)
2
+
3
+ ## [1.3.59](https://github.com/wppconnect-team/server-cli/compare/v1.3.58...v1.3.59) (2026-10-31)
4
+
1
5
  ## [1.3.58](https://github.com/wppconnect-team/server-cli/compare/v1.3.57...v1.3.58) (2026-10-31)
2
6
 
3
7
  ## [1.3.57](https://github.com/wppconnect-team/server-cli/compare/v1.3.56...v1.3.57) (2026-10-30)
package/README.md CHANGED
@@ -1,71 +1,103 @@
1
- <!-- wppconnect-official-brand -->
1
+ **English** | [Português (Brasil)](./README.pt-BR.md)
2
+
2
3
  <p align="center">
3
- <a href="https://wppconnect-team.github.io/">
4
+ <a href="https://wppconnect.io/">
4
5
  <picture>
5
- <source media="(prefers-color-scheme: dark)" srcset="https://wppconnect-team.github.io/brand/wppconnect-dark.png" />
6
- <img src="https://wppconnect-team.github.io/brand/wppconnect-light.png" alt="WPPConnect" width="220" height="121" />
6
+ <source media="(prefers-color-scheme: dark)" srcset="https://wppconnect-team.github.io/brand/v2/wppconnect-dark.png" />
7
+ <img src="https://wppconnect-team.github.io/brand/v2/wppconnect-light.png" alt="WPPConnect" width="220" height="121" />
7
8
  </picture>
8
9
  </a>
9
10
  </p>
10
- <!-- /wppconnect-official-brand -->
11
11
 
12
- # WPPConnect Team
12
+ # WPPConnect Server CLI
13
13
 
14
- ## _WPPConnect Server Cli_
14
+ Start WPPConnect Server from the `wppserver` command.
15
15
 
16
- [![Build](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml/badge.svg)](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml)
16
+ A project in the WPPConnect ecosystem, maintained by WPPConnect Team.
17
17
 
18
- Esse pacote facilita a utilização do servidor WPPConnect-server através de uma linha de comando
18
+ [Getting started](#getting-started) | [Documentation](#documentation) | [Contributing](#contributing) | [Support WPPConnect](#support-the-project)
19
19
 
20
- ## Nossos canais online
20
+ [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE) [![npm version](https://img.shields.io/npm/v/@wppconnect/server-cli)](https://www.npmjs.com/package/@wppconnect/server-cli) [![CI](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml) [![Open Collective](https://img.shields.io/badge/Open%20Collective-WPPConnect-blue)](https://opencollective.com/wppconnect)
21
21
 
22
- [![Discord](https://img.shields.io/discord/844351092758413353?color=blueviolet&label=Discord&logo=discord&style=flat)](https://discord.gg/JU5JGGKGNG)
23
- [![Telegram Group](https://img.shields.io/badge/Telegram-Group-32AFED?logo=telegram)](https://t.me/wppconnect)
24
- [![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/LJaQu6ZyNvnBPNAVRbX00K)
25
- [![YouTube](https://img.shields.io/youtube/channel/subscribers/UCD7J9LG08PmGQrF5IS7Yv9A?label=YouTube)](https://www.youtube.com/c/wppconnect)
22
+ ## Overview
26
23
 
27
- ## Instalação
24
+ For developers who want command-line configuration of the Node.js Server. The CLI wraps the Server; it does not replace the Server API or the Manager web application.
28
25
 
29
- Para instalar, basta executar.
26
+ ## Features
30
27
 
31
- ```sh
32
- yarn global add @wppconnect/server-cli
33
- //ou
34
- npm install -g @wppconnect/server-cli
35
- ```
28
+ - Start the server and set options such as the HTTP port.
29
+ - Inspect supported flags with `wppserver --help`.
30
+ - Serve a supplied static frontend with `--frontend-path`.
36
31
 
37
- ## E para executar
32
+ ## Getting started
33
+
34
+ Requires Node.js `^22.18.0 || >=24.11.0`, npm and the browser/native dependencies required by WPPConnect Server.
38
35
 
39
36
  ```sh
40
- wppserver
41
- //ou
37
+ npm install -g @wppconnect/server-cli
38
+ wppserver --help
42
39
  wppserver --port 8000
43
40
  ```
44
41
 
45
- ## Para mais opções
42
+ Open `http://localhost:8000/api-docs` to inspect the running API. Configure the Server secret and session credentials before exposing the service.
46
43
 
47
- ```sh
48
- wppserver --help
49
- ```
44
+ ## Configuration
50
45
 
51
- ## Frontend
46
+ See [src](src/) and `wppserver --help` for flags. `--frontend` uses the legacy `@wppconnect/frontend` package; for the maintained UI follow WPPConnect Manager instructions, or use `--frontend-path` with a compatible static build. Source development uses Yarn 1.22.22 as declared in `packageManager`.
52
47
 
53
- Para adicionar o frontend automaticamente, basta instalar
48
+ ## Documentation
54
49
 
55
- ```sh
56
- yarn global add @wppconnect/frontend
57
- //ou
58
- npm install -g @wppconnect/frontend
59
- ```
50
+ - [Server guide](https://github.com/wppconnect-team/wppconnect-server)
51
+ - [CLI tutorial video](https://www.youtube.com/watch?v=zBmCnPS3JOQ)
52
+ - [Retained technical details and acknowledgments](documentation/readme-reference.md)
53
+
54
+ ## WPPConnect ecosystem
55
+
56
+ | Project | Purpose | When to use it |
57
+ | --- | --- | --- |
58
+ | [WPPConnect Server](https://github.com/wppconnect-team/wppconnect-server) | Run a REST API for WhatsApp sessions, messages and webhooks. | Expose session and messaging operations over HTTP. |
59
+ | [WPPConnect Manager](https://github.com/wppconnect-team/wppconnect-manager) | Manage WPPConnect Server sessions and conversations in a self-hosted web workspace. | Operate compatible Server sessions and chats through a UI. |
60
+
61
+ ## Support the project
60
62
 
61
- E executar
63
+ WPPConnect is maintained by an open-source community. Your support helps fund maintenance, infrastructure, documentation, and the people working on the ecosystem.
64
+
65
+ If WPPConnect helps your project or business, consider making a one-time contribution or becoming a recurring supporter.
66
+
67
+ **[Support WPPConnect on Open Collective](https://opencollective.com/wppconnect)**
68
+
69
+ Contributions are voluntary. See the official page for current financial information. You can also help with code, tests, documentation, translations and well-described issue reports.
70
+
71
+ Additional official beneficiaries in [.github/FUNDING.yml](.github/FUNDING.yml): [joaosouz4dev](https://github.com/sponsors/joaosouz4dev), [manfe](https://github.com/sponsors/manfe).
72
+
73
+ ## Contributing
74
+
75
+ Contributions of code, tests, examples, documentation and translations are welcome. For larger changes, discuss the approach in an issue first. Include the project/runtime versions, a minimal reproduction and sanitized logs when reporting a problem. Update both `README.md` and `README.pt-BR.md` in the same change when installation, configuration, features, examples, licensing or funding changes.
76
+
77
+ After installing the development dependencies, use the repository checks relevant to your change:
62
78
 
63
79
  ```sh
64
- wppserver --frontend
65
- //ou
66
- wppserver --frontend-path <caminho do frontend (pasta dist)>
80
+ yarn build
81
+ yarn lint
82
+ yarn test
67
83
  ```
68
84
 
69
- ## Tutorial - Youtube
70
- - Veja o tutorial de uso no [Canal WPPConnect](https://www.youtube.com/watch?v=zBmCnPS3JOQ).
85
+ Account-dependent examples and tests require separate validation with an authorized test account. Never attach credentials or session files to an issue.
86
+
87
+ ## Community and support
88
+
89
+ Use [repository issues](https://github.com/wppconnect-team/server-cli/issues) for reproducible bugs and feature proposals. For usage questions, join the community through the official channels:
90
+
91
+ - [Discord](https://discord.gg/JU5JGGKGNG)
92
+ - [Telegram](https://t.me/wppconnect)
93
+ - [YouTube](https://www.youtube.com/c/wppconnect)
94
+
95
+ This project is independent and is not affiliated with or endorsed by WhatsApp or Meta. Follow applicable terms and obtain authorization for account and messaging operations.
96
+
97
+ ## License
98
+
99
+ [Apache License 2.0 (Apache-2.0)](./LICENSE).
100
+
101
+ Copyright 2021 WPPConnect Team.
71
102
 
103
+ The original legal document and existing copyright notices are preserved. Third-party components retain their own terms.
package/README.pt-BR.md ADDED
@@ -0,0 +1,103 @@
1
+ [English](./README.md) | **Português (Brasil)**
2
+
3
+ <p align="center">
4
+ <a href="https://wppconnect.io/">
5
+ <picture>
6
+ <source media="(prefers-color-scheme: dark)" srcset="https://wppconnect-team.github.io/brand/v2/wppconnect-dark.png" />
7
+ <img src="https://wppconnect-team.github.io/brand/v2/wppconnect-light.png" alt="WPPConnect" width="220" height="121" />
8
+ </picture>
9
+ </a>
10
+ </p>
11
+
12
+ # WPPConnect Server CLI
13
+
14
+ Inicie o WPPConnect Server pelo comando `wppserver`.
15
+
16
+ Um projeto do ecossistema WPPConnect, mantido pela WPPConnect Team.
17
+
18
+ [Primeiros passos](#primeiros-passos) | [Documentação](#documentação) | [Como contribuir](#como-contribuir) | [Apoie a WPPConnect](#apoie-o-projeto)
19
+
20
+ [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE) [![npm version](https://img.shields.io/npm/v/@wppconnect/server-cli)](https://www.npmjs.com/package/@wppconnect/server-cli) [![CI](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml) [![Open Collective](https://img.shields.io/badge/Open%20Collective-WPPConnect-blue)](https://opencollective.com/wppconnect)
21
+
22
+ ## Visão geral
23
+
24
+ Para desenvolvedores que querem configurar o Server Node.js pela linha de comando. A CLI encapsula o Server; a API do Server e a aplicação web Manager são componentes separados.
25
+
26
+ ## Funcionalidades
27
+
28
+ - Inicie o servidor e defina opções como a porta HTTP.
29
+ - Consulte as opções disponíveis com `wppserver --help`.
30
+ - Disponibilize um frontend estático fornecido com `--frontend-path`.
31
+
32
+ ## Primeiros passos
33
+
34
+ Exige Node.js `^22.18.0 || >=24.11.0`, npm e as dependências de navegador/nativas do WPPConnect Server.
35
+
36
+ ```sh
37
+ npm install -g @wppconnect/server-cli
38
+ wppserver --help
39
+ wppserver --port 8000
40
+ ```
41
+
42
+ Abra `http://localhost:8000/api-docs` para consultar a API em execução. Configure o segredo do Server e as credenciais de sessão antes de expor o serviço.
43
+
44
+ ## Configuração
45
+
46
+ Consulte [src](src/) e `wppserver --help` para as opções. `--frontend` usa o pacote legado `@wppconnect/frontend`; para a interface mantida siga as instruções do WPPConnect Manager ou use `--frontend-path` com um build estático compatível. O desenvolvimento pelos fontes usa Yarn 1.22.22, declarado em `packageManager`.
47
+
48
+ ## Documentação
49
+
50
+ - [Guia do Server](https://github.com/wppconnect-team/wppconnect-server)
51
+ - [Vídeo tutorial da CLI](https://www.youtube.com/watch?v=zBmCnPS3JOQ)
52
+ - [Detalhes técnicos e agradecimentos preservados](documentation/readme-reference.md)
53
+
54
+ ## Ecossistema WPPConnect
55
+
56
+ | Projeto | Finalidade | Quando usar |
57
+ | --- | --- | --- |
58
+ | [WPPConnect Server](https://github.com/wppconnect-team/wppconnect-server) | Execute uma API REST para sessões, mensagens e webhooks do WhatsApp. | Expor operações de sessão e mensagens por HTTP. |
59
+ | [WPPConnect Manager](https://github.com/wppconnect-team/wppconnect-manager) | Gerencie sessões e conversas do WPPConnect Server em uma aplicação web auto-hospedada. | Operar sessões e conversas de um Server compatível pela interface. |
60
+
61
+ ## Apoie o projeto
62
+
63
+ A WPPConnect é mantida por uma comunidade de código aberto. Seu apoio ajuda a financiar a manutenção, a infraestrutura, a documentação e o trabalho das pessoas que desenvolvem o ecossistema.
64
+
65
+ Se a WPPConnect ajuda seu projeto ou sua empresa, considere fazer uma contribuição pontual ou apoiar de forma recorrente.
66
+
67
+ **[Apoie a WPPConnect no Open Collective](https://opencollective.com/wppconnect)**
68
+
69
+ As contribuições são voluntárias. Consulte a página oficial para acompanhar as informações financeiras atuais. Você também pode ajudar com código, testes, documentação, traduções e relatos de problemas bem descritos.
70
+
71
+ Beneficiários oficiais adicionais em [.github/FUNDING.yml](.github/FUNDING.yml): [joaosouz4dev](https://github.com/sponsors/joaosouz4dev), [manfe](https://github.com/sponsors/manfe).
72
+
73
+ ## Como contribuir
74
+
75
+ Contribuições de código, testes, exemplos, documentação e traduções são bem-vindas. Para mudanças maiores, discuta a proposta em uma issue primeiro. Ao relatar um problema, informe as versões do projeto/runtime, uma reprodução mínima e logs sem dados sensíveis. Atualize `README.md` e `README.pt-BR.md` na mesma alteração quando mudar instalação, configuração, funcionalidades, exemplos, licença ou arrecadação.
76
+
77
+ Após instalar as dependências de desenvolvimento, use as verificações pertinentes à sua alteração:
78
+
79
+ ```sh
80
+ yarn build
81
+ yarn lint
82
+ yarn test
83
+ ```
84
+
85
+ Exemplos e testes que dependem de conta exigem validação separada com uma conta de teste autorizada. Nunca anexe credenciais ou arquivos de sessão a uma issue.
86
+
87
+ ## Comunidade e suporte
88
+
89
+ Use as [issues do repositório](https://github.com/wppconnect-team/server-cli/issues) para bugs reproduzíveis e propostas de funcionalidades. Para dúvidas de uso, participe pelos canais oficiais:
90
+
91
+ - [Discord](https://discord.gg/JU5JGGKGNG)
92
+ - [Telegram](https://t.me/wppconnect)
93
+ - [YouTube](https://www.youtube.com/c/wppconnect)
94
+
95
+ Este projeto é independente e não é afiliado nem endossado pelo WhatsApp ou pela Meta. Siga os termos aplicáveis e obtenha autorização para operações de conta e mensagens.
96
+
97
+ ## Licença
98
+
99
+ [Apache License 2.0 (Apache-2.0)](./LICENSE).
100
+
101
+ Copyright 2021 WPPConnect Team.
102
+
103
+ O documento jurídico original e os avisos de autoria existentes são preservados. Componentes de terceiros mantêm seus próprios termos.
package/documentation/readme-reference.md ADDED
@@ -0,0 +1,78 @@
1
+ # Retained README reference / Referência preservada do README
2
+
3
+ This document preserves the previous `README.md` for technical details, acknowledgments and history. Start with [README.md](../README.md) or [README.pt-BR.md](../README.pt-BR.md) for the current verified entry path. Older commands, release claims, third-party examples and API signatures here may need migration; consult the current source and linked guides.
4
+
5
+ Este documento preserva o `README.md` anterior com detalhes técnicos, agradecimentos e histórico. Comece pelo [README em português](../README.pt-BR.md) para as instruções iniciais conferidas. Comandos antigos, afirmações sobre releases, exemplos de terceiros e assinaturas de API podem exigir migração; consulte os fontes e guias atuais.
6
+
7
+ ---
8
+
9
+ <!-- wppconnect-official-brand -->
10
+ <p align="center">
11
+ <a href="https://wppconnect-team.github.io/">
12
+ <picture>
13
+ <source media="(prefers-color-scheme: dark)" srcset="https://wppconnect-team.github.io/brand/wppconnect-dark.png" />
14
+ <img src="https://wppconnect-team.github.io/brand/wppconnect-light.png" alt="WPPConnect" width="220" height="121" />
15
+ </picture>
16
+ </a>
17
+ </p>
18
+ <!-- /wppconnect-official-brand -->
19
+
20
+ # WPPConnect Team
21
+
22
+ ## _WPPConnect Server Cli_
23
+
24
+ [![Build](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml/badge.svg)](https://github.com/wppconnect-team/server-cli/actions/workflows/build.yml)
25
+
26
+ Esse pacote facilita a utilização do servidor WPPConnect-server através de uma linha de comando
27
+
28
+ ## Nossos canais online
29
+
30
+ [![Discord](https://img.shields.io/discord/844351092758413353?color=blueviolet&label=Discord&logo=discord&style=flat)](https://discord.gg/JU5JGGKGNG)
31
+ [![Telegram Group](https://img.shields.io/badge/Telegram-Group-32AFED?logo=telegram)](https://t.me/wppconnect)
32
+ [![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/LJaQu6ZyNvnBPNAVRbX00K)
33
+ [![YouTube](https://img.shields.io/youtube/channel/subscribers/UCD7J9LG08PmGQrF5IS7Yv9A?label=YouTube)](https://www.youtube.com/c/wppconnect)
34
+
35
+ ## Instalação
36
+
37
+ Para instalar, basta executar.
38
+
39
+ ```sh
40
+ yarn global add @wppconnect/server-cli
41
+ //ou
42
+ npm install -g @wppconnect/server-cli
43
+ ```
44
+
45
+ ## E para executar
46
+
47
+ ```sh
48
+ wppserver
49
+ //ou
50
+ wppserver --port 8000
51
+ ```
52
+
53
+ ## Para mais opções
54
+
55
+ ```sh
56
+ wppserver --help
57
+ ```
58
+
59
+ ## Frontend
60
+
61
+ Para adicionar o frontend automaticamente, basta instalar
62
+
63
+ ```sh
64
+ yarn global add @wppconnect/frontend
65
+ //ou
66
+ npm install -g @wppconnect/frontend
67
+ ```
68
+
69
+ E executar
70
+
71
+ ```sh
72
+ wppserver --frontend
73
+ //ou
74
+ wppserver --frontend-path <caminho do frontend (pasta dist)>
75
+ ```
76
+
77
+ ## Tutorial - Youtube
78
+ - Veja o tutorial de uso no [Canal WPPConnect](https://www.youtube.com/watch?v=zBmCnPS3JOQ).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wppconnect/server-cli",
3
- "version": "1.3.58",
3
+ "version": "1.3.60",
4
4
  "description": "Servidor de WPPConnect com frontend para ser executado a partir de uma linha de comando",
5
5
  "repository": {
6
6
  "type": "git",