gloomberb 0.16.2 → 0.16.4

package/src/cli/pane-functions/function-help.ts

@@ -21,6 +21,9 @@ export interface FunctionHelpKey {
   label: string;
 }
 
+/** A function Free cannot fully open: Pro only, or a limited preview on Free. */
+export type FunctionAccess = "pro" | "preview";
+
 /** How fresh the function's data is on each plan, in the words a pane footer uses. */
 export interface FunctionFreshness {
   free: string;
@@ -36,14 +39,21 @@ export interface FunctionHelp {
   keys: readonly FunctionHelpKey[];
   /** Null when the function shows no market data (settings, your own notes). */
   data: FunctionFreshness | null;
+  /**
+   * What Free gets: `pro` when only Pro opens it, `preview` when Free sees a
+   * limited preview of the same data. Absent when Free gets the whole
+   * function, even where Pro makes it fresher.
+   */
+  access?: FunctionAccess;
   /** The Bloomberg mnemonics it stands in for; empty when Bloomberg has none. */
   bloomberg: readonly string[];
-  /** The docs entry when it is filed under another mnemonic (BTST under BT). */
+  /** The docs entry when it is filed under another mnemonic (BTST under BT), or the full URL of a page of its own. */
   docs?: string;
 }
 
-/** The docs page's anchor for a mnemonic, as the page builds heading ids. */
+/** The docs page's anchor for a mnemonic, as the page builds heading ids, or a full docs URL as is. */
 export function functionDocsUrl(code: string): string {
+  if (code.startsWith("https://")) return code;
   const anchor = code.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
   return anchor ? `${FUNCTION_DOCS_URL}#${anchor}` : FUNCTION_DOCS_URL;
 }
@@ -81,6 +91,8 @@ const SEARCH = key("/", "search");
 const OPEN_SOURCE = key("o", "pen source");
 const POP_OUT = key("p", "op out");
 const STEP = key("←/→", " step");
+/** THEM and MEMB members: open them in RRG, CORR, SIW or RIPL, or save them as a watchlist. */
+const MEMBERS_MENU = key(".", " open members in, save as watchlist");
 const CHART_KEYS = [key("s", "eries"), key("i", "ndicators"), key("t", "imeframe"), key("f", "ormulas")];
 
 export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
@@ -220,8 +232,9 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: ["EQS"],
   },
   OMON: {
-    summary: "Calls and puts by expiry with bid, ask, volume, open interest, implied volatility and Greeks.",
-    usage: ["OMON NVDA"],
+    summary: "Calls and puts by expiry with bid, ask, spread, volume, open interest, implied volatility, Greeks, extrinsic per year and a put's cost as a percent of spot. "
+      + "The Strikes filter lists every strike, a count either side of the money, or a delta band such as .70 to .90 for deep in-the-money LEAPS.",
+    usage: ["OMON NVDA", "gloomberb fn OMON NVDA --expiration 2028-01-21"],
     keys: [key("c", "alc"), key("a", "dd to OSA"), key("s", "urface")],
     data: OPTIONS,
     bloomberg: ["OMON"],
@@ -249,21 +262,23 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: ["OVME", "OVML"],
   },
   OSA: {
-    summary: "Build a multi-leg options position and value it at any spot, date and vol shift: payoff, P&L grid, breakevens and Greeks. European pricing, so no early exercise.",
-    usage: ["OSA AAPL"],
+    summary: "Build a multi-leg options position and value it at any spot, date and vol shift: payoff, P&L grid, breakevens and Greeks. European pricing, so no early exercise. "
+      + "With a NAV and a budget in bps it sizes the position as a hedge: contracts, premium, notional protected and coverage of an equity sleeve.",
+    usage: ["OSA AAPL", "gloomberb fn OSA AAPL --strategy vertical --expiration 2027-01-15",
+      "gloomberb fn OSA SPY --strategy put --strike 700 --expiration 2027-01-15 --nav 100m --budget-bps 50 --sleeve 100m"],
     keys: [key("a", "dd leg"), key("c", "hain"), key("d", "ate"), key("v", "ol shift")],
     data: OPTIONS,
     bloomberg: ["OSA"],
   },
   OVDV: {
     summary: "The implied volatility surface fitted from option quotes: 3D sheet, table, smiles, ATM term structure, 25-delta skew and forwards, live or on stored daily closes.",
-    usage: ["OVDV NVDA"],
+    usage: ["OVDV NVDA", "gloomberb fn OVDV NVDA --tab skew --expiration 2027-01-15"],
     keys: [key("v", "iew"), key("c", "hain"), key("m", "ore expiries"), key("t", " stored dates")],
     data: { free: `${DELAYED}; stored dates at the close`, pro: "Real-time; stored dates at the close" },
     bloomberg: ["OVDV"],
   },
   HIVG: {
-    summary: "Daily 30- and 90-day at-the-money implied vol since February 2024 against realized vol, with each measure's 52-week rank and percentile.",
+    summary: "Daily 30-day, 90-day and one-year at-the-money implied vol since February 2024 against realized vol, with each measure's 52-week rank and percentile.",
     usage: ["HIVG AAPL"],
     keys: [key("s", "urface")],
     data: IV_DAILY,
@@ -320,7 +335,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: [],
   },
   VCA: {
-    summary: "IV rank, term slope, skew and IV against realized vol for up to 60 US tickers, flagged rich or cheap against each name's own year. Alone it screens index and sector ETFs.",
+    summary: "IV rank, one-year IV and its percentile, term slope, skew and IV against realized vol for up to 60 US tickers, flagged rich or cheap against each name's own year. Alone it screens index and sector ETFs.",
     usage: ["VCA", "VCA NVDA, AAPL, TSLA"],
     keys: [OPEN],
     data: IV_DAILY,
@@ -384,7 +399,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: ["DVD"],
   },
   SI: {
-    summary: "FINRA short interest settlements with shares short, days to cover and average daily volume over time.",
+    summary: "FINRA short interest settlements with shares short, days to cover and average daily volume over time. Daily volume is the other tab.",
     usage: ["SI AAPL"],
     keys: [key("v", "iew"), STEP],
     data: same("Twice a month, as FINRA publishes"),
@@ -398,9 +413,9 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: [],
   },
   SIV: {
-    summary: "FINRA daily off-exchange short volume as a share of volume, against its one-year range. Not short interest; SI has that.",
+    summary: "The short interest pane on Daily volume: FINRA off-exchange short volume as a share of volume, against its one-year range.",
     usage: ["SIV TSLA"],
-    keys: [STEP, OPEN_SOURCE],
+    keys: [key("v", "iew"), STEP, OPEN_SOURCE],
     data: same("Daily, the evening after each session"),
     bloomberg: [],
   },
@@ -409,6 +424,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["DIAG NVDA"],
     keys: [OPEN_SOURCE],
     data: { free: "A preview of the latest report, verified email", pro: "The full report, rerun on demand" },
+    access: "preview",
     bloomberg: [],
   },
   RISK: {
@@ -416,6 +432,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["RISK TSLA"],
     keys: [key("y", "ear"), key("o", "pen filing")],
     data: pro(AS_FILED.pro),
+    access: "pro",
     bloomberg: [],
   },
   EXEC: {
@@ -423,6 +440,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["EXEC NVDA"],
     keys: [key("y", "ear"), key("o", "pen filing")],
     data: pro(AS_FILED.pro),
+    access: "pro",
     bloomberg: ["MGMT"],
   },
   EK: {
@@ -430,6 +448,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["EK NVDA"],
     keys: [key("o", "pen filing")],
     data: pro(AS_FILED.pro),
+    access: "pro",
     bloomberg: ["CF"],
   },
   CALLS: {
@@ -437,6 +456,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["CALLS", "CALLS NVDA"],
     keys: [OPEN, key("/", "find"), OPEN_SOURCE],
     data: pro("Within hours of the call"),
+    access: "pro",
     bloomberg: ["EVT"],
   },
   JOBS: {
@@ -444,6 +464,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["JOBS", "JOBS NVDA"],
     keys: [key("1-4", " section"), key("o", "pen role"), key("c", "areers site")],
     data: pro("Daily"),
+    access: "pro",
     bloomberg: [],
   },
   SRCH: {
@@ -451,6 +472,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["SRCH data center capex"],
     keys: [SEARCH, key("Ctrl+S", " save search"), key("a", "lerts")],
     data: pro("As calls, stories and filings arrive"),
+    access: "pro",
     bloomberg: ["NSE"],
   },
   COVN: {
@@ -458,6 +480,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["COVN FICO"],
     keys: [TABS, OPEN, OPEN_SOURCE, key("f", "a"), key("m", "aturities")],
     data: { free: "As filed; three supported rows per section", pro: "As filed; all covenants, evidence and revisions" },
+    access: "preview",
     bloomberg: ["CAST"],
   },
   CRDOC: {
@@ -465,6 +488,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["CRDOC FICO", "COVN AAPL"],
     keys: [TABS, OPEN, OPEN_SOURCE, key("d", "es"), key("f", "a"), key("m", "aturities"), key("c", "ds")],
     data: { free: "As filed; three rows per section with supporting evidence", pro: "As filed; all stored terms, revisions and risk screens" },
+    access: "preview",
     bloomberg: ["CAST", "DDIS"],
   },
   ATTN: {
@@ -472,6 +496,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["ATTN", "ATTN 6758:JPX"],
     keys: [OPEN, key("e", "vidence"), key("d", "es"), key("g", "raph"), key("n", "ews")],
     data: { free: "Three published rows per section and the latest history point", pro: "All published rows and hourly history; minimum one-hour publication lag" },
+    access: "preview",
     bloomberg: [],
   },
   HIRE: {
@@ -479,6 +504,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["HIRE", "HIRE NET", "HIRE 0700:HKEX"],
     keys: [TABS, OPEN, key("e", "vidence"), key("o", "pen source"), key("d", "es"), key("g", "raph")],
     data: { free: "Latest values and three rows per section", pro: "Weekly history, all stored observations and evidence" },
+    access: "preview",
     bloomberg: [],
   },
   APPS: {
@@ -486,6 +512,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["APPS", "APPS META", "APPS 0700:HKEX"],
     keys: [TABS, OPEN, key("e", "vidence"), key("o", "pen source"), key("d", "es"), key("g", "raph")],
     data: { free: "Latest values and three rows per section", pro: "Daily observations, full history, countries and evidence" },
+    access: "preview",
     bloomberg: [],
   },
   CATL: {
@@ -493,6 +520,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["CATL", "CATL PFE", "CATL NOVN:SIX"],
     keys: [TABS, OPEN, OPEN_SOURCE, key("a", "lert"), key("d", "es")],
     data: { free: "Three events with primary-source evidence", pro: "All stored events, revision history and local alerts" },
+    access: "preview",
     bloomberg: [],
   },
   LITI: {
@@ -500,6 +528,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["LITI AAPL", "LITI MSFT"],
     keys: [TABS, OPEN, OPEN_SOURCE, key("t", "o calendar")],
     data: { free: "Three company events with evidence", pro: "All stored company dockets and history" },
+    access: "preview",
     bloomberg: ["LITI"],
   },
   KPIS: {
@@ -507,6 +536,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["KPIS CRM", "KPIS 005930:KRX"],
     keys: [TABS, OPEN, key("e", "vidence"), OPEN_SOURCE],
     data: { free: "Pro dataset; fixed latest preview with evidence", pro: "As disclosed; all stored observations and history" },
+    access: "preview",
     bloomberg: [],
   },
   GUIDE: {
@@ -514,6 +544,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["GUIDE DAL", "GUIDE CRM"],
     keys: [TABS, OPEN, key("e", "vidence"), OPEN_SOURCE],
     data: { free: "Pro dataset; fixed latest preview with evidence", pro: "As issued; full guidance history and actual matches" },
+    access: "preview",
     bloomberg: [],
   },
   EXPO: {
@@ -521,6 +552,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["EXPO AAPL=60% NVDA=40%", "EXPO PORT:portfolio-id", "EXPO WATCH:watchlist-id"],
     keys: [TABS, OPEN, key("s", "cenario and holdings"), key("e", "vidence"), key("a", "ll company disclosures"), key("v", "isibility"), key("o", "pen source")],
     data: { free: "One holding and one-hop evidence preview", pro: "Full holdings and up to four-hop paths, as filed" },
+    access: "preview",
     bloomberg: ["PORT", "SPLC"],
   },
   SPLC: {
@@ -528,6 +560,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["SPLC NVDA", "SUPPLY AAPL", "SPLC 005930.KS", "SPLC 8035.T"],
     keys: [OPEN, key("e", "vidence"), key("d", "es"), key("g", "raph")],
     data: { free: "Three relationships per role with evidence and a one-hop graph preview", pro: "Full evidence tiers, one-to-four-hop graphs and ranked paths" },
+    access: "preview",
     bloomberg: ["SPLC"],
   },
   AWARDS: {
@@ -535,6 +568,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["AWARDS", "AWARDS LMT", "AWARDS BA.:LSE"],
     keys: [TABS, OPEN, SEARCH, key("e", "vidence"), key("o", "pen source"), key("d", "es"), key("f", "a"), key("g", "raph"), key("s", "plc"), key("c", "alendar")],
     data: { free: "Pro preview: three rows per section", pro: "All collected awards, history, revisions and relationships" },
+    access: "preview",
     bloomberg: [],
   },
   SEG: {
@@ -542,6 +576,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["SEG AAPL"],
     keys: [],
     data: { free: "First two lines, about five weeks after each filing", pro: "Every line, about five weeks after each filing" },
+    access: "preview",
     bloomberg: [],
   },
   TAS: {
@@ -589,7 +624,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
   ASKG: {
     summary: "Ask a question about what is on screen and watch the tools Gloom runs to answer it.",
     usage: ["ASKG why is NVDA down today"],
-    keys: [key("n", "ew conversation"), key("t", "ickers"), key("o", "pen pane")],
+    keys: [key("n", "ew conversation"), key("g", "ood answer"), key("b", "ad answer"), key("t", "ickers"), key("o", "pen pane")],
     data: null,
     bloomberg: ["ASKB"],
   },
@@ -663,14 +698,14 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
   MEMB: {
     summary: "ETF holdings with weights, shares, member returns, daily contributions and index changes. SPX and SPY use IVV holdings.",
     usage: ["MEMB", "MEMB SPY", "MEMB IWM"],
-    keys: [TABS, OPEN],
+    keys: [TABS, OPEN, MEMBERS_MENU],
     data: same("Dated fund holdings and partial delayed member returns. Nasdaq-100 is not covered."),
     bloomberg: ["MEMB", "MRR", "IMOV"],
   },
   THEM: {
     summary: "Curated thematic baskets with equal-weight returns and breadth. Open a theme to see its members, leaders and laggards. The Themes tab of BI.",
     usage: ["THEM", "THEM nuclear"],
-    keys: [TABS, OPEN, key("Esc", "back")],
+    keys: [TABS, OPEN, key("Esc", "back"), MEMBERS_MENU],
     data: same("Updated every 15 minutes"),
     bloomberg: ["IMAP", "custom baskets"],
   },
@@ -689,7 +724,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: ["IMAP"],
   },
   FXC: {
-    summary: "A cross-rate matrix for the major currencies, or for any of 45 chosen in its settings.",
+    summary: "A cross-rate matrix for the major currencies, or for any of 45 chosen in its settings or with --currencies from the command line (gloomberb fn FXC --currencies USD,ZAR,NGN).",
     usage: ["FXC"],
     keys: [],
     data: FX,
@@ -700,6 +735,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["PERP", "PERP BTC", "PERP TSLA"],
     keys: [TABS, OPEN, SEARCH, key("e", "vidence"), key("a", "lert")],
     data: { free: "A fixed preview and any one market's latest values", pro: "Every market, full rankings and stored history; source timestamps retained" },
+    access: "preview",
     bloomberg: [],
   },
   CRYP: {
@@ -749,6 +785,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["POWER", "POWER NEE"],
     keys: [SEARCH, key("o", "pen source"), key("d", "es"), key("f", "a"), key("g", "raph"), key("s", "plc"), key("c", "ompute"), key("t", "BO")],
     data: { free: "Three rows per section; limited history", pro: "Snapshots as public registers update; coverage by region" },
+    access: "preview",
     bloomberg: [],
   },
   GPU: {
@@ -756,6 +793,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["GPU", "GPU H100", "GPU B200"],
     keys: [key("t", "BO")],
     data: same("Hourly asks and AWS spot; other published prices every 6 or 24 hours"),
+    access: "preview",
     bloomberg: [],
   },
   NGS: {
@@ -792,6 +830,7 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     usage: ["FLOW"],
     keys: [OPEN],
     data: pro(REAL_TIME),
+    access: "pro",
     bloomberg: ["FLOW"],
   },
   HALT: {
@@ -874,8 +913,8 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: ["CRD"],
   },
   AUCT: {
-    summary: "Bill, note, bond and TIPS auction results: high rate, bid-to-cover, indirect share and size, with the auctions announced next.",
-    usage: ["AUCT", "AUCT 10-year"],
+    summary: "Bill, note, bond and TIPS auction results: high rate, stop-out versus average, bid-to-cover, indirect, direct and dealer takedown and size, with the auctions announced next. Searchable by benchmark (10Y) or CUSIP; history reaches back 10 years.",
+    usage: ["AUCT", "AUCT 10Y", "AUCT 91282CRF0"],
     keys: [SEARCH, key("f", "ilter"), OPEN],
     data: same("Daily, after each auction"),
     bloomberg: ["AUCT"],
@@ -895,16 +934,16 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: ["CDS"],
   },
   CDX: {
-    summary: "CDX IG, HY and EM with iTraxx Main and Crossover on the run: the 5Y level, 1D and 1W moves, 1Y percentile and the day's print count. IG and iTraxx in spread, HY and EM in price.",
+    summary: "CDX IG, HY and EM with iTraxx Main and Crossover on the run: the 5Y level, 1D and 1W moves, 1Y percentile and the day's print count. IG and iTraxx in spread, HY and EM in price. Sovereign CDS is the other tab.",
     usage: ["CDX"],
-    keys: [OPEN],
+    keys: [TABS, OPEN],
     data: same("Delayed, as trades are disseminated"),
     bloomberg: ["CDX"],
   },
   SOVR: {
-    summary: "Sovereign 5Y CDS ranked by the month's move, beside the local currency's move against the dollar, with each country's year of history.",
+    summary: "The CDS pane on Sovereign: 5Y CDS ranked by the month's move, beside the local currency's move against the dollar, with each country's year of history.",
     usage: ["SOVR"],
-    keys: [OPEN],
+    keys: [TABS, OPEN],
     data: same("Delayed, as trades are disseminated"),
     bloomberg: ["SOVR", "WCDS"],
   },
@@ -1125,6 +1164,14 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     data: null,
     bloomberg: [],
   },
+  MCP: {
+    summary: "Connects Claude Code, Codex, Cursor or any MCP client to Gloom's research tools: the command to copy, or a key to create.",
+    usage: ["MCP"],
+    keys: [key("c", "opy"), key("←/→", " client"), key("k", "ey")],
+    data: null,
+    bloomberg: [],
+    docs: "https://gloom.sh/docs/mcp",
+  },
   BR: {
     summary: "Broker profiles, account sync and connection status. Every broker is a plugin you install first.",
     usage: ["BR"],
@@ -1177,9 +1224,9 @@ export const FUNCTION_HELP: Readonly<Record<string, FunctionHelp>> = {
     bloomberg: [],
   },
   PL: {
-    summary: "The plugin directory: install from GitHub, and enable or disable the plugins you have.",
+    summary: "What Gloomberb is made of: switch built-ins on and off, one by one or with a starter pack, and install plugins from GitHub.",
     usage: ["PL"],
-    keys: [key("i", "nstall"), key("e", "nable"), key("s", "etup"), SEARCH],
+    keys: [key("e", "nable"), key("a", " packs"), key("i", "nstall"), SEARCH],
     data: null,
     bloomberg: [],
   },