Advanced

CLI and pane functions

Gloom from the shell: market data, local state, plugin capabilities, reports and screenshots of any function.

gloomberb alone, or gloomberb launch-ui from a script, opens the terminal UI. Every other command runs headless and prints a result.

gloomberb help <command> shows usage and examples. Plugins add commands of their own, such as ai ask from BYOK AI.

Output is readable text by default. Global flags:

Flag	Use
`--json`, `--csv`, `--ndjson`	Machine-readable output. `--json` is the richest.
`--limit n`	Show at most n rows
`--refresh`	Fetch fresh data instead of reading the cache
`--dry-run`	Preview a change without saving. Applies to `config`, `cache`, `notes`, `alerts`, `plugin enable` and `disable`, and `remote`.
`-q`, `--quiet`, `--no-color`	Less output, no colour

Company data

Command	Use
`search <query>`, `ticker <symbol>`	Find a ticker; print its full research report
`quote <symbols>`, `compare <symbols>`	Latest prices, side by side
`history <symbol> [--range 1Y]`	OHLCV. Ranges: `1D`, `1W`, `1M`, `3M`, `6M`, `1Y`, `5Y`, `ALL`
`options <symbol>`	Options chain
`financials`, `fundamentals`, `valuation`, `events`, `analyst` `<symbol>`	Revenue and EPS, profile, multiples, dividends and splits, ratings and targets
`fn DVD <symbols>`	Dividend yield and history; several symbols rank in one table by yield, with payout, growth, last ex-date and pay date
`holders`, `insider`, `13f`, `filings` `<symbol>`	Holders, insiders, institutions and funds, SEC filings
`news [symbol or text]`, `rss fetch <url>`	Headlines, or the stories that mention some text; any RSS or Atom feed
`correlation <a> <b>`	Daily-return correlation over the past year

Markets and macro

Command	Use
`movers`, `indices`, `sectors`, `fear-greed`	Market overview
`earnings <symbols>`, `fx <currency>`	Earnings dates; a currency into your base currency
`econ [--country US\|G7\|EU\|all] [--impact high\|medium\|low\|all]`	Economic calendar
`fred <series>`, `yield-curve`	FRED series (needs a Gloom Cloud sign-in), Treasury yields
`provider-search <query>`	Search instruments at your connected data providers

Portfolios and notes

Command	Use
`portfolio list\|show\|create\|delete <name>`	Manual portfolios; `show` lists value, weight, a year of dividend income and its yield, target, drift and the trade to rebalance; `show --explain` adds what those terms mean, and `show --drip [--years 1-5] [--withholding <pct>]` projects reinvested dividends
`portfolio add\|remove <portfolio> <symbols...> [--file <csv\|txt>]`	Add or remove tickers: several at once (commas, spaces or lines), a CSV or text file, or piped input (`-`); one line per symbol and a summary of what was not found
`portfolio position set <portfolio> <symbol> <shares> <avg-cost> [currency]`	Set a position
`portfolio cash set <portfolio> <amount> [currency]`, `portfolio cash clear <portfolio>`	Record or clear the cash line; it counts in the total and the weights
`portfolio target set <portfolio> <symbol\|CASH> <weight%>`, `portfolio target clear <portfolio> [symbol\|CASH]`, `portfolio target show <portfolio>`	Target weights; drift and the trade to reach them then show in `portfolio show` and `PF`
`watchlist list\|show\|create\|delete\|add\|remove`	The same verbs for watchlists, with the same multi-symbol and `--file` add; `watchlist show <name> --csv` or `--json` prints one row per ticker, market cap included
`broker list [--type ibkr]`	Connected broker accounts
`notes show\|set\|delete <symbol>`, `notes quick list`, `notes export [dir]`	Ticker and quick notes
`alerts list`, `alerts add <symbol> <above\|below\|crosses> <price>`, `alerts delete\|rearm <id>`	Price alerts

Portfolios and rebalancing walks through targets and the drift table. CASH in portfolio target is the cash line; portfolio add and position set refuse a bare CASH (the stock is CASH:NASDAQ). portfolio and watchlist write immediately and ignore --dry-run. Sign-in, account management and chat are app-only.

App and system

Command	Use
`config list\|get\|set`	Settings and key bindings, including your `timezone`
`cache status\|clear [namespace]`	Cached market data
`provider status`, `layout`, `pane list`	Data sources, saved layouts, panes and templates
`version`, `doctor`	Version and data folder; check that config, cache and plugins load
`install`, `update`, `remove`, `plugin ...`	Plugins, see Plugins
`remote ...`	Drive a running app, see Remote control

Functions: `catalog`, `fn`, `shot`

Every function can run headless.

Command	Use
`catalog [query] [--all] [--bot-safe]`	Find functions and their options
`catalog glossary [term]`, `catalog explain <term>`	What a term means, such as `stop-out`, `B/C`, `drift` or `NAV`
`fn <function> [argument] [--option value] [--explain]`	Print a function's report; `--explain` adds the meaning of the terms it shows
`shot <function> [argument] [--output file] [--width px] [--height px] [--theme id] [--no-status] [--strict]`	Save a PNG of the function as it looks on the desktop; `--strict` exits 2 when the pane has no usable data

bash

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

gloomberb catalog <function> lists a function's options. shot also takes --tab <id>. shot draws a function's options as its pane does: gloomberb shot 13F 0001067983 --compare SPY opens the fund's overlap with SPY. An option only the text report reads, such as --limit, fails shot with exit 1 and names the fn command that reads it, instead of saving the pane without it.

A command exits 0 when it worked and 1 when it failed (bad input, no data found, a failed check); gloomberb help ends with the list. shot saves its PNG, prints the Reason line and still exits 0 when the pane drew an error, was empty, was still loading or was behind an access gate, so a script cannot tell that from a good capture. shot --strict exits 2 in those cases instead, with the PNG still saved and the Reason still printed.

A function name nothing opens (fn volsurf SPY) fails with the functions closest to it by name, keyword and description, at most five, and Search the catalog: gloomberb catalog volsurf.

shot sizes the layout from 720 to 2400 wide and 360 to 1800 tall, and the PNG is drawn at twice that. A size outside the limits is clamped, and a warning says what was used.

Reports end with their source and a dated status line, such as Source: Gloom Cloud · US trading day Fri 9 Oct 2026 close · 15 min delayed · markets closed until Mon: when the data is from (UTC, or the close of a market's trading day, always with the year), how far it is held back, and when its market reopens. Screenshots draw the same line, without the source, in the pane footer, inside the requested size; --no-status leaves it out.

Times print in UTC. To see your own clock beside them, run gloomberb config set timezone Asia/Tokyo (any Region/City name; none turns it off): Sat 10 Oct 2026 16:56 UTC (Sun 11 Oct 01:56 Asia/Tokyo). A trading day keeps its market's date in every zone, and --json and --csv keep the raw values.

Plugin capabilities