[!WARNING] Versions 5.6.x and 5.7.x are UNSTABLE because of management error. Please use 5.5.4 instead.

Open-source framework for message automation, extensible via community plugins.

Requirements

• Node.js >= 24
• npm >= 9

Getting started

Install from npm

npm install -g @manybot/manybot
npm install -g @manybot/manyplug
manybot

On first run, a configuration file is created at ~/.manybot/manybot.toml. Edit it to set up your preferences.

Develop from source

git clone <repo-url>
cd dev
npm install
npm start

For detailed setup instructions, see the documentation.

Plugins

ManyBot's functionality comes from plugins. Install them with ManyPlug:

manyplug install <plugin-name>

Browse available plugins at manybot.org/plugins.

Testing

ManyBot includes both local unit/contract tests and opt-in real WhatsApp integration tests:

# Run unit and mock contract test suite (fast, offline)
npm test

# Run all verification gates (typecheck + lint + unit tests)
npm run check

# Run real WhatsApp integration tests (requires TEST_CHAT and live session)
TEST_CHAT="5516999999999" npm run test:integration

For full details on the test architecture and API coverage classification, see API_TEST_PLAN.md.

Contributing

All kinds of contributions are welcome:

• Bug reports and feature requests: open an issue on GitHub or Codeberg
• Code: pull requests are welcome on GitHub or Codeberg; patches by email ([email protected]) are also accepted.
• Plugins: submit your plugin to manyplug-repo, which has instructions on how to do it
• Anything else: suggestions, translations, documentation fixes, art - reach out by email or open an issue

License

ManyBot is distributed under the GNU General Public License v3.0.