README.md 2.7 KB
📚 Documentation
Complete documentation for the Hyperliquid Manual Trading Bot
📋 Documentation Index
🚀 Getting Started
- Setup Guide - Quick 5-minute installation guide
- Commands Reference - Complete command guide with examples
🔧 Technical Documentation
- Project Structure - Codebase organization and architecture
- Testing Guide - Test suite documentation and usage
- Deployment Guide - Production server deployment
📱 Quick Links
| What You Need | Documentation | Time Required |
|---|---|---|
| Install & Run | Setup Guide | 5 minutes |
| Learn Commands | Commands Reference | 10 minutes |
| Test Everything | Testing Guide | 5 minutes |
| Understand Code | Project Structure | 15 minutes |
| Deploy to Server | Deployment Guide | 20 minutes |
🎯 Most Important First
- Start Here: Setup Guide - Get the bot running
- Test Setup: Testing Guide - Verify everything works
- Learn Commands: Commands Reference - Use all features
- Deploy: Deployment Guide - Run on server
📱 Bot Features Quick Reference
💰 Account Management
/balance # Account balance
/positions # Open positions
/orders # All open orders
/orders BTC # BTC orders only
/stats # Trading statistics
🔧 Order Management
/orders BTC # View BTC orders
/coo BTC # Cancel all BTC orders
/exit BTC # Close BTC position
🚀 Enhanced Trading
/long BTC 100 # Long Bitcoin with $100 (Market)
/long BTC 100 45000 # Long Bitcoin with $100 at $45k (Limit)
/long BTC 100 sl:44000 # Long with automatic stop loss
/short ETH 50 # Short Ethereum with $50 (Market)
/short ETH 50 3500 # Short Ethereum with $50 at $3.5k (Limit)
/short ETH 50 sl:3600 # Short with automatic stop loss
/exit BTC # Close Bitcoin position
🛡️ Risk Management
/sl BTC 44000 # Stop loss for Bitcoin
/tp BTC 50000 # Take profit for Bitcoin
📊 Market Data
/price # Quick price check
/market # Detailed market data
/trades # Recent trade history
🆘 Need Help?
- Quick Start: See Setup Guide
- All Commands: See Commands Reference
- Code Questions: See Project Structure
- Server Setup: See Deployment Guide
Happy trading! 📱💰