๐ฅ๏ธ Commands Reference
Complete guide to all StrateQueue CLI commands, options, and usage patterns.
Core Commands
stratequeue deploy
Launch trading strategies in signals, paper, or live mode.
stratequeue deploy --strategy my_strategy.py --symbol AAPL --timeframe 1mRequired:
--strategy- Strategy file(s) to deploy
Optional:
--allocation- Position allocation (required for multi-strategy)--symbol- Trading symbol(s)--timeframe- Bar granularity (1s, 1m, 5m, 1h, 1d)--broker- Broker to use (alpaca, ccxt.binance, ibkr)--data-source- Data provider (polygon, demo, ccxt)--engine- Backtesting engine (backtesting, vectorbt, zipline)--paper- Paper trading mode--live- Live trading mode (real money)--duration- Runtime in minutes (default: 60)--lookback- Historical bars to fetch (default: 60)--daemon- Run in background daemon--verbose- Detailed logging
Examples:
# Signals only (safe)
stratequeue deploy --strategy sma.py --symbol AAPL
# Paper trading
stratequeue deploy --strategy sma.py --symbol AAPL --paper
# Multi-strategy portfolio
stratequeue deploy --strategy sma.py,momentum.py --allocation 0.6,0.4 --symbol AAPL
# Crypto trading
stratequeue deploy --strategy crypto.py --symbol ETHUSDC --broker ccxt.binance --paperstratequeue setup
Interactive setup wizard for brokers and data providers.
stratequeue setupFeatures:
- Interactive broker selection (Alpaca, CCXT, IBKR)
- Exchange selection for CCXT (250+ crypto exchanges)
- Credential validation and secure storage
- Paper/live trading mode configuration
Example Flow:
๐ง StrateQueue Setup
? What would you like to configure? Broker
? Select broker: CCXT (250+ cryptocurrency exchanges)
? Select exchange: Binance
? Enable testnet? Yes
? API Key: [hidden]
โ
Credentials savedstratequeue status
Check system health and broker connectivity.
stratequeue status [broker|provider|system]Options:
broker- Check broker connection and credentialsprovider- Check data provider statussystem- Check both brokers and providers (default)--detailed- Show detailed status information
Example Output:
๐ง StrateQueue System Status
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐ Brokers
โ
Alpaca (Paper) - Connected
โ
CCXT Binance - Connected (Testnet)
โ IBKR - Not configured
๐ Data Providers
โ
Polygon - API key valid
โ
Demo - Available
โ ๏ธ Yahoo Finance - Rate limitedstratequeue list
List available brokers, data providers, and engines.
stratequeue list [brokers|providers|engines]Options:
brokers- Show all supported brokersproviders- Show all data providersengines- Show installed backtesting engines
Example Output:
๐ Available Brokers
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Stock & ETF Trading:
โ
alpaca - Alpaca Markets (US stocks, ETFs, crypto)
โ
ibkr - Interactive Brokers (global markets)
Cryptocurrency Trading (CCXT):
โ
ccxt.binance - Binance (๐งช testnet available)
โ
ccxt.coinbase - Coinbase Pro (๐งช sandbox, ๐ passphrase)
โ
ccxt.kraken - Kraken (๐ด live only)
... and 247+ more exchangesstratequeue daemon
Start the REST API daemon server for WebUI and background operations.
stratequeue daemon [options]Options:
--port- Port to bind server (default: 8400)--host- Host to bind server (default: 0.0.0.0)--reload- Enable auto-reload for development
Examples:
# Start daemon on default port 8400
stratequeue daemon
# Custom port
stratequeue daemon --port 8500
# Development mode with auto-reload
stratequeue daemon --reloadAPI Endpoints:
GET /health- Health checkGET /status- System statusPOST /strategy/deploy- Deploy strategyPOST /strategy/pause- Pause strategyPOST /shutdown- Shutdown system
stratequeue webui
Launch the web dashboard interface.
stratequeue webui [options]Options:
--port- Web server port (default: 5173)
Features:
- Visual strategy deployment
- Real-time performance monitoring
- Portfolio management
- Trade history and logs
- System controls (pause/resume/stop)
Auto-Setup:
- Installs npm dependencies on first run
- Starts daemon automatically if not running
- Opens browser automatically
Advanced Usage
Environment Variables
StrateQueue reads configuration from environment variables in this order:
- Current shell variables
.envfile in project directory~/.stratequeue/credentials.env
Multi-Strategy Configuration
Create a strategies.txt file for complex portfolios:
# Strategy file, allocation
strategies/sma_short.py, 0.4
strategies/momentum.py, 0.3
strategies/mean_reversion.py, 0.3Deploy with:
stratequeue deploy --config strategies.txt --symbol AAPLBackground Operations
Run strategies in the background using the daemon:
# Deploy to daemon (non-blocking)
stratequeue deploy --strategy sma.py --symbol AAPL --daemon
# Check daemon status
curl http://localhost:8400/status
# Stop all strategies
curl -X POST http://localhost:8400/shutdownLogging and Debugging
Enable detailed logging for troubleshooting:
# Verbose output
stratequeue deploy --strategy sma.py --symbol AAPL --verbose
# Check logs
tail -f ~/.stratequeue/logs/stratequeue.logCommand Aliases
Many commands have shorter aliases for convenience:
| Command | Aliases |
|---|---|
stratequeue list |
stratequeue ls |
stratequeue status |
stratequeue check, stratequeue health |
stratequeue daemon |
stratequeue server, stratequeue api |
stratequeue webui |
stratequeue ui, stratequeue dashboard |
Global Options
These options work with most commands:
--help- Show command help--version- Show StrateQueue version--config- Specify config file path--verbose- Enable verbose output
Exit Codes
StrateQueue commands return standard exit codes:
0- Success1- General error2- Invalid arguments3- Configuration error4- Connection error
Use in scripts:
if stratequeue status broker; then
echo "Broker is ready"
stratequeue deploy --strategy my_strategy.py --live
else
echo "Broker setup required"
stratequeue setup broker
fiGetting Help
stratequeue --help- General helpstratequeue <command> --help- Command-specific helpstratequeue list- Show available optionsstratequeue status- Check system health
For detailed documentation, visit the full documentation.