Auto Installer (Recommended)

Easiest way to install on Windows & Linux

macOS | Linux & Termux

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

Windows PowerShell

irm https://cipher-md.syntiox.top/install.cmd | 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

==========================================
⚠️ [ CIPHER-MD SETUP & CONFIGURATION ] ⚠️
==========================================

 1️⃣ [ BASIC SETTINGS | මූලික සැකසුම් ]

 Your WhatsApp Session ID | ඔබගේ WhatsApp Session ID එක (Required)
SESSION_ID=your_session_id_here

 Number to get pairing code | ශෙශන් එක ලබාගැනීමට භාවිතා කරන අංකය (Required)
PAIRING_NUMBER=947xxxxxxxx

 MongoDB Database connection URL | MongoDB ඩේටාබේස් එකට අදාළ ලින්ක් එක (Required)
MONGO_URL=your_mongodb_url_here

 Owner's phone number | බොට්ගේ අයිතිකරුගේ දුරකථන අංකය (Optional)
OWNER_NUMBER=947xxxxxxxx

 Name of your WhatsApp Bot | බොට් සඳහා ඔබ කැමති නමක් (Optional)
BOT_NAME=CIPHER-MD


 2️⃣ [ AI & API KEYS | AI සහ වෙනත් සේවා යතුරු (Optional) ]

 Groq API Key | Groq සේවාව සඳහා (කොමාවකින් වෙන් කර කිහිපයක් දිය හැක)
GROQ_API_KEY=your_groq_key

 Gemini API Key | Gemini AI සඳහා
GEMINI_API_KEY=your_gemini_key

 Firecrawl API Key | Firecrawl සේවාව සඳහා
FIRECRAWL_API_KEY=your_firecrawl_key

 HuggingFace Token | HuggingFace මොඩල් සඳහා
HF_TOKEN=your_hf_token

 NASA API Key | NASA දත්ත ලබාගැනීමට
NASA_API_KEY=your_nasa_key

 Rapid API Key | RapidAPI සේවාවන් සඳහා
RAPID_API_KEY=your_rapidapi_key

 Syntiox API Key | Syntiox සේවාව සඳහා
SYNTIOX_API_KEY=your_syntiox_key

 VirusTotal API Key | ෆයිල් ස්කෑන් කිරීමට භාවිතා කරන යතුර
VT_API_KEY=your_virustotal_key


 4️⃣ [ BOT CUSTOMIZATION | බොට්ගේ පෙනුම (Optional) ]

 Footer text for messages | මැසේජ් යටින් වැටෙන පාඨය
FOOTER=Powered by Syntiox

 Direct Link for Menu Image | මෙනු එකේ පෙන්වන රූපයේ ලින්ක් එක
MENU_IMAGE=https://your-image-link.com/image.jpg


 5️⃣ [ AI PLATFORM CONFIG | AI සේවා සැකසුම් (Optional) ]
 (Platforms: google, groq, openai)

AI_CHAT_PLATFORM=google
AI_CHAT_MODEL=gemini-3.1-flash-lite

AI_AGENT_PLATFORM=google
AI_AGENT_MODEL=gemini-3.1-flash-lite


 6️⃣ [ AGENTIC TASKS | Google සේවාවන් (Optional) ]
 (Emails, Calendar ආදිය සඳහා. JSON කෝඩ් එක තනි පේළියක් (Single line) ලෙස දමන්න)

GOOGLE_CREDENTIALS='{"installed":{"client_id":"..."}}'
GOOGLE_TOKEN='{"token":"..."}'

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 | bash

# 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