Skip to main content

Console Commands Reference

The SuiSwarm Control Terminal provides a powerful command-line interface for managing your trading bots. This guide covers all available commands and their usage.

Command Structure​

All commands follow a simple structure:

command [strategy] [parameters]

Core Commands​

start​

Launches a new trading bot with specified parameters.

Syntax:

start [strategy] [baseToken] [targetToken] [amount] [interval] [takeProfit]

Examples:

# Start a timed buy bot
start timedBuy SUI PUMPKIN 50 30 25

# Start a TWAP bot
start twap USDC SUI 1000 60 20

# Start a martingale bot
start martingale SUI DEEP 100 2 5 30

# Start a grid trading bot
start grid SUI USDC 500 0.8 1.2 10

stop​

Stops a running bot immediately.

Syntax:

stop [strategy] [baseToken] [targetToken]

Examples:

# Stop specific bot
stop timedBuy SUI PUMPKIN

# Stop all bots (coming soon)
stop all

status​

Shows current status of bots.

Syntax:

status [strategy]

Examples:

# Check all bots
status

# Check specific strategy
status timedBuy

# Check specific bot
status timedBuy SUI PUMPKIN

list​

Lists all active and paused bots.

Syntax:

list [filter]

Examples:

# List all bots
list

# List active bots only
list active

# List by strategy
list timedBuy

Strategy-Specific Commands​

Timed Buy Commands​

start timedBuy

start timedBuy [base] [target] [amount] [interval] [takeProfit]

Parameters:
- base: Base token symbol (SUI, USDC, etc.)
- target: Target token symbol
- amount: Amount per buy
- interval: Minutes between buys
- takeProfit: Profit percentage to sell

Example:
start timedBuy SUI PUMPKIN 25 30 35

adjust timedBuy

adjust timedBuy [base] [target] [parameter] [newValue]

Examples:
# Change buy amount
adjust timedBuy SUI PUMPKIN amount 50

# Change interval
adjust timedBuy SUI PUMPKIN interval 60

# Change take profit
adjust timedBuy SUI PUMPKIN takeProfit 50

TWAP Commands​

start twap

start twap [base] [target] [totalAmount] [duration] [intervals]

Parameters:
- totalAmount: Total order size
- duration: Total time in minutes
- intervals: Number of sub-orders

Example:
start twap USDC SUI 5000 120 24

twap status

twap status [base] [target]

Shows:
- Progress percentage
- Executed vs remaining
- Average price
- Time remaining

Martingale Commands​

start martingale

start martingale [base] [target] [initial] [multiplier] [levels] [takeProfit]

Parameters:
- initial: Initial position size
- multiplier: Size multiplier per level
- levels: Maximum martingale levels
- takeProfit: Target profit percentage

Example:
start martingale SUI DEEP 50 2 5 20

martingale reset

martingale reset [base] [target]

Resets martingale levels to initial position

Grid Trading Commands​

start grid

start grid [base] [target] [investment] [lower] [upper] [grids]

Parameters:
- investment: Total investment amount
- lower: Lower price bound
- upper: Upper price bound
- grids: Number of grid levels

Example:
start grid SUI USDC 1000 0.5 1.5 20

grid adjust

grid adjust [base] [target] bounds [lower] [upper]

Adjusts grid boundaries for market changes

Utility Commands​

balance​

Check token balances.

balance [token]

Examples:
# Check all balances
balance

# Check specific token
balance SUI
balance PUMPKIN

history​

View trade history.

history [limit] [strategy]

Examples:
# Last 10 trades
history 10

# Last 50 timed buy trades
history 50 timedBuy

performance​

Show performance metrics.

performance [period] [strategy]

Examples:
# Overall performance
performance

# Last 24 hours
performance 24h

# Last 7 days, timed buy only
performance 7d timedBuy

export​

Export data for analysis.

export [type] [format]

Examples:
# Export trade history as CSV
export trades csv

# Export performance as JSON
export performance json

Advanced Commands​

Emergency Commands​

panic

panic

Immediately stops all bots and cancels pending orders

pauseall

pauseall

Pauses all active bots (can be resumed)

resumeall

resumeall

Resumes all paused bots

Configuration Commands​

config

config [setting] [value]

Examples:
# Set default slippage
config slippage 2

# Set gas price
config gas auto

# Enable notifications
config notifications on

preset

preset [save|load] [name]

Examples:
# Save current setup
preset save aggressive-dca

# Load saved preset
preset load conservative-grid

Monitoring Commands​

watch

watch [metric] [interval]

Examples:
# Watch prices every 5 seconds
watch prices 5

# Watch P&L every 10 seconds
watch pnl 10

alert

alert [condition] [value] [action]

Examples:
# Alert when PUMPKIN > $0.05
alert PUMPKIN price > 0.05 notify

# Alert when profit > 50%
alert timedBuy profit > 50 notify

Command Shortcuts​

For faster execution, use these shortcuts:

# Start shortcuts
tb = timedBuy
tw = twap
mg = martingale
gr = grid

# Action shortcuts
s = start
st = stop
ls = list
bal = balance

# Examples
s tb SUI PUMPKIN 25 30 35
st tb SUI PUMPKIN
ls active
bal

Command Combinations​

Chain commands for complex operations:

# Stop bot and check balance
stop timedBuy SUI PUMPKIN && balance

# Start multiple bots
start timedBuy SUI PUMPKIN 25 30 35 && start twap USDC SUI 1000 60 20

# Check status and export
status && export trades csv

Error Messages​

Common error messages and solutions:

"Insufficient balance"

  • Check balance with balance [token]
  • Ensure enough for gas fees

"Bot already running"

  • Use status to check active bots
  • Stop existing bot first

"Invalid parameters"

  • Check command syntax
  • Verify token symbols

"Connection error"

  • Check wallet connection
  • Refresh page if needed

Best Practices​

Command Usage​

  1. Always verify parameters before executing
  2. Start small with test amounts
  3. Use status frequently to monitor
  4. Document your successful strategies

Safety Tips​

  1. Test commands with small amounts first
  2. Keep logs of all commands
  3. Use presets for complex setups
  4. Set alerts for important conditions

Performance Tips​

  1. Batch operations when possible
  2. Use shortcuts for speed
  3. Monitor resources with watch
  4. Export data for analysis

Conservative DCA Setup​

start timedBuy USDC SUI 50 240 15
alert timedBuy profit > 15 notify
watch pnl 60

Aggressive Grid Trading​

start grid SUI USDC 2000 0.7 1.3 30
config slippage 3
watch prices 10

Multi-Strategy Portfolio​

start timedBuy SUI PUMPKIN 20 60 40
start twap USDC DEEP 1000 180 36
start grid SUI USDC 500 0.8 1.2 15
performance 24h

Troubleshooting​

Command Not Working?​

  1. Check syntax carefully
  2. Verify wallet connection
  3. Ensure sufficient balance
  4. Review error messages

Need Help?​

  • Type help [command] for syntax
  • Check logs for detailed errors
  • Visit Discord for support

Pro Tip: Save your favorite command sequences as presets for quick execution!