English | Português (Brasil)

WPPConnect Server CLI

Start WPPConnect Server from the wppserver command.

A project in the WPPConnect ecosystem, maintained by WPPConnect Team.

Getting started | Documentation | Contributing | Support WPPConnect

Overview

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.

Features

• Start the server and set options such as the HTTP port.
• Inspect supported flags with wppserver --help.
• Serve a supplied static frontend with --frontend-path.

Getting started

Requires Node.js ^22.18.0 || >=24.11.0, npm and the browser/native dependencies required by WPPConnect Server.

npm install -g @wppconnect/server-cli
wppserver --help
wppserver --port 8000

Open http://localhost:8000/api-docs to inspect the running API. Configure the Server secret and session credentials before exposing the service.

Configuration

See 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.

Documentation

• Server guide
• CLI tutorial video
• Retained technical details and acknowledgments

WPPConnect ecosystem

Project	Purpose	When to use it
WPPConnect Server	Run a REST API for WhatsApp sessions, messages and webhooks.	Expose session and messaging operations over HTTP.
WPPConnect Manager	Manage WPPConnect Server sessions and conversations in a self-hosted web workspace.	Operate compatible Server sessions and chats through a UI.

Support the project

WPPConnect is maintained by an open-source community. Your support helps fund maintenance, infrastructure, documentation, and the people working on the ecosystem.

If WPPConnect helps your project or business, consider making a one-time contribution or becoming a recurring supporter.

Support WPPConnect on Open Collective

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.

Additional official beneficiaries in .github/FUNDING.yml: joaosouz4dev, manfe.

Contributing

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.

After installing the development dependencies, use the repository checks relevant to your change:

yarn build
yarn lint
yarn test

Account-dependent examples and tests require separate validation with an authorized test account. Never attach credentials or session files to an issue.

Community and support

Use repository issues for reproducible bugs and feature proposals. For usage questions, join the community through the official channels:

• Discord
• Telegram
• YouTube

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.

License

Apache License 2.0 (Apache-2.0).

Copyright 2021 WPPConnect Team.

The original legal document and existing copyright notices are preserved. Third-party components retain their own terms.