CLI Reference

Interactive menu-driven command-line interface for managing Artic trading agents.

Session-based

The CLI saves your JWT token to ~/.artic/token. Subsequent launches skip login until the token expires.

Setup

cd clients/cli
pip install -r requirements.txt
python -m cli

Authentication

On first launch:

OptionAction
1 — LoginAuthenticate with email + password
2 — RegisterCreate account and auto-login
0 — ExitQuit

Tokens persist in ~/.artic/token. Option 0 clears the saved token.


Main Menu

#CommandDescription
1List agentsTable of all agents — name, symbol, status, LLM, ID
2Create agentInteractive creation wizard (see fields below)
3Start agentPick a stopped agent and restart it
4Stop agentPick a running agent and halt it
5Agent statusFull status dump for selected agent
6Agent logsFetch recent log lines (configurable limit)
7Delete agentSelect agent, confirm, delete
8Edit agentModify agent config fields (see below)
9Kill allStop every running agent (requires confirmation)
10LeaderboardGlobal agent rankings with sort and filter
0ExitLogout and quit

Create Agent Fields

The wizard prompts for each field sequentially. Press Enter to accept defaults.

FieldDefaultNotes
Symbolrequirede.g. BTCUSDT
Name{SYMBOL} AgentDisplay name
Amount USDT100Trading capital
Leverage51–125
Risk profilemoderate1=aggressive, 2=moderate, 3=conservative
Timeframe15m1=1m, 2=5m, 3=15m, 4=30m, 5=1h, 6=4h, 7=1d
Take profit %skipPercentage number
Stop loss %skipPercentage number
Live modenoy/n — paper trading by default
LLM providerskip1=openai, 2=anthropic, 3=deepseek, 4=gemini
LLM API keyHidden input, only prompted if provider selected
Auto-startyesy/n — launch immediately after creation

Edit Agent Fields

Select an agent, then modify any field. Press Enter to skip a field.

FieldNotes
NameNew display name
Amount USDTTrading capital
Leverage1–125
Risk profile1=aggressive, 2=moderate, 3=conservative
TP %Converted to decimal internally
SL %Converted to decimal internally
LLM provider1=openai, 2=anthropic, 3=deepseek, 4=gemini

Leaderboard

ParameterDefaultOptions
Limit10Any number
Sort bytotal_pnltotal_pnl, win_rate, sharpe, trade_count
Symbol filterskipAny symbol (e.g. BTCUSDT) or skip

Columns: Rank, Agent, Symbol, Owner, Trades, PnL, Win%, Sharpe, Status.