WILDCAT Documentation
Complete guides for installing, configuring, and using WILDCAT.
🚀 Start Here
New to WILDCAT?
| Guide | Time | Learn |
|---|---|---|
| 5-Minute Quickstart | 5 min | Get WILDCAT running instantly |
| Detailed Installation Guide | 15 min | Step-by-step setup with all options |
🔌 Building with WILDCAT
| Resource | Purpose | Time |
|---|---|---|
| API Reference | All REST endpoints with examples | Reference |
| Integration Examples | n8n, Zapier, Node.js, Python | 15-30 min |
| Deployment Guide | VPS, Docker, Heroku, AWS, home server | 30-60 min |
🆘 Need Help?
| Issue | Solution |
|---|---|
| Problems? | Check Troubleshooting & FAQ |
| Questions? | Browse Getting Started |
| Stuck? | Search GitHub Issues |
📚 Documentation Sections
Getting Started
- Quickstart - 5-minute setup guide
- Installation - Complete installation with all options
- Prerequisites, environment setup, first run
API Reference
- All 20+ REST endpoints documented
- Request/response examples
- Authentication, error codes, best practices
Guides
- Deployment Guide - VPS, Docker, Heroku, AWS, home server
- Integration Examples - Real-world workflows
Troubleshooting
- FAQ & Solutions - Common problems and fixes
📖 Full Documentation Index
Getting Started
Guide new users through setup and first steps.
- Quickstart - Get WILDCAT running in 5 minutes
- Installation - Complete step-by-step installation with all options
API Reference
Complete reference for all REST endpoints.
- All 20+ endpoints documented
- Request/response examples
- Error handling and status codes
- Authentication overview
Guides
Practical guides for real-world scenarios.
- Deployment Guide - Deploy to VPS, Docker, Heroku, AWS EC2, or home server
- Integration Examples - Integrate with n8n, Zapier, Node.js, Python
Troubleshooting
Solutions to common problems.
- FAQ & Solutions - Frequently asked questions and how to fix common issues
- Debug tips, error messages, and support resources
🎯 Quick Answers
How do I install WILDCAT?
Start here: Installation Guide
Quick version:
npm ci
cp .env.example .env
# Edit .env with MONGO_URL and DB_NAME
npm run dev
What are the main features?
- ✅ Send/receive WhatsApp messages via REST API
- ✅ Manage multiple WhatsApp accounts
- ✅ Media file support (images, videos, documents)
- ✅ Webhook integration for received messages
- ✅ Message reactions and replies
- ✅ Message deletion and editing
- ✅ Get chat lists and conversation history
Is this production-ready?
Not yet. v2 is suitable for development/testing. Production deployment recommended for v3.0+ (Q2 2025) which will include:
- Built-in authentication and rate limiting
- Security hardening
- Performance optimizations
- TLS encryption
Can I use this commercially?
⚠️ Use at your own risk. WILDCAT uses reverse-engineered WhatsApp Web protocols (unofficial). WhatsApp’s Terms of Service prohibit automated messaging for marketing. Heavy use may result in account restrictions.
How do I deploy to production?
See Deployment Guide for:
- Virtual Private Server (VPS) setup
- Docker containerization
- Heroku hosting
- AWS EC2 deployment
- Home server/Raspberry Pi
Where can I find API documentation?
See API Reference - all REST endpoints with examples, error codes, and best practices.
How do I integrate with other services?
See Integration Examples:
- n8n visual workflows
- Zapier automations
- Node.js client code
- Python client code
🆘 Support
| Need Help? | Go To |
|---|---|
| Installation issues | Installation Guide |
| Can’t send messages | Troubleshooting FAQ |
| Webhook not working | Troubleshooting FAQ |
| Deployment questions | Deployment Guide |
| API endpoint help | API Reference |
| Database issues | Troubleshooting FAQ |
| Connection problems | Troubleshooting FAQ |
| General questions | FAQ & Troubleshooting |
📚 Related Documentation
Legacy Documentation (archived format, still valid for reference):
- SETUP.md - Original setup guide
- API_Reference.md - Original endpoint reference
- ARCHITECTURE.md - System architecture
- DEVELOPMENT.md - Development guidelines
🔗 External Resources
WhatsApp & Baileys
- Baileys Library - WhatsApp Web reverse engineering
- WhatsApp Business - Official WhatsApp Business info
Technologies
Integrations
📊 Documentation Stats
- Total Pages: 12 comprehensive documents
- Code Examples: 100+ copy-paste ready commands
- Endpoints Documented: 20+ REST API endpoints
- Deployment Options: 5 (VPS, Docker, Heroku, AWS, home server)
- Integration Examples: 4 (n8n, Zapier, Node.js, Python)
- Troubleshooting Q&A: 30+ solutions
- Last Updated: November 2025
**[← Back to README](../README.md)** • **[GitHub](https://github.com/NotoriousArnav/wildcat)**