Auto Installer (Recommended)

Easiest way to install on Windows & Linux

macOS | Linux & Termux

curl -sL https://cipher-md.syntiox.top/install.sh -o install.sh && bash install.sh

Windows PowerShell

irm https://cipher-md.syntiox.top/install.cmd -OutFile install.cmd ; .\install.cmd

Windows CMD

curl -sL https://cipher-md.syntiox.top/install.cmd -o install.cmd && install.cmd && del install.cmd

Post-Installation Shortcuts

The Auto Installer automatically sets up the bot and creates handy shortcuts for you on your Desktop (inside a "cipher md" folder) and as Global Terminal Commands!

Standard Node.js (2 Shortcuts)
  • cipher-md : Starts the bot
  • cipher-env : Opens .env file for editing
Docker Method (4 Shortcuts)
  • cipher-md : Starts the container
  • cipher-env : Opens .env file for editing
  • cipher-stop : Stops the container
  • cipher-restart : Restarts the container

Auto Deployment

Deploy to Cloud Platforms (1-Click)
Deploy to Heroku Deploy to Koyeb Deploy on Railway Deploy to Render

Deployment Guide

Follow these steps carefully
1

Fork the Repository

Before deploying, you must fork the source code to your own account. This allows you to manage your own bot instance.

Fork on GitHub
2

Get Your Session ID

Go to the 'Connect Bot' page to link your WhatsApp. Once connected, you will receive a unique SESSION_ID. Copy and save it safely.

Get Session ID
3

Deploy to a Platform

Click one of the official deploy buttons above (Heroku/Koyeb/Railway). You will need to log in with your GitHub account.

4

Fill Environment Variables

During deployment, the platform will ask for variables. Copy the values from the 'Environment Variables' section below and paste them correctly.

5

Start the Bot

Wait for the build process to finish. Once it's done, your bot will automatically connect to WhatsApp and start working!

Environment Variables

Required Configuration (.env)

Configure these variables in your deployment platform (Koyeb/Heroku/Railway) before starting the bot.

.env Variables
Loading environment variables...

Manual Deployment

For Advanced Users & VPS Hosting

Node.js Method

Recommended for local testing and standard Linux VPS hosting.

Terminal / Shell
# 1. Clone repo
git clone https://github.com/sh4lu-z/Cipher-MD.git
cd Cipher-MD

# 2. Install dependencies
npm install

# 3. Create .env file and fill variables
nano .env

# 4. Start the bot
npm start

Termux (Android)

Run directly on your phone. Important: Download Termux from F-Droid (Play Store version is obsolete).

Termux App
# 1. Update Termux
pkg update -y && pkg upgrade -y

# 2. Run Auto Installer
curl -sL https://cipher-md.syntiox.top/install.sh -o install.sh && bash install.sh

# 3. Start the bot (If closed later)
cipher-md

Docker Method

Recommended for high stability and isolated container environments.

Docker Compose
# 1. Clone repo
git clone https://github.com/sh4lu-z/Cipher-MD.git
cd Cipher-MD

# 2. Create .env file manually
nano .env

# 3. Start container in background
docker-compose up -d