Skip to main content

CLI Reference Overview

Every TraderBro command follows the same structure:

traderbro <command-group> <subcommand> [arguments] [flags]

Command groups

GroupDescription
analystList analysts, get profiles, view predictions, sector edge, sector map
predictionList and get individual analyst predictions
symbolSearch symbols, list mentions and predictions per symbol
contentQuery monitored tweets, videos, and articles
researchPublished research articles
sectorsList available sectors and industries
configureSave server URL and API key to config file
whoamiVerify authentication and show account info
describeOutput a machine-readable schema of all commands

Global flags

These flags apply to every command.

FlagTypeDefaultDescription
--jsonboolfalseOutput as JSON
--plainboolfalseTab-delimited output (no colors, no borders)
--jq <expr>stringApply jq expression to JSON output (implies --json)
--limit <n>int25Items per page (max 100)
--page <n>int1Page number
--no-colorboolfalseDisable colored output
--no-inputboolfalseDisable interactive prompts
-q, --quietboolfalseSuppress non-essential stderr
-v, --verboseboolfalseShow debug info on stderr
--server <url>stringfrom configOverride server URL
--key <key>stringfrom configOverride API key

Exit codes

CodeMeaning
0Success
2Authentication failure
3Not found
4Validation error (bad flag value)
5Network error

Output modes

Table mode (default): human-readable bordered table with color.

JSON mode (--json): full API response as formatted JSON. Always use this for scripts and AI agents.

Plain mode (--plain): tab-delimited, no colors or borders. Use for shell pipelines where JSON is too heavy.

jq mode (--jq '<expr>'): applies a jq expression to the JSON output inline. Implies --json.

# Get just the slugs of the top 10 analysts
traderbro analyst list --limit 10 --jq '.results[].slug'