Updated September 27, 2026

CLI and pane functions

Gloomberb from the shell: structured market data, local state, capabilities, reports, screenshots, and pane functions.

Core CLI

gloomberb alone, or gloomberb launch-ui from a script, opens the TUI. Other commands run headless unless noted. gloomberb help lists every command, plugin ones included.

Output is human-readable by default. --json gives the richest model plus display-column metadata; --csv and --ndjson give the tabular rows.

Common global flags:

Flag	Use
`--json` / `--csv` / `--ndjson`	Select structured output format.
`--limit n`	Limit returned array rows or tabular projections.
`--refresh`	Prefer fresh provider data where supported.
`--quiet`	Suppress human-readable output.
`--no-color`	Disable terminal color.
`--dry-run`	Preview a local change without saving it, where supported.

Command	Use
`gloomberb help [command]`	Every command, grouped, or one command's usage, options, and examples.
`gloomberb version`	Print version, runtime, and data folder.
`gloomberb doctor`	Check that config, cache, plugins, and capabilities load.
`gloomberb search <query>`	Search tickers and company names.
`gloomberb ticker <symbol>`	Print quote, ownership, news, filings, and financial details.

Drive a running desktop or TUI with gloomberb remote: Remote control.

Install, update, link, and check plugins: Plugins.

Capability API

For the plugin capability graph directly, without a first-class command.

Command	Use
`gloomberb api list [--kind kind]`	List enabled plugin capabilities and operations.
`gloomberb api get <capability-id>`	Inspect one capability manifest.
`gloomberb api invoke <capability.operation> [json-payload]`	Invoke a capability operation.
`gloomberb api subscribe <capability.operation> [json-payload] [--limit n]`	Subscribe to a capability stream until the limit is reached.

Examples:

bash

gloomberb api list --json
gloomberb api invoke asset-data.gloomberb-cloud.getQuote '{"ticker":"AAPL","exchange":"NASDAQ"}' --json

Market data CLI

Shared data code, no panes. Each runs as gloomberb <command>.

Command	Use
`quote <symbols>`, `compare <symbols>`, `history <symbol> [--range 1Y]`, `options <symbol>`	Quotes, side-by-side comparison, OHLCV history, options chain.
`financials`, `fundamentals`, `valuation`, `events`, `analyst` `<symbol>`	Annual revenue, profit, and EPS; fundamentals and profile; valuation multiples; dividends, splits, and earnings events; analyst ratings and targets.
`holders`, `insider`, `13f`, `filings` `<symbol>`	All holders, insiders, institutions and funds, SEC filings.
`news [symbol]`, `rss fetch <url>`	Market or ticker headlines; any RSS or Atom feed.
`movers [gainers\|losers\|active\|trending]`, `indices`, `sectors`, `earnings <symbols>`, `fx <currency>`, `fear-greed`	Market overview. `fx` converts into your base currency.
`econ [--country US\|G7\|EU\|all] [--impact high\|medium\|low\|all]`, `fred <series-id>`, `yield-curve`	Economic calendar, FRED series (needs a Gloom Cloud sign-in), Treasury yields.
`correlation <symbol-a> <symbol-b>` (alias `relationship`)	Correlate daily returns over the past year.
`provider-search <query>`	Search instruments at the connected data providers.

Portfolio and watchlist CLI

Command	Use
`gloomberb portfolio list\|show\|create\|delete [name]`	List, inspect, create, or delete manual portfolios.
`gloomberb portfolio add\|remove <portfolio> <ticker>`	Add or remove a ticker.
`gloomberb portfolio position set <portfolio> <ticker> <shares> <avg-cost> [currency]`	Set a manual position.
`gloomberb watchlist list\|show\|create\|delete\|add\|remove`	The same verbs for watchlists.

Local state and system CLI

Command	Use
`gloomberb notes show\|set\|delete\|quick list\|export [dir]`	Read, write, or export ticker and quick notes.
`gloomberb alerts list\|add\|delete\|rearm`	Manage price alerts.
`gloomberb config list\|get\|set`	Inspect or update editable config keys.
`gloomberb cache status\|clear`	Inspect or clear the resource cache.
`gloomberb provider status`	Inspect enabled data providers and operations.
`gloomberb plugin list\|info\|enable\|disable\|link\|doctor`	Inspect, toggle, link, and check plugins.
`gloomberb layout`	Inspect saved layouts.
`gloomberb pane list`	Inspect pane and pane-template inventory.

--dry-run previews notes, alerts, config set, cache clear, plugin enable|disable, and remote. Other commands ignore it and write immediately, portfolio and watchlist included.

Broker, AI, and cloud CLI

Command	Use
`gloomberb broker list`	List connected broker profiles.
`gloomberb ai providers`	Inspect AI providers (BYOK AI plugin).
`gloomberb ai ask [--provider id] [--model id] <prompt>`	Run a headless AI prompt.
`gloomberb predictions [venue] [category] [browse-tab] [search...]`	Opens the UI on Prediction Markets. Aliases `pm`, `prediction-markets`.

Sign-in, account management, and chat are app-only.

Pane-backed functions

Pane functions reuse app pane templates for visual reports and screenshots. For data, prefer first-class commands or gloomberb api.

Command	Use
`gloomberb catalog [query] [--limit n] [--all]`	List searchable pane-backed functions and screenshots.
`gloomberb catalog --json`	Emit command/capability-style catalog metadata for pane-backed surfaces.
`gloomberb fn <function-or-pane> [argument] [--key value]`	Run a pane-backed market function and print a report.
`gloomberb shot <function-or-pane> [argument] [--output path] [--width px] [--height px] [--key value]`	Render a desktop-style screenshot for a pane-backed function.

Examples:

bash

gloomberb catalog chart
gloomberb fn GP NVDA
gloomberb fn 13F AAPL --view=ticker-holdings --json
gloomberb shot QQ AAPL,MSFT,NVDA --output /tmp/quotes.png
gloomberb shot FA ASML --statement income --width 1400 --height 900

Screenshot state: --tab <id>, --activeTabId <id>, --state key=value, --state.<key> value.