Menu Close




Send WhatsApp messages from the command-line.

This project is based on Baileys, a full-featured WhatsApp Web+Multi-Device
API library (in case you’re wondering about the name, a Mudslide is a Baileys cocktail).

See also this Medium post.

Table of Contents:


Using npx installation is not necessary. You can run Mudslide on a system with NodeJS 16 or higher from the
command-line as follows:

npx mudslide -V

this should display the version number of the latest release.

Using npm Mudslide can be installe globally as follows:

npm install -g mudslide


Available commands and options can be listed with --help flag:

npx mudslide --help

for most command it’s necessary that you’ve authorized Mudslide to interact with the WhatsApp API on your behalf.
This can be done by logging in as described below.


To login you need to authorize Mudslide from another device that has WhatsApp installed and scan the QR code printed
in the terminal:

npx mudslide login
█▀▀▀▀▀█ ▀▀   ▀  █ █▀▀▀▀▀█
█ ███ █ █▄ █▀▀▀▀  █ ███ █
█ ▀▀▀ █ ▀█▀▀▄▀█▀▀ █ ▀▀▀ █
▀▀▀▀▀▀▀ ▀▄▀▄▀▄█▄▀ ▀▀▀▀▀▀▀
▀███▄ ▀▄▀▄   ▀▀ █▀ ▄▀▀▀▄▀
█▄▄▄▄ ▀ ▄  ▄▄▄█▄ ▄█▀ ▄▄  
▀▄ ▄▀ ▀ ▄█▄█ ▄ ▄ ██▄█ ▀▀█
▄▀▄██▀▀██▄▀ █▄▀▄▄█▀▄█ ▀▀▄
    ▀▀▀ ███▀▄▄  █▀▀▀█▀█▀█
█▀▀▀▀▀█   ▀▀█  ▄█ ▀ █ ▀██
█ ███ █ ▄▄█▀██▄▄▀██▀██▄▄▄
█ ▀▀▀ █ █▀▀▀▀▀ ▀▀█▀ █ █▀ 
▀▀▀▀▀▀▀ ▀▀▀ ▀ ▀  ▀ ▀▀▀▀▀▀

In the WhatsApp mobile app go to “Settings > Connected Devices > Connect
Device” and scan the QR code. Wait until the status is “active”, then you can
exit Mudslide.


Logging out removes credentials from your local environment but will not
disconnect Mudslide from your WhatsApp account, you can disconnect Mudslide
using the WhatsApp app.

npx mudslide logout

Sending a message to yourself or a phone number

Using the recipient me you can send yourself a test message:

npx mudslide send me 'hello world'

To send a message to a phone number:

npx mudslide send 3161234567890 'hello world'

Sending an image file

Image files (PNG, JPG, GIF) can be sent to individuals or groups:

npx mudslide send-image me image.png
npx mudslide send-group-image 123456789-987654321 image.jpg

List your groups

To list all the groups you are participating in:

npx mudslide groups

this will show a list of group IDs and subjects.

Sending a message to a group

To send a message to a group you are particpating in you need the numerical group ID (see the mudslide groups command).
Send a message to a group as follows:

npx mudslide send-group 123456789-987654321 'hello world'

Show current user details

To get the WhatsApp ID of the logged in user:

npx mudslide me


By default WhatsApp credentials are cached in a folder located in the user’s
home directory. This folder is .local/share/mudslide' on Linux & macOS and
AppData\Local\mudslide\Data on Windows.

A different location for the cache folder can be configured via the environment
variable MUDSLIDE_CACHE_FOLDER or the -c/--cache options.

Feedback, suggestions and bug reports

Please create an issue here:


If you have suggestions for how Mudslide could be improved, or want to report a
bug, open an issue! All and
any contributions are appreciated.


ISC © 2022 Rob van der Leek

View Source Code
Posted in Development