Pretty-MD

Your automation, our priority

Pretty-MD is a WhatsApp automation and developer ecosystem built by XHYPHER TECH — pair a device, deploy it to the platform of your choice, and extend it as a developer. This hub is where the pairing servers, deployment guides, source code, and documentation for Pretty-MD live.

Open Pairing Site Deploy Pretty-MD View Source Read Documentation

570+Commands

15+AI features

50+Plugins

Open sourceFree to use & modify

Quick Start

From zero to paired

Get the source

Install requirements

Configure

Choose deployment

Pair WhatsApp

Start automating

Pairing Center

Connect your WhatsApp account

Pretty-MD supports pair-code and QR-code pairing through the servers below.

Primary Pair Code Server

Generate a pairing code to link your WhatsApp device to Pretty-MD.

External service — status not monitored here

Open Pairing Site

Backup Pair Code Server

Use this if the primary pairing server is slow or unreachable.

External service — status not monitored here

Open Backup Server

QR Code Generator

Prefer scanning? Generate a QR code to connect instead of a pair code.

External service — status not monitored here

Open QR Generator

Having trouble pairing? See Troubleshooting or the FAQ.

Deployment Center

Deploy Pretty-MD

One-click cloud platforms, plus guided manual installation for VPS, Windows, and Termux.

One-click / hosted platforms

Railway

Deploy from the official Pretty-MD Railway template.

BeginnerTemplate deploy

Deploy on Railway

Replit

Run Pretty-MD from an online IDE — no local setup required.

BeginnerLink pending

Run on Replit

Heroku

A guided walkthrough for deploying Pretty-MD to Heroku.

IntermediateGuide

Deployment Guide

CypherX Platform

A third-party managed hosting platform some users deploy Pretty-MD on. Not a XHYPHER TECH product.

IntermediateThird-party

Access Platform

Manual installation

Windows 10/11
PowerShell (Admin)
Internet connection

PowerShell — full install

# Update system
winget upgrade --all

# Install required software
winget install Git.Git
winget install Gyan.FFmpeg
winget install ImageMagick.ImageMagick
winget install OpenJS.NodeJS.LTS

# IMPORTANT: Restart PowerShell before proceeding
# Press Ctrl+C to stop, then reopen PowerShell as Administrator

# Clone repository
git clone https://github.com/xhyphertech/Pretty-md.git
cd Pretty-md

# Install dependencies
npm install

# Configure environment
npm run setup

# Start bot
npm start

Restart PowerShell first

You must restart PowerShell after installing Node.js before running the git clone step.

First-time setup

npm run setup configures your bot settings and environment variables.

Ubuntu / Debian VPS
SSH access
Minimum 1GB RAM

VPS — full install

sudo apt update && sudo apt upgrade -y
sudo apt install -y git imagemagick ffmpeg libwebp-dev
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
source ~/.bashrc
nvm install 20
nvm use 20
git clone https://github.com/xhyphertech/Pretty-md.git
cd Pretty-md
npm install --build-from-source
npm run setup
npm start

Termux (from F-Droid)
Storage permission
Stable power source

Termux — full install

pkg update -y && pkg upgrade -y
pkg install -y git nodejs-lts python make clang libsqlite
termux-setup-storage
cd ~
git clone https://github.com/xhyphertech/Pretty-md.git
cd Pretty-md
npm config set python python3
npm install --build-from-source
npm run setup
npm start

Already-installed bot
Node.js environment
Production server

PM2 — setup

npm install -g pm2
pm2 start index.js --name pretty-md
pm2 save
pm2 startup
pm2 logs pretty-md

Stop bot

pm2 stop pretty-md

Restart bot

pm2 restart pretty-md

Delete process

pm2 delete pretty-md

List processes

pm2 list

Monitor

pm2 monit

View logs

pm2 logs pretty-md

Interactive Deployment Terminal

Watch the deployment flow, step by step

A safe, simulated terminal that walks through the exact commands above for each platform. Nothing here executes on a real machine or server — it's an interactive way to preview the deployment flow before you run it yourself.

Termux Step 0 / 0

Why simulated?

Visitors can't run arbitrary commands on the XHYPHER TECH server through this page. The commands shown are copied from the real install instructions above — copy them and run them on your own device, VPS, or Termux session.

Source Code

Source code center

Official Repository

xhyphertech/Pretty-md

Pretty-MD is open source. Clone it, fork it, or download an archive directly.

—Stars

—Forks

—Last pushed

View Source Fork Repository Download ZIP Latest Release

Star and fork counts are fetched live from the GitHub API — not hardcoded.

Features

What Pretty-MD includes

Feature categories as described by the project — see the source repository for full implementation details.

AI Features

Built-in AI-powered commands.

Media Tools

Media conversion and download utilities.

Group Management

Tools for managing WhatsApp groups.

Downloaders

Fetch media from supported sources.

Games

Built-in interactive games.

Utilities

General-purpose helper commands.

Plugin Support

Extend Pretty-MD with additional plugins.

580+ Commands

See the in-bot help menu for the full, current command list.

Command Directory

Searchable command reference

Browse commands by category. The definitive, always-current list lives in Pretty-MD's own in-bot help menu — this directory is built to plug straight into that list.

Command	Description	Category	Usage

This directory is not populated with individual commands yet, so nothing is fabricated here. Pull the real command list from the bot's help/menu output or source and drop it into js/config.js → commandDirectory to populate this table automatically.

AI inside Pretty-MD

Pretty-MD includes built-in AI-powered commands as part of its standard feature set. Exact capabilities depend on the version and configuration you deploy — the source repository is the source of truth.

AI-Powered Commands

A set of AI-driven commands ships as part of Pretty-MD's default command set.

Runs Alongside Automation

AI commands sit alongside Pretty-MD's wider automation and utility toolset rather than as a separate product.

See the Source for Specifics

For exact AI command names, providers, and configuration options, refer to the repository.

Plugin Ecosystem

Extend Pretty-MD

Pretty-MD supports plugins as a way to extend its command set. No third-party plugin directory is published yet — this is the developer-facing starting point for that ecosystem.

Install a Plugin

Drop a plugin file into Pretty-MD's plugin directory following the structure documented in the source repository, then restart the bot.

Read Setup Docs

Create a Plugin

Build your own plugin using Pretty-MD's plugin structure and contribute it back via the source repository.

View Source

Plugin Directory

A curated directory of community plugins isn't published yet. This card is a placeholder until one exists.

Coming soon

Documentation

Developer documentation

Introduction

Pretty-MD is a WhatsApp automation bot built on Node.js and Baileys. This documentation covers getting a copy running, deploying it, and keeping it online.

Requirements

Requirements differ slightly by platform — see the requirement list at the top of each tab in the Deployment Center. In general you'll need Node.js, Git, and enough memory to run a persistent Node.js process (1GB+ recommended on a VPS).

Configuration

STEP

After installing dependencies, run:

Setup

npm run setup

This walks you through configuring your bot settings and environment variables before the first start.

Deployment platforms

Full guided instructions for each platform — including exact commands — live in the Deployment Center above, covering Railway, Replit, Heroku, VPS, Windows, and Termux.

Pair code & QR pairing

Pretty-MD supports two pairing methods: a numeric pair code (via the Primary or Backup Pair Code Server) or scanning a QR code (via the QR Code Generator). Both are available in the Pairing Center.

Pairing troubleshooting

If pairing fails on one server, try the alternate pairing method or server — see Troubleshooting.

PM2 process management

PM2 is a process manager for Node.js applications. It keeps Pretty-MD running in the background, restarts it automatically if it crashes, and gives you a single place to view logs — which is why it's the recommended way to run Pretty-MD on a VPS.

Install & start

npm install -g pm2
pm2 start index.js --name pretty-md
pm2 save
pm2 startup

See the full command reference in the PM2 tab of the Deployment Center.

Updating Pretty-MD

Pretty-MD includes an auto-update system. You can also update manually by pulling the latest changes from GitHub and restarting your deployment:

Manual update

git pull
npm install
pm2 restart pretty-md

Troubleshooting

Common issues

Node.js command not recognized after Windows install

Cause

PowerShell was not restarted after installing Node.js via winget.

Solution

Close PowerShell completely, reopen it as Administrator, then continue from the git clone step.

Native module build errors on VPS or Termux

Cause

Some dependencies compile native modules and need build tools present.

Solution

Use npm install --build-from-source as shown in the VPS/Termux install commands, and on Termux run npm config set python python3 first.

Pairing fails or times out

Cause

The pairing server you're using may be temporarily slow or unreachable.

Solution

Try the Backup Pair Code Server, or switch to QR pairing instead — both are in the Pairing Center.

Bot stops responding after a while (VPS)

Cause

Running with npm start directly stops the bot if your terminal session ends.

Solution

Run it under PM2 instead — see the PM2 tab — so it keeps running and restarts automatically.

Still stuck?

Next step

Check your terminal/PM2 logs first (pm2 logs pretty-md), then reach out via the contacts in the FAQ.

FAQ

Frequently asked questions

Yes. Pretty-MD is free and open-source, available for anyone to use and modify.

WhatsApp automation can conflict with WhatsApp's terms of service. We recommend using a secondary account and staying mindful of usage patterns to reduce the risk of restrictions.

On GitHub at superstar-zimtk/Pretty-md.

All three are supported, along with Railway, Replit, and Heroku. Step-by-step commands for each are in the Deployment Center.

Pretty-MD includes an auto-update system. To update manually: pull the latest changes from GitHub, reinstall dependencies, and restart with PM2 — see Updating Pretty-MD. To restart, run pm2 restart pretty-md.

Try the Backup Pair Code Server or QR pairing instead. See Troubleshooting for more.

Reach out via email or WhatsApp, or join the community links in the XHYPHER TECH Community section.