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:
| Option | Action |
|---|---|
| 1 — Login | Authenticate with email + password |
| 2 — Register | Create account and auto-login |
| 0 — Exit | Quit |
Tokens persist in ~/.artic/token. Option 0 clears the saved token.
Main Menu
| # | Command | Description |
|---|---|---|
| 1 | List agents | Table of all agents — name, symbol, status, LLM, ID |
| 2 | Create agent | Interactive creation wizard (see fields below) |
| 3 | Start agent | Pick a stopped agent and restart it |
| 4 | Stop agent | Pick a running agent and halt it |
| 5 | Agent status | Full status dump for selected agent |
| 6 | Agent logs | Fetch recent log lines (configurable limit) |
| 7 | Delete agent | Select agent, confirm, delete |
| 8 | Edit agent | Modify agent config fields (see below) |
| 9 | Kill all | Stop every running agent (requires confirmation) |
| 10 | Leaderboard | Global agent rankings with sort and filter |
| 0 | Exit | Logout and quit |
Create Agent Fields
The wizard prompts for each field sequentially. Press Enter to accept defaults.
| Field | Default | Notes |
|---|---|---|
| Symbol | required | e.g. BTCUSDT |
| Name | {SYMBOL} Agent | Display name |
| Amount USDT | 100 | Trading capital |
| Leverage | 5 | 1–125 |
| Risk profile | moderate | 1=aggressive, 2=moderate, 3=conservative |
| Timeframe | 15m | 1=1m, 2=5m, 3=15m, 4=30m, 5=1h, 6=4h, 7=1d |
| Take profit % | skip | Percentage number |
| Stop loss % | skip | Percentage number |
| Live mode | no | y/n — paper trading by default |
| LLM provider | skip | 1=openai, 2=anthropic, 3=deepseek, 4=gemini |
| LLM API key | — | Hidden input, only prompted if provider selected |
| Auto-start | yes | y/n — launch immediately after creation |
Edit Agent Fields
Select an agent, then modify any field. Press Enter to skip a field.
| Field | Notes |
|---|---|
| Name | New display name |
| Amount USDT | Trading capital |
| Leverage | 1–125 |
| Risk profile | 1=aggressive, 2=moderate, 3=conservative |
| TP % | Converted to decimal internally |
| SL % | Converted to decimal internally |
| LLM provider | 1=openai, 2=anthropic, 3=deepseek, 4=gemini |
Leaderboard
| Parameter | Default | Options |
|---|---|---|
| Limit | 10 | Any number |
| Sort by | total_pnl | total_pnl, win_rate, sharpe, trade_count |
| Symbol filter | skip | Any symbol (e.g. BTCUSDT) or skip |
Columns: Rank, Agent, Symbol, Owner, Trades, PnL, Win%, Sharpe, Status.
