gloomberb 0.20.7 → 0.20.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +74 -0
- package/README.md +2 -0
- package/README.zh-CN.md +2 -0
- package/package.json +6 -1
- package/src/account/auth-model.ts +22 -0
- package/src/api-client/auth.ts +7 -2
- package/src/api-client/awards.ts +5 -0
- package/src/api-client/bond-trades.ts +22 -0
- package/src/api-client/catalysts.ts +11 -1
- package/src/api-client/data.ts +30 -6
- package/src/api-client/debt-maturities.ts +7 -0
- package/src/api-client/equity-screener.ts +17 -0
- package/src/api-client/errors.ts +2 -0
- package/src/api-client/exchange-announcements.ts +14 -7
- package/src/api-client/fund-facts.ts +21 -3
- package/src/api-client/futures-curve.ts +14 -1
- package/src/api-client/geo.ts +10 -0
- package/src/api-client/hiring.ts +2 -0
- package/src/api-client/index.ts +3 -0
- package/src/api-client/insider-signals.ts +14 -0
- package/src/api-client/members.ts +30 -2
- package/src/api-client/money-markets.ts +11 -1
- package/src/api-client/paths.ts +6 -1
- package/src/api-client/perps.ts +2 -0
- package/src/api-client/request.ts +2 -1
- package/src/api-client/socket.ts +7 -0
- package/src/api-client/types/econ.ts +2 -1
- package/src/api-client/types/filings-and-calls.ts +6 -0
- package/src/api-client/types/market.ts +4 -0
- package/src/api-client/web-experiments.ts +5 -6
- package/src/app/runtime/update.ts +2 -1
- package/src/architecture/floating-promise-allowlist.json +33 -106
- package/src/capabilities/asset-data-inputs.ts +183 -0
- package/src/capabilities/factories.ts +8 -2
- package/src/cli/base-converter.ts +36 -2
- package/src/cli/commands/api.ts +2 -2
- package/src/cli/commands/command-utils.ts +18 -0
- package/src/cli/commands/hong-kong-movers.ts +50 -0
- package/src/cli/commands/market.ts +539 -130
- package/src/cli/commands/options-chain.ts +7 -1
- package/src/cli/commands/overview.ts +74 -14
- package/src/cli/commands/plugins.ts +7 -6
- package/src/cli/commands/search.ts +52 -9
- package/src/cli/commands/system.ts +15 -10
- package/src/cli/commands/ticker.ts +97 -44
- package/src/cli/content-figures.ts +45 -0
- package/src/cli/context.ts +5 -0
- package/src/cli/desktop-pane-shot-routes.ts +13 -4
- package/src/cli/desktop-pane-shot.ts +86 -12
- package/src/cli/earnings-calendar.ts +36 -5
- package/src/cli/export-source.ts +17 -3
- package/src/cli/fx-pair.ts +111 -11
- package/src/cli/glossary.ts +36 -2
- package/src/cli/help.ts +1 -1
- package/src/cli/history-export.ts +29 -11
- package/src/cli/history-rows.ts +130 -21
- package/src/cli/index.ts +8 -5
- package/src/cli/known-gaps.ts +45 -1
- package/src/cli/listing-arg.ts +366 -19
- package/src/cli/pane-functions/capabilities.ts +2 -2
- package/src/cli/pane-functions/catalog.ts +105 -9
- package/src/cli/pane-functions/discovery.ts +2 -0
- package/src/cli/pane-functions/dom.ts +46 -9
- package/src/cli/pane-functions/freshness.ts +7 -3
- package/src/cli/pane-functions/function-help.ts +9 -6
- package/src/cli/pane-functions/headless.ts +77 -6
- package/src/cli/pane-functions/index.ts +141 -23
- package/src/cli/pane-functions/options.ts +1 -3
- package/src/cli/pane-functions/plugin-code.ts +169 -0
- package/src/cli/pane-functions/report.ts +10 -0
- package/src/cli/pane-functions/resolver.ts +69 -21
- package/src/cli/pane-functions/screenshot-assessment.ts +82 -3
- package/src/cli/pane-functions/screenshot-data-evidence.ts +3 -1
- package/src/cli/pane-functions/screenshot-types.ts +6 -0
- package/src/cli/quote-answer.ts +49 -2
- package/src/cli/registry.ts +42 -4
- package/src/cli/report-tables.ts +26 -6
- package/src/cli/result.ts +13 -2
- package/src/cli/series-search.ts +17 -7
- package/src/cli/statement-filings.ts +22 -8
- package/src/cli/symbol-args.ts +9 -0
- package/src/cli/ticker-resolution.ts +3 -2
- package/src/cli/unknown-command.ts +111 -14
- package/src/components/chart/composite/format.ts +15 -1
- package/src/components/chart/composite/legend.tsx +101 -47
- package/src/components/chart/composite/panel-labels.ts +4 -4
- package/src/components/chart/composite/panel-surface.tsx +4 -6
- package/src/components/chart/composite/scene/build.ts +180 -0
- package/src/components/chart/composite/scene/cursor.ts +226 -0
- package/src/components/chart/composite/scene/domain.ts +170 -0
- package/src/components/chart/composite/scene/markers.ts +115 -0
- package/src/components/chart/composite/scene/panels.ts +85 -0
- package/src/components/chart/composite/scene/points.ts +169 -0
- package/src/components/chart/composite/scene/projection.ts +105 -0
- package/src/components/chart/composite/scene/timeline.ts +71 -0
- package/src/components/chart/composite/scene.ts +12 -1066
- package/src/components/chart/composite/types.ts +4 -2
- package/src/components/chart/curve/model.ts +2 -2
- package/src/components/chart-table/axis.ts +18 -6
- package/src/components/command-bar/layout-items/focused-pane.ts +3 -0
- package/src/components/command-bar/list/model.ts +9 -0
- package/src/components/command-bar/pane-templates/items.ts +61 -15
- package/src/components/command-bar/pane-templates/workflow.ts +16 -5
- package/src/components/command-bar/routes/root/plugin-install.ts +7 -46
- package/src/components/command-bar/routes/root/provider-search.ts +8 -5
- package/src/components/command-bar/routes/root/results.ts +6 -1
- package/src/components/command-bar/routes/root/runtime.ts +1 -0
- package/src/components/command-bar/routes/root/shortcut-feedback.ts +4 -1
- package/src/components/command-bar/routes/ticker-search/actions.ts +7 -5
- package/src/components/command-bar/routes/ticker-search/results.ts +51 -3
- package/src/components/command-bar/view-model.ts +12 -0
- package/src/components/command-bar/workflow/ops.ts +21 -4
- package/src/components/command-bar/workflow/ticker-listing-picker.ts +3 -1
- package/src/components/command-bar/workflow/tickers.ts +6 -2
- package/src/components/data-table/view.tsx +46 -1
- package/src/components/form-modal/confirm.tsx +3 -2
- package/src/components/form-modal/content.tsx +3 -2
- package/src/components/form-modal/field-row.tsx +2 -0
- package/src/components/form-modal/host.tsx +18 -3
- package/src/components/form-modal/remote-reads.test-helpers.ts +34 -0
- package/src/components/index.ts +1 -1
- package/src/components/layout/pane/title.ts +21 -5
- package/src/components/layout/shell/pane/layers.tsx +20 -14
- package/src/components/layout/shell/pane-occlusion.ts +21 -0
- package/src/components/onboarding/desks-step.tsx +7 -1
- package/src/components/onboarding/onboarding-keyboard.ts +48 -6
- package/src/components/onboarding/onboarding-wizard.tsx +47 -8
- package/src/components/onboarding/portfolio-step/positions-panel.tsx +17 -3
- package/src/components/onboarding/use-onboarding-progress.ts +57 -14
- package/src/components/onboarding/wizard-positions.ts +2 -0
- package/src/components/paged-rows.ts +11 -5
- package/src/components/ticker/list-table-view.tsx +24 -5
- package/src/components/toggle-list.tsx +44 -1
- package/src/components/ui/data-table/opentui/index.tsx +7 -6
- package/src/components/ui/data-table/opentui/model.ts +7 -3
- package/src/components/ui/data-table/types.ts +13 -2
- package/src/components/ui/fields.tsx +16 -4
- package/src/components/ui/query-bar.tsx +43 -9
- package/src/components/ui/table-layout.ts +56 -2
- package/src/core/app-services.ts +7 -2
- package/src/core/connection-health.ts +26 -0
- package/src/core/state/app/layout.ts +12 -4
- package/src/data/config/layout.ts +3 -1
- package/src/data/config/store/node.ts +4 -2
- package/src/docs/snapshot.json +756 -216
- package/src/i18n/es.ts +4 -1
- package/src/i18n/ja.ts +4 -1
- package/src/i18n/ko.ts +4 -1
- package/src/i18n/zh-cn.ts +4 -1
- package/src/i18n/zh-tw.ts +4 -1
- package/src/layout/pane-follow.ts +1 -1
- package/src/layout/pane-manager/gridlock.ts +18 -5
- package/src/layout/pane-manager/index.ts +1 -0
- package/src/layout/pane-manager/transient.ts +56 -0
- package/src/layout-marketplace/gallery.tsx +2 -1
- package/src/layout-marketplace/model.ts +4 -10
- package/src/market-data/commodity-names.ts +24 -0
- package/src/market-data/connection-follow.ts +9 -7
- package/src/market-data/coordinator/auxiliary.ts +4 -3
- package/src/market-data/coordinator/entries.ts +22 -1
- package/src/market-data/coordinator/financials.ts +2 -3
- package/src/market-data/coordinator/index.ts +67 -12
- package/src/market-data/coordinator/quotes.ts +2 -3
- package/src/market-data/fund-facts.ts +7 -1
- package/src/market-data/futures-board.ts +38 -4
- package/src/market-data/futures-contract.ts +5 -2
- package/src/market-data/fx-closes.ts +4 -1
- package/src/market-data/market/bar-period.ts +15 -0
- package/src/market-data/market/format.ts +4 -2
- package/src/market-data/market/freshness.ts +4 -0
- package/src/market-data/market/status.ts +23 -3
- package/src/market-data/options-alternatives.ts +21 -9
- package/src/market-data/published-futures-sessions.ts +9 -0
- package/src/market-data/quotes/balance-sheet-rate.ts +34 -0
- package/src/market-data/quotes/delisting.ts +26 -2
- package/src/market-data/quotes/freshness.ts +62 -0
- package/src/market-data/quotes/listing-enterprise-value.ts +250 -19
- package/src/market-data/quotes/regular-session-valuation.ts +8 -0
- package/src/market-data/realized-volatility.ts +3 -1
- package/src/market-data/request-types.ts +2 -0
- package/src/market-data/selectors.ts +1 -0
- package/src/news/aggregator.ts +3 -3
- package/src/plugins/builtin/account-management/delete-account.ts +78 -0
- package/src/plugins/builtin/account-management/pane.tsx +22 -19
- package/src/plugins/builtin/account-management/password-dialog.tsx +75 -0
- package/src/plugins/builtin/alerts/alert-log.ts +3 -2
- package/src/plugins/builtin/alerts/cli-forms.ts +1 -1
- package/src/plugins/builtin/alerts/cli.ts +72 -4
- package/src/plugins/builtin/alerts/format.ts +8 -2
- package/src/plugins/builtin/alerts/index.tsx +8 -5
- package/src/plugins/builtin/alerts/pane.tsx +5 -3
- package/src/plugins/builtin/alerts/research-builder.ts +12 -0
- package/src/plugins/builtin/analytics/index.tsx +3 -3
- package/src/plugins/builtin/analytics/risk-client.ts +14 -3
- package/src/plugins/builtin/analytics/risk-pane.tsx +3 -3
- package/src/plugins/builtin/attention/pane.tsx +1 -1
- package/src/plugins/builtin/attention/trending.tsx +1 -1
- package/src/plugins/builtin/awards/detail.tsx +4 -1
- package/src/plugins/builtin/awards/headless.ts +7 -3
- package/src/plugins/builtin/awards/model.ts +11 -0
- package/src/plugins/builtin/awards/pane.tsx +12 -5
- package/src/plugins/builtin/backtest/client.ts +7 -2
- package/src/plugins/builtin/backtest/headless.ts +2 -1
- package/src/plugins/builtin/backtest/pane.tsx +4 -2
- package/src/plugins/builtin/bond-calculator/pane.tsx +1 -1
- package/src/plugins/builtin/broker-manager/sign-in-end.ts +1 -1
- package/src/plugins/builtin/broker-trading/orders.tsx +2 -2
- package/src/plugins/builtin/buildout/company/pane.tsx +1 -1
- package/src/plugins/builtin/buildout/model/index.ts +2 -2
- package/src/plugins/builtin/catalysts/headless.ts +9 -6
- package/src/plugins/builtin/catalysts/model.ts +72 -10
- package/src/plugins/builtin/catalysts/pane.tsx +10 -7
- package/src/plugins/builtin/cds/pane.tsx +5 -3
- package/src/plugins/builtin/central-bank-rates/pane.tsx +3 -2
- package/src/plugins/builtin/chart-composer/catalog-series.ts +59 -0
- package/src/plugins/builtin/chart-composer/headless-schema.ts +2 -1
- package/src/plugins/builtin/chart-composer/headless.ts +104 -23
- package/src/plugins/builtin/chart-composer/index.tsx +6 -3
- package/src/plugins/builtin/chart-composer/legend-names.ts +19 -0
- package/src/plugins/builtin/chart-composer/pane.tsx +37 -10
- package/src/plugins/builtin/chart-composer/presets.ts +63 -6
- package/src/plugins/builtin/chart-composer/roll-events.ts +38 -0
- package/src/plugins/builtin/chart-composer/series-catalog.ts +12 -5
- package/src/plugins/builtin/chart-composer/series-expression.ts +8 -4
- package/src/plugins/builtin/chart-composer/series-listings.ts +33 -9
- package/src/plugins/builtin/chart-composer/use-series-catalog.ts +2 -2
- package/src/plugins/builtin/clinical-trials/client.ts +13 -0
- package/src/plugins/builtin/clinical-trials/index.tsx +1 -1
- package/src/plugins/builtin/clinical-trials/pane.tsx +77 -27
- package/src/plugins/builtin/clinical-trials/search.ts +117 -0
- package/src/plugins/builtin/cloud/askg/conversation-store.ts +17 -6
- package/src/plugins/builtin/cloud/askg/lock-note.ts +4 -2
- package/src/plugins/builtin/cloud/askg/manifest.ts +3 -2
- package/src/plugins/builtin/cloud/askg/pane.tsx +2 -2
- package/src/plugins/builtin/cloud/askg/sources.ts +3 -3
- package/src/plugins/builtin/cloud/one-tap/one-tap-prompt.tsx +7 -3
- package/src/plugins/builtin/cloud/team/acm-tab.tsx +1 -1
- package/src/plugins/builtin/cloud/team/pane.tsx +17 -10
- package/src/plugins/builtin/cloud/team/views.ts +15 -3
- package/src/plugins/builtin/cloud/terminal-relay/redact.ts +105 -16
- package/src/plugins/builtin/cloud/thesis/board-pane.tsx +17 -2
- package/src/plugins/builtin/cloud/thesis/module.tsx +3 -2
- package/src/plugins/builtin/cloud/thesis/store.ts +17 -3
- package/src/plugins/builtin/commodities-energy/index.tsx +35 -3
- package/src/plugins/builtin/commodity-balances/index.tsx +1 -1
- package/src/plugins/builtin/company-attention/app-rank.tsx +1 -1
- package/src/plugins/builtin/company-attention/building.tsx +1 -1
- package/src/plugins/builtin/company-attention/model.ts +2 -1
- package/src/plugins/builtin/company-attention/moves.tsx +1 -1
- package/src/plugins/builtin/company-attention/pane.tsx +1 -1
- package/src/plugins/builtin/company-attention/signals.tsx +1 -1
- package/src/plugins/builtin/company-kpis/pane.tsx +1 -1
- package/src/plugins/builtin/correlation/headless.ts +7 -5
- package/src/plugins/builtin/correlation/history.ts +17 -6
- package/src/plugins/builtin/correlation/index.tsx +1 -1
- package/src/plugins/builtin/correlation/relationship/history.ts +1 -1
- package/src/plugins/builtin/correlation/relationship/pane.tsx +1 -1
- package/src/plugins/builtin/cot/headless.ts +10 -3
- package/src/plugins/builtin/cot/pane.tsx +2 -2
- package/src/plugins/builtin/cpi/pane.tsx +1 -1
- package/src/plugins/builtin/credit-boards/model.ts +1 -1
- package/src/plugins/builtin/credit-documents/pane.tsx +1 -1
- package/src/plugins/builtin/crypto-board/defi-view.tsx +2 -2
- package/src/plugins/builtin/crypto-board/defi.ts +9 -3
- package/src/plugins/builtin/crypto-board/headless.ts +19 -10
- package/src/plugins/builtin/crypto-board/model.ts +8 -0
- package/src/plugins/builtin/crypto-board/pane.tsx +11 -5
- package/src/plugins/builtin/crypto-board/series.ts +17 -3
- package/src/plugins/builtin/crypto-board/supply.ts +26 -3
- package/src/plugins/builtin/crypto-etf-flows/headless.ts +3 -2
- package/src/plugins/builtin/crypto-etf-flows/model.ts +13 -3
- package/src/plugins/builtin/crypto-etf-flows/pane.tsx +6 -3
- package/src/plugins/builtin/custom-view/pane.tsx +5 -5
- package/src/plugins/builtin/debt-maturities/client.ts +5 -0
- package/src/plugins/builtin/debt-maturities/headless.ts +3 -1
- package/src/plugins/builtin/debt-maturities/model.ts +1 -0
- package/src/plugins/builtin/debt-maturities/pane.tsx +1 -1
- package/src/plugins/builtin/dividend-yield/pane.tsx +1 -1
- package/src/plugins/builtin/doe/model.ts +1 -1
- package/src/plugins/builtin/doe/pane.tsx +1 -1
- package/src/plugins/builtin/earnings/board.tsx +2 -2
- package/src/plugins/builtin/earnings/history.tsx +1 -1
- package/src/plugins/builtin/earnings-calls/calendar.tsx +1 -1
- package/src/plugins/builtin/earnings-calls/data.ts +2 -1
- package/src/plugins/builtin/earnings-calls/headless.ts +15 -0
- package/src/plugins/builtin/earnings-calls/model.ts +68 -8
- package/src/plugins/builtin/earnings-calls/pane.tsx +29 -8
- package/src/plugins/builtin/earnings-calls/transcript-view.tsx +32 -2
- package/src/plugins/builtin/earnings-ripple/pane.tsx +1 -1
- package/src/plugins/builtin/econ/calendar-model.ts +94 -2
- package/src/plugins/builtin/econ/detail-view.tsx +15 -11
- package/src/plugins/builtin/econ/index.tsx +25 -9
- package/src/plugins/builtin/econ/types.ts +4 -1
- package/src/plugins/builtin/equity-screener/headless.ts +23 -7
- package/src/plugins/builtin/equity-screener/index.tsx +3 -0
- package/src/plugins/builtin/equity-screener/live.ts +39 -12
- package/src/plugins/builtin/equity-screener/model.ts +86 -5
- package/src/plugins/builtin/equity-screener/pane.tsx +20 -21
- package/src/plugins/builtin/equity-screener/results.ts +12 -3
- package/src/plugins/builtin/equity-screener/ticker-check.tsx +2 -2
- package/src/plugins/builtin/estimate-revisions/pane.tsx +2 -2
- package/src/plugins/builtin/executives/pane.tsx +2 -2
- package/src/plugins/builtin/exposure/pane.tsx +1 -1
- package/src/plugins/builtin/fear-greed/data.ts +3 -1
- package/src/plugins/builtin/fear-greed/headless.ts +8 -2
- package/src/plugins/builtin/fear-greed/pane.tsx +8 -4
- package/src/plugins/builtin/filing-events/pane.tsx +1 -1
- package/src/plugins/builtin/futures/index.tsx +5 -4
- package/src/plugins/builtin/futures/model.ts +17 -9
- package/src/plugins/builtin/futures/returns.ts +2 -0
- package/src/plugins/builtin/futures/series.ts +44 -8
- package/src/plugins/builtin/futures/table.tsx +3 -3
- package/src/plugins/builtin/futures-curve/client.ts +1 -0
- package/src/plugins/builtin/futures-curve/headless.ts +14 -12
- package/src/plugins/builtin/futures-curve/index.tsx +7 -4
- package/src/plugins/builtin/futures-curve/model.ts +93 -7
- package/src/plugins/builtin/futures-curve/pane.tsx +18 -7
- package/src/plugins/builtin/fx-matrix/amount.ts +2 -1
- package/src/plugins/builtin/fx-matrix/index.tsx +9 -0
- package/src/plugins/builtin/gpu/changes.tsx +1 -1
- package/src/plugins/builtin/gpu/equities.tsx +1 -1
- package/src/plugins/builtin/gpu/pane.tsx +2 -2
- package/src/plugins/builtin/help/function-card.tsx +4 -2
- package/src/plugins/builtin/help/function-index.ts +12 -6
- package/src/plugins/builtin/help/index.tsx +1 -1
- package/src/plugins/builtin/holders/beneficial-view.tsx +1 -1
- package/src/plugins/builtin/holders/pane.tsx +1 -1
- package/src/plugins/builtin/insider/base-values.ts +55 -0
- package/src/plugins/builtin/insider/headless.ts +307 -83
- package/src/plugins/builtin/insider/index.tsx +65 -23
- package/src/plugins/builtin/insider/insiders.tsx +26 -16
- package/src/plugins/builtin/insider/model.ts +2 -2
- package/src/plugins/builtin/insider/signals-cells.tsx +4 -1
- package/src/plugins/builtin/insider/signals-model.ts +13 -5
- package/src/plugins/builtin/insider/signals.tsx +5 -3
- package/src/plugins/builtin/insider/tickers.tsx +466 -0
- package/src/plugins/builtin/ipo-calendar/pane.tsx +1 -1
- package/src/plugins/builtin/iv-history/client.ts +35 -4
- package/src/plugins/builtin/iv-history/headless.ts +10 -4
- package/src/plugins/builtin/iv-history/model.ts +85 -16
- package/src/plugins/builtin/iv-history/pane.tsx +2 -2
- package/src/plugins/builtin/iv-history/screen-pane.tsx +6 -3
- package/src/plugins/builtin/jobs/pane.tsx +5 -5
- package/src/plugins/builtin/macro-day/pane.tsx +1 -1
- package/src/plugins/builtin/macro-day/release-table.ts +5 -5
- package/src/plugins/builtin/macro-day/releases.ts +11 -9
- package/src/plugins/builtin/market-movers/headless.ts +6 -2
- package/src/plugins/builtin/market-movers/screener.ts +18 -4
- package/src/plugins/builtin/members/breadth-pane.tsx +3 -3
- package/src/plugins/builtin/members/client.ts +24 -2
- package/src/plugins/builtin/members/headless.ts +66 -9
- package/src/plugins/builtin/members/index.tsx +7 -6
- package/src/plugins/builtin/members/model.ts +89 -5
- package/src/plugins/builtin/members/pane.tsx +70 -21
- package/src/plugins/builtin/mna/distress/pane.tsx +2 -1
- package/src/plugins/builtin/mna/pane.tsx +1 -1
- package/src/plugins/builtin/money-markets/client.ts +43 -15
- package/src/plugins/builtin/money-markets/headless.ts +18 -11
- package/src/plugins/builtin/money-markets/index.tsx +7 -6
- package/src/plugins/builtin/money-markets/model.ts +20 -5
- package/src/plugins/builtin/money-markets/pane.tsx +28 -17
- package/src/plugins/builtin/news/wire/news/footer.ts +11 -1
- package/src/plugins/builtin/news/wire/news/table.tsx +15 -5
- package/src/plugins/builtin/notes/headless.ts +94 -0
- package/src/plugins/builtin/notes/index.tsx +3 -1
- package/src/plugins/builtin/notes/store.ts +10 -3
- package/src/plugins/builtin/options/footer.ts +8 -2
- package/src/plugins/builtin/options/open-interest-as-of.ts +12 -3
- package/src/plugins/builtin/options/view.tsx +10 -1
- package/src/plugins/builtin/options-calculator/pane.tsx +1 -1
- package/src/plugins/builtin/options-positioning/client.ts +35 -8
- package/src/plugins/builtin/options-positioning/headless.ts +17 -7
- package/src/plugins/builtin/options-positioning/index.tsx +10 -0
- package/src/plugins/builtin/options-positioning/pane.tsx +16 -7
- package/src/plugins/builtin/options-scenario/csp-screen-pane.tsx +1 -1
- package/src/plugins/builtin/options-scenario/pane.tsx +1 -1
- package/src/plugins/builtin/pe-band/pane.tsx +2 -2
- package/src/plugins/builtin/perps/cascade-tabs.tsx +2 -2
- package/src/plugins/builtin/perps/client.ts +54 -15
- package/src/plugins/builtin/perps/headless.ts +39 -13
- package/src/plugins/builtin/perps/index.tsx +2 -1
- package/src/plugins/builtin/perps/model.ts +43 -1
- package/src/plugins/builtin/perps/pane.tsx +35 -18
- package/src/plugins/builtin/portfolio-list/allocation-rows.ts +74 -0
- package/src/plugins/builtin/portfolio-list/cell-version.ts +1 -0
- package/src/plugins/builtin/portfolio-list/cli/period-report.ts +7 -3
- package/src/plugins/builtin/portfolio-list/cli/portfolio-command.ts +33 -3
- package/src/plugins/builtin/portfolio-list/cli/render.ts +149 -24
- package/src/plugins/builtin/portfolio-list/headless.ts +30 -9
- package/src/plugins/builtin/portfolio-list/income.ts +17 -8
- package/src/plugins/builtin/portfolio-list/index.tsx +4 -4
- package/src/plugins/builtin/portfolio-list/pane/fx-day-moves.ts +52 -0
- package/src/plugins/builtin/portfolio-list/pane/index.tsx +76 -9
- package/src/plugins/builtin/portfolio-list/pane/target-weights.tsx +178 -0
- package/src/plugins/builtin/portfolio-list/period-pnl.ts +44 -5
- package/src/plugins/builtin/portfolio-list/settings.ts +12 -6
- package/src/plugins/builtin/portfolio-list/summary/index.tsx +9 -4
- package/src/plugins/builtin/portfolio-list/summary/totals.ts +21 -2
- package/src/plugins/builtin/portfolio-list/table.tsx +33 -25
- package/src/plugins/builtin/power/gas.tsx +2 -2
- package/src/plugins/builtin/power/prices.tsx +2 -2
- package/src/plugins/builtin/primary-dealers/pane.tsx +10 -11
- package/src/plugins/builtin/rate-path/model.ts +9 -0
- package/src/plugins/builtin/rate-path/pane.tsx +6 -5
- package/src/plugins/builtin/realized-vol/fx-proxy.ts +27 -0
- package/src/plugins/builtin/realized-vol/headless.ts +8 -6
- package/src/plugins/builtin/realized-vol/pane.tsx +13 -7
- package/src/plugins/builtin/relative-rotation/pane.tsx +1 -1
- package/src/plugins/builtin/research/analyst-headless.ts +5 -1
- package/src/plugins/builtin/research/analyst-model.ts +7 -1
- package/src/plugins/builtin/research/analyst-pane.tsx +1 -1
- package/src/plugins/builtin/research/relative-valuation-basis.ts +44 -4
- package/src/plugins/builtin/research/relative-valuation-headless.ts +59 -14
- package/src/plugins/builtin/research/relative-valuation-model.ts +65 -26
- package/src/plugins/builtin/research/relative-valuation-pane.tsx +42 -17
- package/src/plugins/builtin/revenue-breakdown/pane.tsx +1 -1
- package/src/plugins/builtin/reverse-dcf/client.ts +34 -4
- package/src/plugins/builtin/reverse-dcf/headless.ts +30 -15
- package/src/plugins/builtin/reverse-dcf/model.ts +190 -29
- package/src/plugins/builtin/reverse-dcf/pane.tsx +35 -13
- package/src/plugins/builtin/risk-factors/pane.tsx +2 -2
- package/src/plugins/builtin/roadmap/pane.tsx +2 -2
- package/src/plugins/builtin/scanner/flow-pane.tsx +4 -4
- package/src/plugins/builtin/scanner/headless.ts +15 -1
- package/src/plugins/builtin/seasonality/pane.tsx +1 -1
- package/src/plugins/builtin/sec/fund-facts-view.tsx +5 -2
- package/src/plugins/builtin/sec/fund-facts.ts +41 -1
- package/src/plugins/builtin/sec/headless.ts +8 -4
- package/src/plugins/builtin/sec/index.tsx +41 -13
- package/src/plugins/builtin/shared/ticker-company.ts +111 -0
- package/src/plugins/builtin/shared/use-quote-board.ts +37 -2
- package/src/plugins/builtin/shared/volatility/live-session.ts +23 -0
- package/src/plugins/builtin/shared/volatility-indices.ts +2 -0
- package/src/plugins/builtin/short-interest/publications-pane.tsx +1 -1
- package/src/plugins/builtin/short-volume/pane.tsx +1 -1
- package/src/plugins/builtin/social-mentions/outliers.tsx +3 -3
- package/src/plugins/builtin/social-mentions/pane.tsx +2 -2
- package/src/plugins/builtin/supply-chain/graph-pane.tsx +1 -1
- package/src/plugins/builtin/supply-chain/pane.tsx +1 -1
- package/src/plugins/builtin/themes/pane.tsx +4 -4
- package/src/plugins/builtin/thirteenf/api.ts +1 -0
- package/src/plugins/builtin/thirteenf/format.ts +5 -0
- package/src/plugins/builtin/thirteenf/headless.ts +2 -2
- package/src/plugins/builtin/thirteenf/model.ts +128 -5
- package/src/plugins/builtin/thirteenf/overlap-pane.tsx +1 -1
- package/src/plugins/builtin/thirteenf/report-notes.ts +10 -3
- package/src/plugins/builtin/thirteenf/signals-pane.tsx +1 -1
- package/src/plugins/builtin/thirteenf/table.ts +2 -2
- package/src/plugins/builtin/thirteenf/types.ts +12 -0
- package/src/plugins/builtin/ticker-detail/data-panes/historical-prices.tsx +27 -14
- package/src/plugins/builtin/ticker-detail/data-panes/returns-history.ts +6 -3
- package/src/plugins/builtin/ticker-detail/data-panes/returns-model.ts +14 -0
- package/src/plugins/builtin/ticker-detail/data-panes/returns-pane.tsx +4 -1
- package/src/plugins/builtin/ticker-detail/financials/aggregation.ts +87 -19
- package/src/plugins/builtin/ticker-detail/financials/exchange-results.ts +54 -0
- package/src/plugins/builtin/ticker-detail/financials/model.ts +114 -9
- package/src/plugins/builtin/ticker-detail/financials/ratios.ts +37 -20
- package/src/plugins/builtin/ticker-detail/financials/tab.tsx +42 -19
- package/src/plugins/builtin/ticker-detail/headless-schema.ts +3 -2
- package/src/plugins/builtin/ticker-detail/headless.ts +90 -31
- package/src/plugins/builtin/ticker-detail/overview/model.ts +22 -15
- package/src/plugins/builtin/ticker-detail/overview-tab.tsx +5 -2
- package/src/plugins/builtin/ticker-detail/quote-monitor/card.tsx +12 -7
- package/src/plugins/builtin/ticker-detail/quote-monitor/index.tsx +21 -0
- package/src/plugins/builtin/trace-bonds/client.ts +107 -10
- package/src/plugins/builtin/trace-bonds/detail.tsx +1 -1
- package/src/plugins/builtin/trace-bonds/headless.ts +20 -5
- package/src/plugins/builtin/trace-bonds/pane.tsx +15 -4
- package/src/plugins/builtin/treasury-auctions/hk-view.tsx +1 -1
- package/src/plugins/builtin/treasury-auctions/pane.tsx +1 -1
- package/src/plugins/builtin/treasury-daily/pane.tsx +2 -2
- package/src/plugins/builtin/vol-surface/charts.tsx +30 -5
- package/src/plugins/builtin/vol-surface/client.ts +40 -12
- package/src/plugins/builtin/vol-surface/events.ts +213 -0
- package/src/plugins/builtin/vol-surface/headless.ts +82 -13
- package/src/plugins/builtin/vol-surface/index.tsx +5 -1
- package/src/plugins/builtin/vol-surface/model.ts +42 -6
- package/src/plugins/builtin/vol-surface/pane.tsx +95 -23
- package/src/plugins/builtin/volatility/dvol.ts +14 -2
- package/src/plugins/builtin/volatility/headless.ts +3 -2
- package/src/plugins/builtin/volatility/index.tsx +1 -1
- package/src/plugins/builtin/volatility/pane.tsx +1 -1
- package/src/plugins/builtin/volatility/series.ts +7 -3
- package/src/plugins/builtin/world-venue-map/activity-series.ts +89 -0
- package/src/plugins/builtin/world-venue-map/chokepoint-report.ts +123 -0
- package/src/plugins/builtin/world-venue-map/evidence.ts +2 -0
- package/src/plugins/builtin/world-venue-map/geo-series.ts +35 -1
- package/src/plugins/builtin/world-venue-map/headless.ts +58 -9
- package/src/plugins/builtin/world-venue-map/index.ts +6 -3
- package/src/plugins/builtin/world-venue-map/layered-pane.tsx +6 -1
- package/src/plugins/builtin/world-venue-map/pane.tsx +4 -3
- package/src/plugins/builtin/yield-curve/index.tsx +12 -10
- package/src/plugins/builtin/yield-curve/swaps.tsx +1 -1
- package/src/plugins/extracted-plugins.ts +14 -10
- package/src/plugins/installer.ts +17 -1
- package/src/plugins/marketplace/feed.ts +14 -0
- package/src/plugins/marketplace/install-offer.ts +64 -0
- package/src/plugins/registry/contributions.ts +46 -8
- package/src/plugins/registry/index.ts +5 -0
- package/src/portfolio/collection-name.ts +38 -4
- package/src/portfolio/column-values.ts +32 -4
- package/src/portfolio/period-pnl.ts +4 -2
- package/src/react/async-resource.ts +24 -8
- package/src/remote/endpoint.ts +38 -12
- package/src/remote/secrets.ts +22 -6
- package/src/remote/server.ts +20 -4
- package/src/renderers/dom/data-table/index.tsx +2 -1
- package/src/renderers/dom/data-table/row.tsx +49 -7
- package/src/renderers/dom/desktop/controls.tsx +2 -0
- package/src/renderers/dom/desktop/query-bar.tsx +57 -7
- package/src/renderers/dom/host/surface-3d.tsx +46 -5
- package/src/renderers/dom/styles.css +17 -0
- package/src/renderers/electrobun/view/backend-rpc.ts +15 -21
- package/src/renderers/electrobun/view/cli-pane-shot-entry.tsx +16 -61
- package/src/renderers/electrobun/view/cli-pane-shot-socket.ts +134 -0
- package/src/renderers/electrobun/view/host-route.ts +119 -0
- package/src/renderers/electrobun/view/rpc-timeout.ts +6 -5
- package/src/renderers/opentui/toast-host.tsx +6 -3
- package/src/renderers/opentui/ui-host.tsx +29 -5
- package/src/series/registry.ts +1 -0
- package/src/series/standalone-catalog.ts +40 -0
- package/src/series/types.ts +10 -0
- package/src/series/validate.ts +5 -0
- package/src/shares/portable-layout.ts +2 -7
- package/src/sources/gloomberb-cloud/dated-chunks.ts +133 -0
- package/src/sources/gloomberb-cloud/index.ts +46 -5
- package/src/sources/gloomberb-cloud/news.ts +15 -9
- package/src/sources/gloomberb-cloud/normalizers.ts +17 -0
- package/src/sources/history-coverage.ts +13 -0
- package/src/sources/history-result.ts +1 -0
- package/src/sources/provider-errors.ts +9 -0
- package/src/sources/provider-router/batches.ts +7 -3
- package/src/sources/provider-router/financial-routes.ts +3 -1
- package/src/sources/provider-router/history.ts +6 -4
- package/src/sources/provider-router/index.ts +5 -1
- package/src/sources/provider-router/primary.ts +4 -3
- package/src/sources/provider-router/retrieved-at.ts +12 -0
- package/src/team/store.ts +17 -4
- package/src/telemetry/crash-reports.ts +3 -1
- package/src/test-support/cli-context.ts +3 -2
- package/src/test-support/test-env.ts +7 -0
- package/src/theme/themes.ts +16 -9
- package/src/theme/tone-contrast.ts +29 -5
- package/src/tickers/company-name-listing.ts +31 -3
- package/src/tickers/company-name.ts +9 -0
- package/src/tickers/index-roots.ts +56 -4
- package/src/tickers/listing-name.ts +7 -2
- package/src/tickers/listing-venues.ts +17 -2
- package/src/tickers/search/home-listing.ts +2 -0
- package/src/tickers/search/index.ts +64 -11
- package/src/tickers/search/major-listings.json +595 -592
- package/src/tickers/search/ranking.ts +19 -1
- package/src/tickers/terminal-codes.ts +5 -3
- package/src/time-series/bar-aggregation.ts +3 -2
- package/src/time-series/base-series.ts +18 -1
- package/src/time-series/chart-data.ts +9 -6
- package/src/time-series/chart-seed.ts +11 -3
- package/src/time-series/currency-conversion.ts +1 -0
- package/src/time-series/date-window.ts +8 -0
- package/src/time-series/formula-months.ts +57 -0
- package/src/time-series/fundamentals/period-points.ts +3 -3
- package/src/time-series/fundamentals/source-statements.ts +5 -4
- package/src/time-series/leverage.ts +12 -4
- package/src/time-series/live-bars.ts +12 -7
- package/src/time-series/live-quotes.ts +6 -2
- package/src/time-series/market.ts +10 -3
- package/src/time-series/price-comparison.ts +106 -0
- package/src/time-series/range.ts +10 -0
- package/src/time-series/resolve-context.ts +7 -2
- package/src/time-series/resolve.ts +61 -5
- package/src/time-series/series-name.ts +2 -2
- package/src/time-series/series-presentation.ts +91 -2
- package/src/time-series/session-bar.ts +13 -7
- package/src/time-series/spec.ts +21 -2
- package/src/time-series/studies/formula.ts +262 -36
- package/src/time-series/studies/leverage.ts +9 -3
- package/src/time-series/studies/resolve.ts +7 -2
- package/src/time-series/types.ts +34 -0
- package/src/time-series/use-chart-resolution.ts +18 -1
- package/src/types/data-provider.ts +7 -0
- package/src/types/financials.ts +103 -1
- package/src/types/headless.ts +64 -3
- package/src/types/instrument.ts +6 -0
- package/src/types/plugin-context.ts +9 -0
- package/src/types/plugin-pane-templates.ts +6 -0
- package/src/types/plugin-panes.ts +7 -0
- package/src/types/price-history.ts +6 -0
- package/src/ui/host.tsx +3 -1
- package/src/ui/index.tsx +7 -2
- package/src/utils/cli-output.ts +21 -1
- package/src/utils/currency-units.ts +14 -0
- package/src/utils/datetime-format.ts +11 -0
- package/src/utils/exchange-announcements.ts +26 -3
- package/src/utils/exchange-notation.generated.ts +3 -4
- package/src/utils/exchange-results.ts +144 -0
- package/src/utils/exchanges.ts +10 -0
- package/src/utils/financial-statements.ts +212 -22
- package/src/utils/fire-and-forget.ts +1 -1
- package/src/utils/fiscal-period.ts +41 -3
- package/src/utils/format.ts +10 -6
- package/src/utils/fundamentals.ts +179 -12
- package/src/utils/futures-generic.ts +26 -0
- package/src/utils/lease-liabilities.ts +15 -5
- package/src/utils/lookup-token.ts +22 -0
- package/src/utils/max-drawdown.ts +25 -4
- package/src/utils/price-history-integrity.ts +56 -8
- package/src/utils/price-history.ts +6 -2
- package/src/utils/price-window.ts +38 -2
- package/src/utils/replace-file.ts +47 -0
- package/src/utils/rpc-timeout-error.ts +16 -2
- package/src/utils/untrusted-text.ts +14 -0
package/src/docs/snapshot.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"format": 1,
|
|
3
3
|
"site": "https://gloom.sh",
|
|
4
|
-
"updatedAt": "2026-11-
|
|
4
|
+
"updatedAt": "2026-11-12",
|
|
5
5
|
"categories": [
|
|
6
6
|
{
|
|
7
7
|
"id": "research",
|
|
@@ -171,7 +171,7 @@
|
|
|
171
171
|
"code": "CMP",
|
|
172
172
|
"name": "Compare performance",
|
|
173
173
|
"description": "Indexed returns for a group",
|
|
174
|
-
"detail": "Price returns rebased to a shared start date for two or more tickers, so relative performance is readable at a glance.",
|
|
174
|
+
"detail": "Price returns rebased to a shared start date for two or more tickers, so relative performance is readable at a glance. A leveraged or inverse fund also gets the k× daily line of its index fund (3× daily QQQ beside TQQQ) and its decay against it, in percentage points.",
|
|
175
175
|
"category": "research",
|
|
176
176
|
"arg": "NVDA, AMD, AVGO",
|
|
177
177
|
"shot": "https://gloom.sh/screenshots/fn/CMP.png",
|
|
@@ -797,9 +797,9 @@
|
|
|
797
797
|
},
|
|
798
798
|
{
|
|
799
799
|
"code": "PERP",
|
|
800
|
-
"name": "
|
|
801
|
-
"description": "
|
|
802
|
-
"detail": "
|
|
800
|
+
"name": "Perpetuals",
|
|
801
|
+
"description": "Perpetual funding, open interest and premium",
|
|
802
|
+
"detail": "A board and rankings of perpetuals on Hyperliquid, Binance, Bybit and OKX, one asset across the venues, and one perpetual's funding, open interest and premium history with each reading's source. Pro shows the history; Free a limited preview. Trading is in the Hyperliquid plugin.",
|
|
803
803
|
"category": "markets",
|
|
804
804
|
"arg": "BTC",
|
|
805
805
|
"access": "pro",
|
|
@@ -810,7 +810,7 @@
|
|
|
810
810
|
"code": "FUT",
|
|
811
811
|
"name": "Futures board",
|
|
812
812
|
"description": "Front-month futures",
|
|
813
|
-
"detail": "Each root's front contract until its stated roll date across equity index, rates, energy, metals, agriculture, and FX with last price, unit and session change, grouped by sector, naming the day's most active month by volume when it is another one.",
|
|
813
|
+
"detail": "Each root's front contract until its stated roll date across equity index, volatility (VIX futures, at Cboe's daily settlement), rates, energy, metals, agriculture, and FX with last price, unit and session change, grouped by sector, naming the day's most active month by volume when it is another one.",
|
|
814
814
|
"category": "markets",
|
|
815
815
|
"shot": "https://gloom.sh/screenshots/fn/FUT.png",
|
|
816
816
|
"lesson": "/academy/futures-commodities-energy/futures-from-zero"
|
|
@@ -819,7 +819,7 @@
|
|
|
819
819
|
"code": "CTM",
|
|
820
820
|
"name": "Futures curve",
|
|
821
821
|
"description": "Futures term structure",
|
|
822
|
-
"detail": "A futures root's listed contracts as a curve against a week and a month ago, with roll yield, contango or backwardation, and each contract's price, open interest, and volume. CTM VIX is the VIX futures curve from Cboe's daily settlements, with spot VIX and the front month's premium to it.",
|
|
822
|
+
"detail": "A futures root's listed contracts as a curve against a week and a month ago, with roll yield, contango or backwardation, and each contract's price, open interest, and volume. CTM VIX is the VIX futures curve from Cboe's daily settlements, with spot VIX and the front month's premium to it. Ann. roll yield is what a long position earns or pays rolling from the front contract into the next, scaled to a year: (front / next - 1) × 365 / days between the two, positive in backwardation and negative in contango. PCTL ranks a figure against its own daily values over the past year, 100 the highest and 0 the lowest: the roll yield and the front spread against theirs, and in the table each contract's price against its own.",
|
|
823
823
|
"category": "markets",
|
|
824
824
|
"arg": "GC",
|
|
825
825
|
"shot": "https://gloom.sh/screenshots/fn/CTM.png",
|
|
@@ -1773,10 +1773,11 @@
|
|
|
1773
1773
|
"category": "Start here",
|
|
1774
1774
|
"tags": [
|
|
1775
1775
|
"install",
|
|
1776
|
+
"uninstall",
|
|
1776
1777
|
"desktop",
|
|
1777
1778
|
"tui"
|
|
1778
1779
|
],
|
|
1779
|
-
"updatedAt": "2026-11-
|
|
1780
|
+
"updatedAt": "2026-11-09",
|
|
1780
1781
|
"blocks": [
|
|
1781
1782
|
{
|
|
1782
1783
|
"type": "heading",
|
|
@@ -1795,6 +1796,10 @@
|
|
|
1795
1796
|
"type": "paragraph",
|
|
1796
1797
|
"text": "Or use the [direct download](/download/desktop). The desktop app and the Homebrew cask (`brew install --cask gloom`) need Apple Silicon; on an Intel Mac use the [browser version](#browser), or look for a terminal binary in the [release assets](https://github.com/gloom-sh/gloomberb/releases/latest)."
|
|
1797
1798
|
},
|
|
1799
|
+
{
|
|
1800
|
+
"type": "paragraph",
|
|
1801
|
+
"text": "The script downloads the latest GitHub release, checks its SHA-256, and installs the app to `/Applications` and `gloom` to `~/.local/bin`, using sudo only for a folder you can't write. It prints a PATH line and edits no shell file. Source: [scripts/install.sh](https://github.com/gloom-sh/gloomberb/blob/main/scripts/install.sh) in gloom-sh/gloomberb."
|
|
1802
|
+
},
|
|
1798
1803
|
{
|
|
1799
1804
|
"type": "paragraph",
|
|
1800
1805
|
"text": "Coming from Bloomberg? [What runs on a Mac](/answers/bloomberg-terminal-on-mac)."
|
|
@@ -1806,12 +1811,16 @@
|
|
|
1806
1811
|
},
|
|
1807
1812
|
{
|
|
1808
1813
|
"type": "paragraph",
|
|
1809
|
-
"text": "Terminal UI only; Ghostty, Kitty, or WezTerm render charts best.
|
|
1814
|
+
"text": "Terminal UI only; Ghostty, Kitty, or WezTerm render charts best."
|
|
1810
1815
|
},
|
|
1811
1816
|
{
|
|
1812
1817
|
"type": "code",
|
|
1813
1818
|
"code": "curl -fsSL gloom.sh/install | bash"
|
|
1814
1819
|
},
|
|
1820
|
+
{
|
|
1821
|
+
"type": "paragraph",
|
|
1822
|
+
"text": "The script downloads the latest GitHub release, checks its SHA-256, and installs `gloom` to `~/.local/bin`, using sudo only for a folder you can't write. It prints a PATH line and edits no shell file. Source: [scripts/install.sh](https://github.com/gloom-sh/gloomberb/blob/main/scripts/install.sh) in gloom-sh/gloomberb."
|
|
1823
|
+
},
|
|
1815
1824
|
{
|
|
1816
1825
|
"type": "heading",
|
|
1817
1826
|
"level": 2,
|
|
@@ -1954,6 +1963,88 @@
|
|
|
1954
1963
|
}
|
|
1955
1964
|
]
|
|
1956
1965
|
},
|
|
1966
|
+
{
|
|
1967
|
+
"type": "heading",
|
|
1968
|
+
"level": 2,
|
|
1969
|
+
"text": "Uninstall"
|
|
1970
|
+
},
|
|
1971
|
+
{
|
|
1972
|
+
"type": "paragraph",
|
|
1973
|
+
"text": "Quit Gloom, then remove it the way you installed it:"
|
|
1974
|
+
},
|
|
1975
|
+
{
|
|
1976
|
+
"type": "list",
|
|
1977
|
+
"items": [
|
|
1978
|
+
"**Homebrew:** `brew uninstall --cask gloom` removes the app and its commands. Add `--zap` to delete your data too.",
|
|
1979
|
+
"**macOS install script:** `rm -rf /Applications/Gloom.app ~/.local/bin/gloom ~/.local/bin/gloomberb`",
|
|
1980
|
+
"**macOS disk image:** drag `Gloom.app` from Applications to the Trash.",
|
|
1981
|
+
"**Linux:** `rm ~/.local/bin/gloom ~/.local/bin/gloomberb`",
|
|
1982
|
+
"**Windows installer:** **Settings > Apps**, Gloom, **Uninstall**.",
|
|
1983
|
+
"**Windows PowerShell line:** delete `%USERPROFILE%\\.local\\bin\\gloom.exe`, then that folder's entry in your user PATH.",
|
|
1984
|
+
"**Bun:** `bun remove -g @gloom-sh/terminal`"
|
|
1985
|
+
]
|
|
1986
|
+
},
|
|
1987
|
+
{
|
|
1988
|
+
"type": "paragraph",
|
|
1989
|
+
"text": "Your data stays unless you use `--zap` or delete it yourself."
|
|
1990
|
+
},
|
|
1991
|
+
{
|
|
1992
|
+
"type": "details",
|
|
1993
|
+
"summary": "Where Gloom keeps its data, and the small print",
|
|
1994
|
+
"blocks": [
|
|
1995
|
+
{
|
|
1996
|
+
"type": "paragraph",
|
|
1997
|
+
"text": "`gloom version` prints the data folder in use."
|
|
1998
|
+
},
|
|
1999
|
+
{
|
|
2000
|
+
"type": "list",
|
|
2001
|
+
"items": [
|
|
2002
|
+
"**macOS and Windows:** `~/.gloomberb` (`%USERPROFILE%\\.gloomberb` on Windows). It holds settings, the database, plugins and logs. `config.json` there can hold broker credentials.",
|
|
2003
|
+
"**Linux:** `~/.gloomberb` if you have it. A new install without it uses `~/.config/gloomberb`, `~/.local/share/gloomberb` and `~/.cache/gloomberb`, or the folders `$XDG_CONFIG_HOME`, `$XDG_DATA_HOME` and `$XDG_CACHE_HOME` name when set.",
|
|
2004
|
+
"**`GLOOMBERB_HOME`:** if you set it, everything above lives in that folder instead."
|
|
2005
|
+
]
|
|
2006
|
+
},
|
|
2007
|
+
{
|
|
2008
|
+
"type": "paragraph",
|
|
2009
|
+
"text": "The Mac desktop app also keeps these three. With `--zap`, Homebrew deletes them and `~/.gloomberb`:"
|
|
2010
|
+
},
|
|
2011
|
+
{
|
|
2012
|
+
"type": "code",
|
|
2013
|
+
"code": "~/Library/Application Support/com.vincelwt.gloomberb\n~/Library/Preferences/com.vincelwt.gloomberb.plist\n~/Library/WebKit/com.vincelwt.gloomberb"
|
|
2014
|
+
},
|
|
2015
|
+
{
|
|
2016
|
+
"type": "paragraph",
|
|
2017
|
+
"text": "The Windows desktop app keeps this folder, if uninstalling left it:"
|
|
2018
|
+
},
|
|
2019
|
+
{
|
|
2020
|
+
"type": "code",
|
|
2021
|
+
"code": "%LOCALAPPDATA%\\com.vincelwt.gloomberb"
|
|
2022
|
+
},
|
|
2023
|
+
{
|
|
2024
|
+
"type": "paragraph",
|
|
2025
|
+
"text": "Those folders are named after the desktop app's identifier, `com.vincelwt.gloomberb`. If a newer build has moved to `sh.gloom.desktop`, delete that name too."
|
|
2026
|
+
},
|
|
2027
|
+
{
|
|
2028
|
+
"type": "paragraph",
|
|
2029
|
+
"text": "The small print:"
|
|
2030
|
+
},
|
|
2031
|
+
{
|
|
2032
|
+
"type": "list",
|
|
2033
|
+
"items": [
|
|
2034
|
+
"**Shell files:** the macOS and Linux script edits none. If you added the PATH line it printed, delete that line.",
|
|
2035
|
+
"**sudo:** use it for a folder the script needed it for.",
|
|
2036
|
+
"**Before 0.18.4:** an install from then that has not updated since has `Gloomberb.app`, not `Gloom.app`.",
|
|
2037
|
+
"**Intel Mac:** the script installs the terminal command only, so there is no app to delete.",
|
|
2038
|
+
"**Windows installer:** its entry is listed once the app has started; before that, delete the folder above. If the app folder's `bin` is still on your user PATH afterwards, remove it.",
|
|
2039
|
+
"**Windows PATH:** to edit your user PATH, search for \"Edit environment variables for your account\"."
|
|
2040
|
+
]
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"type": "paragraph",
|
|
2044
|
+
"text": "Your Gloom account and what it synced stay until you delete the account in the app's account settings."
|
|
2045
|
+
}
|
|
2046
|
+
]
|
|
2047
|
+
},
|
|
1957
2048
|
{
|
|
1958
2049
|
"type": "paragraph",
|
|
1959
2050
|
"text": "Next: [your first session](/docs/first-session)."
|
|
@@ -2980,6 +3071,160 @@
|
|
|
2980
3071
|
}
|
|
2981
3072
|
]
|
|
2982
3073
|
},
|
|
3074
|
+
{
|
|
3075
|
+
"slug": "alerts",
|
|
3076
|
+
"title": "Alerts",
|
|
3077
|
+
"lead": "Every alert Gloom sets, and where each one is checked: in the app while it runs, and in Gloom Cloud when you are signed in.",
|
|
3078
|
+
"category": "Start here",
|
|
3079
|
+
"tags": [
|
|
3080
|
+
"ALRT",
|
|
3081
|
+
"SA",
|
|
3082
|
+
"alerts",
|
|
3083
|
+
"price alert",
|
|
3084
|
+
"IV alert",
|
|
3085
|
+
"risk reversal",
|
|
3086
|
+
"news alert",
|
|
3087
|
+
"earnings alert",
|
|
3088
|
+
"options flow",
|
|
3089
|
+
"push",
|
|
3090
|
+
"email",
|
|
3091
|
+
"gloom alerts add"
|
|
3092
|
+
],
|
|
3093
|
+
"updatedAt": "2026-11-11",
|
|
3094
|
+
"blocks": [
|
|
3095
|
+
{
|
|
3096
|
+
"type": "heading",
|
|
3097
|
+
"level": 2,
|
|
3098
|
+
"text": "Open it"
|
|
3099
|
+
},
|
|
3100
|
+
{
|
|
3101
|
+
"type": "table",
|
|
3102
|
+
"headers": [
|
|
3103
|
+
"Command",
|
|
3104
|
+
"Does"
|
|
3105
|
+
],
|
|
3106
|
+
"rows": [
|
|
3107
|
+
[
|
|
3108
|
+
"`ALRT`",
|
|
3109
|
+
"Your alerts: **Levels**, **Events** and **History**"
|
|
3110
|
+
],
|
|
3111
|
+
[
|
|
3112
|
+
"`SA AAPL above 250`",
|
|
3113
|
+
"Adds a price alert from the command bar"
|
|
3114
|
+
],
|
|
3115
|
+
[
|
|
3116
|
+
"`gloom alerts add ...`",
|
|
3117
|
+
"Adds any alert from the shell; `gloom help alerts` lists every form"
|
|
3118
|
+
]
|
|
3119
|
+
]
|
|
3120
|
+
},
|
|
3121
|
+
{
|
|
3122
|
+
"type": "heading",
|
|
3123
|
+
"level": 2,
|
|
3124
|
+
"text": "Who checks what"
|
|
3125
|
+
},
|
|
3126
|
+
{
|
|
3127
|
+
"type": "paragraph",
|
|
3128
|
+
"text": "The running app checks price, move, valuation, technical and ratio alerts. Signed in with Cloud sync, Gloom Cloud checks them too while the app is closed. A few others are checked only by the running app, and the news, filing and market rules only by Gloom Cloud, for a signed-in account."
|
|
3129
|
+
},
|
|
3130
|
+
{
|
|
3131
|
+
"type": "table",
|
|
3132
|
+
"headers": [
|
|
3133
|
+
"Alert",
|
|
3134
|
+
"Checked by",
|
|
3135
|
+
"Reaches you"
|
|
3136
|
+
],
|
|
3137
|
+
"rows": [
|
|
3138
|
+
[
|
|
3139
|
+
"Price: above, below, crosses",
|
|
3140
|
+
"The running app, as quotes arrive. With Cloud sync, Gloom Cloud while the app is closed",
|
|
3141
|
+
"In the app. With the app closed, on your phone and by email"
|
|
3142
|
+
],
|
|
3143
|
+
[
|
|
3144
|
+
"Move from the previous close",
|
|
3145
|
+
"The running app, once a session. With Cloud sync, Gloom Cloud while the app is closed",
|
|
3146
|
+
"In the app. With the app closed, on your phone and in that day's market email"
|
|
3147
|
+
],
|
|
3148
|
+
[
|
|
3149
|
+
"P/E, P/S, ratio to a benchmark",
|
|
3150
|
+
"The running app. With Cloud sync, Gloom Cloud while the app is closed",
|
|
3151
|
+
"As price alerts"
|
|
3152
|
+
],
|
|
3153
|
+
[
|
|
3154
|
+
"RSI and moving averages, RRG",
|
|
3155
|
+
"The running app, on the daily close (RRG on the weekly close). With Cloud sync, Gloom Cloud while the app is closed",
|
|
3156
|
+
"As price alerts"
|
|
3157
|
+
],
|
|
3158
|
+
[
|
|
3159
|
+
"IV level: 30-day ATM IV or 25-delta risk reversal",
|
|
3160
|
+
"The running app, every 15 minutes",
|
|
3161
|
+
"In the app only"
|
|
3162
|
+
],
|
|
3163
|
+
[
|
|
3164
|
+
"Earnings date, CPI, FOMC, an economic release",
|
|
3165
|
+
"The running app, every 15 minutes",
|
|
3166
|
+
"In the app, on the day the lead time is reached, and with the actual figures once out. Earnings alerts also reach your phone, once per report and never on the day itself"
|
|
3167
|
+
],
|
|
3168
|
+
[
|
|
3169
|
+
"[Catalysts](/docs/catalysts) (trial readouts, FDA dates)",
|
|
3170
|
+
"The running app, signed in, on Gloom Pro, every five minutes",
|
|
3171
|
+
"In the app"
|
|
3172
|
+
],
|
|
3173
|
+
[
|
|
3174
|
+
"News keyword, SEC filing, analyst change, 52-week high or low, unusual volume, short interest, insider trade, hiring, a perpetual's funding or open interest",
|
|
3175
|
+
"Gloom Cloud, signed in",
|
|
3176
|
+
"On your phone"
|
|
3177
|
+
],
|
|
3178
|
+
[
|
|
3179
|
+
"IV spike on one option contract, options flow",
|
|
3180
|
+
"Gloom Cloud, signed in, on Gloom Pro",
|
|
3181
|
+
"On your phone"
|
|
3182
|
+
],
|
|
3183
|
+
[
|
|
3184
|
+
"IPO, Congress trades, 13F filings",
|
|
3185
|
+
"Gloom Cloud, signed in",
|
|
3186
|
+
"On your phone"
|
|
3187
|
+
]
|
|
3188
|
+
]
|
|
3189
|
+
},
|
|
3190
|
+
{
|
|
3191
|
+
"type": "paragraph",
|
|
3192
|
+
"text": "A Cloud alert added while signed out is kept, and reads **Needs sign-in** in `ALRT` and `gloom alerts list` until you sign in. Commands such as `gloom doctor` or `gloom fn` never check alerts: only the app does."
|
|
3193
|
+
},
|
|
3194
|
+
{
|
|
3195
|
+
"type": "heading",
|
|
3196
|
+
"level": 2,
|
|
3197
|
+
"text": "Add one"
|
|
3198
|
+
},
|
|
3199
|
+
{
|
|
3200
|
+
"type": "code",
|
|
3201
|
+
"code": "gloom alerts add AAPL above 250\ngloom alerts add GBPUSD=X moves 0.5%\ngloom alerts add BTC-USD iv above 50 # bitcoin's 30-day ATM IV, from Deribit's options\ngloom alerts add SPY rr below -6 # 30-day 25-delta risk reversal, in vol points\ngloom alerts add CRWV earnings --days 3\ngloom alerts add news bitcoin # any story that mentions it\ngloom alerts add NVDA flow 5m calls sweeps\ngloom alerts add AAPL271217C00300000 iv spike 5"
|
|
3202
|
+
},
|
|
3203
|
+
{
|
|
3204
|
+
"type": "list",
|
|
3205
|
+
"items": [
|
|
3206
|
+
"A symbol is read as `gloom quote` reads it. A target more than 10 times the last price, or under a tenth of it, is refused.",
|
|
3207
|
+
"An IV level reads the 1M row of `OVDV`'s Table: US listings, and `BTC-USD` and `ETH-USD` from Deribit's options.",
|
|
3208
|
+
"News, flow and the other Cloud rules follow US listings. A coin's news is a keyword alert, on the words you typed when they name the coin, else on its name: `gloom alerts add news bitcoin`.",
|
|
3209
|
+
"A ticker that is also a series name says which listing the alert follows. `DVOL` is a US fund; Deribit's bitcoin volatility index is `gloom fn G CAP:volatility:dvol-btc`, and an alert on bitcoin's implied volatility is `gloom alerts add BTC-USD iv above 60`.",
|
|
3210
|
+
"An IV spike needs a live contract: one past its expiry is refused."
|
|
3211
|
+
]
|
|
3212
|
+
},
|
|
3213
|
+
{
|
|
3214
|
+
"type": "heading",
|
|
3215
|
+
"level": 2,
|
|
3216
|
+
"text": "After it goes off"
|
|
3217
|
+
},
|
|
3218
|
+
{
|
|
3219
|
+
"type": "paragraph",
|
|
3220
|
+
"text": "A price or IV level alert goes off once, then reads **Triggered** or **Alerted** until you re-arm it (`m` in `ALRT`, or `gloom alerts rearm <id>`). A move alert arms itself again for the next session."
|
|
3221
|
+
},
|
|
3222
|
+
{
|
|
3223
|
+
"type": "paragraph",
|
|
3224
|
+
"text": "**History** in `ALRT`, and `gloom fn ALRT --tab history`, lists the alerts that went off on this device, newest first, with the figure and the quote behind each, beside the alerts you created, re-armed or deleted."
|
|
3225
|
+
}
|
|
3226
|
+
]
|
|
3227
|
+
},
|
|
2983
3228
|
{
|
|
2984
3229
|
"slug": "ai-workflows",
|
|
2985
3230
|
"title": "AI workflows",
|
|
@@ -3099,7 +3344,7 @@
|
|
|
3099
3344
|
"troubleshooting",
|
|
3100
3345
|
"diagnostics"
|
|
3101
3346
|
],
|
|
3102
|
-
"updatedAt": "2026-
|
|
3347
|
+
"updatedAt": "2026-11-09",
|
|
3103
3348
|
"blocks": [
|
|
3104
3349
|
{
|
|
3105
3350
|
"type": "heading",
|
|
@@ -3149,7 +3394,7 @@
|
|
|
3149
3394
|
{
|
|
3150
3395
|
"type": "list",
|
|
3151
3396
|
"items": [
|
|
3152
|
-
"`Bad CPU type in executable` on macOS: an Intel Mac running the Apple Silicon app. Delete `/Applications/Gloom.app` (`Gloomberb.app` before the app was renamed) and rerun `curl -fsSL gloom.sh/install | bash` for the Intel terminal build.",
|
|
3397
|
+
"`Bad CPU type in executable` on macOS: an Intel Mac running the Apple Silicon app. [Delete](/docs/getting-started#uninstall) `/Applications/Gloom.app` (`Gloomberb.app` before the app was renamed) and rerun `curl -fsSL gloom.sh/install | bash` for the Intel terminal build.",
|
|
3153
3398
|
"`gloom doctor` shows runtime errors.",
|
|
3154
3399
|
"Update with the same method you installed with. See [Install and update](/docs/getting-started)."
|
|
3155
3400
|
]
|
|
@@ -3901,7 +4146,7 @@
|
|
|
3901
4146
|
"government",
|
|
3902
4147
|
"SPLC"
|
|
3903
4148
|
],
|
|
3904
|
-
"updatedAt": "2026-
|
|
4149
|
+
"updatedAt": "2026-11-12",
|
|
3905
4150
|
"blocks": [
|
|
3906
4151
|
{
|
|
3907
4152
|
"type": "heading",
|
|
@@ -4001,7 +4246,8 @@
|
|
|
4001
4246
|
{
|
|
4002
4247
|
"type": "list",
|
|
4003
4248
|
"items": [
|
|
4004
|
-
"A contract is evidence of a government customer, not recognised revenue. Prime awards, subawards and modifications overlap, so do not add them, and currencies are never combined."
|
|
4249
|
+
"A contract is evidence of a government customer, not recognised revenue. Prime awards, subawards and modifications overlap, so do not add them, and currencies are never combined.",
|
|
4250
|
+
"Singapore's GeBIZ amounts are as printed. For a tender awarded by items, a panel or a framework, an amount can be a ceiling, a rate or an estimate, not the supplier's revenue. An amount under S$6,000, or the same amount printed for several suppliers of one tender, shows as no amount."
|
|
4005
4251
|
]
|
|
4006
4252
|
},
|
|
4007
4253
|
{
|
|
@@ -4438,7 +4684,7 @@
|
|
|
4438
4684
|
{
|
|
4439
4685
|
"slug": "perpetuals",
|
|
4440
4686
|
"title": "Perpetual history",
|
|
4441
|
-
"lead": "PERP shows
|
|
4687
|
+
"lead": "PERP shows a board and rankings of perpetuals on Hyperliquid, Binance, Bybit and OKX, and one perpetual's funding, open interest and premium history",
|
|
4442
4688
|
"category": "Understand the data",
|
|
4443
4689
|
"tags": [
|
|
4444
4690
|
"PERP",
|
|
@@ -4447,7 +4693,7 @@
|
|
|
4447
4693
|
"perpetuals",
|
|
4448
4694
|
"history"
|
|
4449
4695
|
],
|
|
4450
|
-
"updatedAt": "2026-
|
|
4696
|
+
"updatedAt": "2026-11-09",
|
|
4451
4697
|
"blocks": [
|
|
4452
4698
|
{
|
|
4453
4699
|
"type": "heading",
|
|
@@ -4463,11 +4709,11 @@
|
|
|
4463
4709
|
"rows": [
|
|
4464
4710
|
[
|
|
4465
4711
|
"`PERP`",
|
|
4466
|
-
"
|
|
4712
|
+
"The Board of every market"
|
|
4467
4713
|
],
|
|
4468
4714
|
[
|
|
4469
4715
|
"`PERP BTC`",
|
|
4470
|
-
"Bitcoin
|
|
4716
|
+
"Bitcoin on the venue with the most open interest"
|
|
4471
4717
|
],
|
|
4472
4718
|
[
|
|
4473
4719
|
"`PERP hyperliquid:xyz:TSLA`",
|
|
@@ -4487,6 +4733,14 @@
|
|
|
4487
4733
|
"Shows"
|
|
4488
4734
|
],
|
|
4489
4735
|
"rows": [
|
|
4736
|
+
[
|
|
4737
|
+
"Board",
|
|
4738
|
+
"Every market by venue: mark, funding, premium, open interest and its 24-hour change, long share and APR, filtered by asset class and venue"
|
|
4739
|
+
],
|
|
4740
|
+
[
|
|
4741
|
+
"Rankings",
|
|
4742
|
+
"The highest and lowest funding, open-interest surges and premium dislocations, across every asset class or within one"
|
|
4743
|
+
],
|
|
4490
4744
|
[
|
|
4491
4745
|
"Compare",
|
|
4492
4746
|
"One asset's contracts across the venues: mark, funding, premium and when each was observed"
|
|
@@ -4571,6 +4825,7 @@
|
|
|
4571
4825
|
"type": "list",
|
|
4572
4826
|
"items": [
|
|
4573
4827
|
"Stored readings cover Hyperliquid, Binance, Bybit and OKX. Compare shows each venue's leading contract free; Pro lists every contract.",
|
|
4828
|
+
"A contract's asset class is the one its venue gives it: OKX's instrument category, Binance's underlying type and Bybit's symbol type, so a venue's stock, commodity or FX perpetual is never counted as crypto. Hyperliquid's builder-deployed markets are classed from a checked list and stay Other until checked.",
|
|
4574
4829
|
"Positive funding means longs pay shorts. Open interest in contracts and in USD differ, because a price rise adds USD open interest without new contracts.",
|
|
4575
4830
|
"A stock perpetual's premium is blank while the stock market is closed. The live board and trading are in the Hyperliquid plugin."
|
|
4576
4831
|
]
|
|
@@ -5661,15 +5916,20 @@
|
|
|
5661
5916
|
"blocks": [
|
|
5662
5917
|
{
|
|
5663
5918
|
"type": "paragraph",
|
|
5664
|
-
"text": "`gloom`
|
|
5919
|
+
"text": "`gloom` opens the terminal UI (`gloom launch-ui` from a script). Every other command runs headless and prints text, or `--json`, `--csv` or `--ndjson`."
|
|
5665
5920
|
},
|
|
5666
5921
|
{
|
|
5667
|
-
"type": "
|
|
5668
|
-
"
|
|
5922
|
+
"type": "code",
|
|
5923
|
+
"code": "gloom quote AAPL MSFT\ngloom fn GP NVDA\ngloom financials MSFT --csv --output msft.csv\ngloom shot QQ AAPL,MSFT,NVDA --output quotes.png"
|
|
5669
5924
|
},
|
|
5670
5925
|
{
|
|
5671
5926
|
"type": "paragraph",
|
|
5672
|
-
"text": "
|
|
5927
|
+
"text": "`gloom help <command>` shows usage and examples. Plugins add commands, such as `ai ask` from BYOK AI."
|
|
5928
|
+
},
|
|
5929
|
+
{
|
|
5930
|
+
"type": "heading",
|
|
5931
|
+
"level": 2,
|
|
5932
|
+
"text": "Global flags"
|
|
5673
5933
|
},
|
|
5674
5934
|
{
|
|
5675
5935
|
"type": "table",
|
|
@@ -5680,11 +5940,11 @@
|
|
|
5680
5940
|
"rows": [
|
|
5681
5941
|
[
|
|
5682
5942
|
"`--json`, `--csv`, `--ndjson`",
|
|
5683
|
-
"Machine-readable output
|
|
5943
|
+
"Machine-readable output; `--json` is the richest"
|
|
5684
5944
|
],
|
|
5685
5945
|
[
|
|
5686
5946
|
"`--output file`, `--out file`",
|
|
5687
|
-
"Write
|
|
5947
|
+
"Write that output to a file ([more](#files-and-windows))"
|
|
5688
5948
|
],
|
|
5689
5949
|
[
|
|
5690
5950
|
"`--limit n`",
|
|
@@ -5696,7 +5956,7 @@
|
|
|
5696
5956
|
],
|
|
5697
5957
|
[
|
|
5698
5958
|
"`--dry-run`",
|
|
5699
|
-
"Preview a change without saving
|
|
5959
|
+
"Preview a change without saving: `config`, `cache`, `notes`, `alerts`, `plugin enable` and `disable`, `remote`"
|
|
5700
5960
|
],
|
|
5701
5961
|
[
|
|
5702
5962
|
"`-q`, `--quiet`, `--no-color`",
|
|
@@ -5704,7 +5964,7 @@
|
|
|
5704
5964
|
],
|
|
5705
5965
|
[
|
|
5706
5966
|
"`--plain`, `--no-plain`",
|
|
5707
|
-
"Text for a screen reader or very large text
|
|
5967
|
+
"Text for a screen reader or very large text ([more](#plain-output))"
|
|
5708
5968
|
],
|
|
5709
5969
|
[
|
|
5710
5970
|
"`--width n`",
|
|
@@ -5714,16 +5974,7 @@
|
|
|
5714
5974
|
},
|
|
5715
5975
|
{
|
|
5716
5976
|
"type": "paragraph",
|
|
5717
|
-
"text": "
|
|
5718
|
-
},
|
|
5719
|
-
{
|
|
5720
|
-
"type": "heading",
|
|
5721
|
-
"level": 3,
|
|
5722
|
-
"text": "Windows consoles"
|
|
5723
|
-
},
|
|
5724
|
-
{
|
|
5725
|
-
"type": "paragraph",
|
|
5726
|
-
"text": "Output uses UTF-8 characters such as long dashes, `€` and `·`. Windows Terminal and PowerShell show them; in an older cmd.exe console, run `chcp 65001` first. In cmd.exe, write an index symbol in double quotes (`gloom quote \"^SPX\"`): cmd drops a bare `^`."
|
|
5977
|
+
"text": "Exit codes: 0 when it worked, 1 when it failed (bad input, no data found, a failed check). `gloom help` ends with the list."
|
|
5727
5978
|
},
|
|
5728
5979
|
{
|
|
5729
5980
|
"type": "heading",
|
|
@@ -5759,11 +6010,11 @@
|
|
|
5759
6010
|
],
|
|
5760
6011
|
[
|
|
5761
6012
|
"`fn CMP <symbols> [--from <date>] [--to <date>] [--total-return] [--currency <code>]`",
|
|
5762
|
-
"Returns side by side
|
|
6013
|
+
"Returns side by side"
|
|
5763
6014
|
],
|
|
5764
6015
|
[
|
|
5765
6016
|
"`fn DVD <symbols>`",
|
|
5766
|
-
"Dividend yield and history; several
|
|
6017
|
+
"Dividend yield and history; several rank by yield, with payout, growth, last ex-date and pay date"
|
|
5767
6018
|
],
|
|
5768
6019
|
[
|
|
5769
6020
|
"`holders`, `insider`, `13f`, `filings` `<symbol>`",
|
|
@@ -5779,6 +6030,13 @@
|
|
|
5779
6030
|
]
|
|
5780
6031
|
]
|
|
5781
6032
|
},
|
|
6033
|
+
{
|
|
6034
|
+
"type": "list",
|
|
6035
|
+
"items": [
|
|
6036
|
+
"`fn CMP` gives price returns in each listing's currency. `--total-return` reinvests each distribution at its ex-date close.",
|
|
6037
|
+
"`--currency USD` converts every close at that day's FX close, so a lira stock's return carries the lira's move."
|
|
6038
|
+
]
|
|
6039
|
+
},
|
|
5782
6040
|
{
|
|
5783
6041
|
"type": "heading",
|
|
5784
6042
|
"level": 2,
|
|
@@ -5801,19 +6059,19 @@
|
|
|
5801
6059
|
],
|
|
5802
6060
|
[
|
|
5803
6061
|
"`fx <currency>`, `fx <base>/<quote>`, `fx <amount> <from>/<to>`",
|
|
5804
|
-
"A currency into your base currency, a pair as markets quote it
|
|
6062
|
+
"A currency into your base currency, a pair as markets quote it with its move on the day (`fx USD/MXN`), or an amount converted (`fx 5000000 USD/EUR`)"
|
|
5805
6063
|
],
|
|
5806
6064
|
[
|
|
5807
6065
|
"`fx <pair> --date <day>`",
|
|
5808
|
-
"The rate at that day's daily FX close (`fx USD/MXN --date 2026-11-06`)
|
|
6066
|
+
"The rate at that day's daily FX close (`fx USD/MXN --date 2026-11-06`)"
|
|
5809
6067
|
],
|
|
5810
6068
|
[
|
|
5811
6069
|
"`fx [amount] <pair> --forward <tenor>`",
|
|
5812
|
-
"The forward implied by both currencies' short rates
|
|
6070
|
+
"The forward implied by both currencies' short rates, with forward points (`fx 5000000 USD/MXN --forward 30d`)"
|
|
5813
6071
|
],
|
|
5814
6072
|
[
|
|
5815
6073
|
"`econ [--country all|US|G7|EU|<codes>] [--impact high|medium|low|all] [--search <words>] [--from <date>] [--tz <zone>]`",
|
|
5816
|
-
"Economic calendar
|
|
6074
|
+
"Economic calendar"
|
|
5817
6075
|
],
|
|
5818
6076
|
[
|
|
5819
6077
|
"`fred <series>`, `yield-curve`",
|
|
@@ -5825,6 +6083,16 @@
|
|
|
5825
6083
|
]
|
|
5826
6084
|
]
|
|
5827
6085
|
},
|
|
6086
|
+
{
|
|
6087
|
+
"type": "list",
|
|
6088
|
+
"items": [
|
|
6089
|
+
"Gold, silver, platinum and palladium have no spot quote: `fx XAU/TRY` uses the front-month future (GC=F) and the dollar pair, and says so.",
|
|
6090
|
+
"A weekend or holiday `--date` reads the trading day before, and says so.",
|
|
6091
|
+
"`--forward` is covered interest parity, not a dealer quote. With an amount it adds the carry in your base currency, and which side earns it.",
|
|
6092
|
+
"Short rates cover USD, EUR, GBP, MXN, BRL, SGD and ZAR, and for TRY the CBRT policy rate, named so.",
|
|
6093
|
+
"`econ --country` takes two-letter codes, comma separated (`TR`, `MX,BR,ZA`). An earlier `--from` lists past events with their actuals."
|
|
6094
|
+
]
|
|
6095
|
+
},
|
|
5828
6096
|
{
|
|
5829
6097
|
"type": "heading",
|
|
5830
6098
|
"level": 2,
|
|
@@ -5839,35 +6107,39 @@
|
|
|
5839
6107
|
"rows": [
|
|
5840
6108
|
[
|
|
5841
6109
|
"`portfolio list|show|create|delete <name>`",
|
|
5842
|
-
"Manual portfolios
|
|
6110
|
+
"Manual portfolios"
|
|
5843
6111
|
],
|
|
5844
6112
|
[
|
|
5845
6113
|
"`portfolio create <name> --currency <code>`",
|
|
5846
|
-
"A portfolio that totals in another currency
|
|
6114
|
+
"A portfolio that totals in another currency (`--currency TRY`)"
|
|
5847
6115
|
],
|
|
5848
6116
|
[
|
|
5849
6117
|
"`portfolio add|remove <portfolio> <symbols...> [--file <csv|txt>]`",
|
|
5850
|
-
"
|
|
6118
|
+
"Several tickers at once, from a file, or piped (`-`)"
|
|
5851
6119
|
],
|
|
5852
6120
|
[
|
|
5853
6121
|
"`portfolio position set <portfolio> <symbol> <shares> <avg-cost> [currency] [--date <purchase date> | --cost-fx <rate>]`",
|
|
5854
|
-
"Set a position
|
|
6122
|
+
"Set a position"
|
|
5855
6123
|
],
|
|
5856
6124
|
[
|
|
5857
6125
|
"`portfolio import <file> [--name <portfolio>] [--merge|--replace] [--dry-run]`",
|
|
5858
|
-
"
|
|
6126
|
+
"From a broker's positions CSV (`-` reads standard input)"
|
|
5859
6127
|
],
|
|
5860
6128
|
[
|
|
5861
6129
|
"`portfolio cash set <portfolio> <amount> [currency]`, `portfolio cash clear <portfolio>`",
|
|
5862
|
-
"
|
|
6130
|
+
"The cash line, counted in the total and the weights"
|
|
6131
|
+
],
|
|
6132
|
+
[
|
|
6133
|
+
"`portfolio target set <portfolio> <symbol|CASH> <weight%>`",
|
|
6134
|
+
"A target weight; `portfolio show` and `PF` then add drift and the trade to reach it"
|
|
5863
6135
|
],
|
|
5864
6136
|
[
|
|
5865
|
-
"`portfolio target
|
|
5866
|
-
"
|
|
6137
|
+
"`portfolio target clear <portfolio> [symbol|CASH]`, `portfolio target show <portfolio>`",
|
|
6138
|
+
"Clear or list targets"
|
|
5867
6139
|
],
|
|
5868
6140
|
[
|
|
5869
6141
|
"`watchlist list|show|create|delete|add|remove`",
|
|
5870
|
-
"The same
|
|
6142
|
+
"The same for watchlists, with the same multi-symbol and `--file` add"
|
|
5871
6143
|
],
|
|
5872
6144
|
[
|
|
5873
6145
|
"`broker list [--type ibkr]`",
|
|
@@ -5879,29 +6151,72 @@
|
|
|
5879
6151
|
],
|
|
5880
6152
|
[
|
|
5881
6153
|
"`alerts list`, `alerts add ...`, `alerts delete|rearm <id>`",
|
|
5882
|
-
"Price, valuation, daily technical and event alerts
|
|
6154
|
+
"Price, valuation, daily technical and event alerts ([forms](#alerts))"
|
|
5883
6155
|
]
|
|
5884
6156
|
]
|
|
5885
6157
|
},
|
|
5886
6158
|
{
|
|
5887
6159
|
"type": "paragraph",
|
|
5888
|
-
"text": "[Portfolios and rebalancing](/docs/portfolio)
|
|
6160
|
+
"text": "[Portfolios and rebalancing](/docs/portfolio) covers what `portfolio show` lists and its options, other currencies, cost, broker CSV imports and targets."
|
|
5889
6161
|
},
|
|
5890
6162
|
{
|
|
5891
|
-
"type": "
|
|
5892
|
-
"
|
|
6163
|
+
"type": "list",
|
|
6164
|
+
"items": [
|
|
6165
|
+
"`portfolio show --from <date> --to <date>` gives the P&L between two closes, with the FX move.",
|
|
6166
|
+
"`portfolio add` takes symbols split by commas, spaces or lines, and prints one line per symbol and what was not found.",
|
|
6167
|
+
"`watchlist show <name> --csv` or `--json` prints one row per ticker, market cap included.",
|
|
6168
|
+
"`CASH` in `portfolio target` is the cash line. `portfolio add` and `position set` refuse a bare `CASH` (the stock is `CASH:NASDAQ`).",
|
|
6169
|
+
"`portfolio` and `watchlist` write immediately. `--dry-run` previews `add` and `portfolio import <file>`; other changes refuse it.",
|
|
6170
|
+
"Sign-in, account management and chat are app-only."
|
|
6171
|
+
]
|
|
5893
6172
|
},
|
|
5894
6173
|
{
|
|
5895
|
-
"type": "
|
|
5896
|
-
"
|
|
6174
|
+
"type": "heading",
|
|
6175
|
+
"level": 2,
|
|
6176
|
+
"text": "Functions: `catalog`, `fn`, `shot`"
|
|
5897
6177
|
},
|
|
5898
6178
|
{
|
|
5899
6179
|
"type": "paragraph",
|
|
5900
|
-
"text": "
|
|
6180
|
+
"text": "Every [function](/docs/functions) can run headless. `gloom catalog <function>` lists a function's options, and `shot` draws them as the pane does."
|
|
5901
6181
|
},
|
|
5902
6182
|
{
|
|
5903
|
-
"type": "
|
|
5904
|
-
"
|
|
6183
|
+
"type": "table",
|
|
6184
|
+
"headers": [
|
|
6185
|
+
"Command",
|
|
6186
|
+
"Use"
|
|
6187
|
+
],
|
|
6188
|
+
"rows": [
|
|
6189
|
+
[
|
|
6190
|
+
"`catalog [query] [--all] [--bot-safe]`",
|
|
6191
|
+
"Find functions and their options"
|
|
6192
|
+
],
|
|
6193
|
+
[
|
|
6194
|
+
"`catalog glossary [term]`, `catalog explain <term>`",
|
|
6195
|
+
"What a term means, such as `stop-out`, `B/C`, `drift`, `NAV`, `beta`, `R²` or `VaR`"
|
|
6196
|
+
],
|
|
6197
|
+
[
|
|
6198
|
+
"`fn <function> [argument] [--option value] [--explain]`",
|
|
6199
|
+
"Print a function's report; `--explain` adds the meaning of its terms"
|
|
6200
|
+
],
|
|
6201
|
+
[
|
|
6202
|
+
"`shot <function> [argument] [--output file] [--width px] [--height px] [--theme id] [--tab id] [--no-status] [--strict]`",
|
|
6203
|
+
"Save a PNG of the function as it looks on the desktop"
|
|
6204
|
+
]
|
|
6205
|
+
]
|
|
6206
|
+
},
|
|
6207
|
+
{
|
|
6208
|
+
"type": "code",
|
|
6209
|
+
"code": "gloom catalog chart\ngloom fn GP NVDA\ngloom fn 13F AAPL --view=ticker-holdings --json\ngloom shot QQ AAPL,MSFT,NVDA --output quotes.png\ngloom shot FA ASML --statement income --width 1400 --height 900\ngloom shot 13F 0001067983 --compare SPY # overlap with SPY"
|
|
6210
|
+
},
|
|
6211
|
+
{
|
|
6212
|
+
"type": "list",
|
|
6213
|
+
"items": [
|
|
6214
|
+
"An option only the text report reads, such as `--limit`, fails `shot` with exit 1 and names the `fn` command that reads it.",
|
|
6215
|
+
"`shot` saves its PNG, prints a Reason line and exits 0 when the pane drew an error, was empty, still loading or behind an access gate.",
|
|
6216
|
+
"`shot --strict` exits 2 in those cases instead, still saving the PNG and printing the Reason.",
|
|
6217
|
+
"A name nothing opens (`fn volsurf SPY`) lists up to five functions closest by name, keyword and description, and how to search the catalog.",
|
|
6218
|
+
"`shot` lays out 720 to 2400 wide and 360 to 1800 tall, drawing the PNG at twice that. Other sizes are clamped, with a warning."
|
|
6219
|
+
]
|
|
5905
6220
|
},
|
|
5906
6221
|
{
|
|
5907
6222
|
"type": "heading",
|
|
@@ -5944,73 +6259,101 @@
|
|
|
5944
6259
|
{
|
|
5945
6260
|
"type": "heading",
|
|
5946
6261
|
"level": 2,
|
|
5947
|
-
"text": "
|
|
5948
|
-
},
|
|
5949
|
-
{
|
|
5950
|
-
"type": "paragraph",
|
|
5951
|
-
"text": "Every [function](/docs/functions) can run headless."
|
|
6262
|
+
"text": "Plugin capabilities"
|
|
5952
6263
|
},
|
|
5953
6264
|
{
|
|
5954
|
-
"type": "
|
|
5955
|
-
"
|
|
5956
|
-
"Command",
|
|
5957
|
-
"Use"
|
|
5958
|
-
],
|
|
5959
|
-
"rows": [
|
|
5960
|
-
[
|
|
5961
|
-
"`catalog [query] [--all] [--bot-safe]`",
|
|
5962
|
-
"Find functions and their options"
|
|
5963
|
-
],
|
|
5964
|
-
[
|
|
5965
|
-
"`catalog glossary [term]`, `catalog explain <term>`",
|
|
5966
|
-
"What a term means, such as `stop-out`, `B/C`, `drift`, `NAV`, `beta`, `R²` or `VaR`"
|
|
5967
|
-
],
|
|
5968
|
-
[
|
|
5969
|
-
"`fn <function> [argument] [--option value] [--explain]`",
|
|
5970
|
-
"Print a function's report; `--explain` adds the meaning of the terms it shows"
|
|
5971
|
-
],
|
|
5972
|
-
[
|
|
5973
|
-
"`shot <function> [argument] [--output file] [--width px] [--height px] [--theme id] [--no-status] [--strict]`",
|
|
5974
|
-
"Save a PNG of the function as it looks on the desktop; `--strict` exits 2 when the pane has no usable data"
|
|
5975
|
-
]
|
|
5976
|
-
]
|
|
6265
|
+
"type": "code",
|
|
6266
|
+
"code": "gloom api list --json\ngloom api get <capability-id>\ngloom api invoke asset-data.gloomberb-cloud.getQuote '{\"ticker\":\"AAPL\",\"exchange\":\"NASDAQ\"}' --json\ngloom api subscribe <capability.operation> [json] --limit 10"
|
|
5977
6267
|
},
|
|
5978
6268
|
{
|
|
5979
|
-
"type": "
|
|
5980
|
-
"
|
|
6269
|
+
"type": "heading",
|
|
6270
|
+
"level": 2,
|
|
6271
|
+
"text": "Alerts"
|
|
5981
6272
|
},
|
|
5982
6273
|
{
|
|
5983
6274
|
"type": "paragraph",
|
|
5984
|
-
"text": "
|
|
6275
|
+
"text": "Every kind the `ALRT` pane offers, as `gloom help alerts` lists them:"
|
|
5985
6276
|
},
|
|
5986
6277
|
{
|
|
5987
|
-
"type": "
|
|
5988
|
-
"
|
|
6278
|
+
"type": "code",
|
|
6279
|
+
"code": "gloom alerts list\ngloom alerts add <symbol> <above|below|crosses> <price>\ngloom alerts add <symbol> <pe|ps|rsi(14)> <above|below> <level>\ngloom alerts add <symbol> ma(50) crosses <above|below> ma(200)\ngloom alerts add <symbol> closes <above|below> ma(200)\ngloom alerts add <symbol>/<benchmark> <above|below|crosses> <ratio>\ngloom alerts add <symbol> rrg <leading|weakening|lagging|improving> [--benchmark <symbol>]\ngloom alerts add <symbol> earnings [--days <n> | results]\ngloom alerts add <calendar event> [--country <code>] [--days <n>]\ngloom alerts add [symbol] news <keyword>\ngloom alerts add [symbol] flow [premium] [calls|puts] [sweeps|blocks]\ngloom alerts add <symbol> <iv|rr> <above|below> <level>\ngloom alerts add <OCC contract> iv spike <points>\ngloom alerts add <symbol> 52-week <high|low>\ngloom alerts add <symbol> unusual volume [<multiple>x]\ngloom alerts add <symbol> filing [8-K|10-K|10-Q|S-1|13D|13D/A|13G|13G/A|6-K|20-F]\ngloom alerts add <symbol> insider [buy|sell]\ngloom alerts add <symbol> short interest [increase|decrease] [<percent>%]\ngloom alerts add <symbol> analyst [upgrade|downgrade]\ngloom alerts add <symbol> hiring [accelerating|slowing]\ngloom alerts add perps <market> <funding|oi|premium|closed-premium> <above|below> <percent>\ngloom alerts add catalyst [type <type> | agency <agency> | country <code>]\ngloom alerts add <symbol> catalyst\ngloom alerts add congress [member name]\ngloom alerts add 13f <fund CIK>\ngloom alerts delete <id>\ngloom alerts rearm <id>"
|
|
5989
6280
|
},
|
|
5990
6281
|
{
|
|
5991
|
-
"type": "
|
|
5992
|
-
"
|
|
6282
|
+
"type": "list",
|
|
6283
|
+
"items": [
|
|
6284
|
+
"Words none of these forms read are refused with the list of kinds.",
|
|
6285
|
+
"Adding a rule that exists names its ID and adds nothing. `rearm` on an alert that has not gone off says it is already active.",
|
|
6286
|
+
"RSI and moving-average alerts are always saved. They read the daily closes `history` shows as final, and say when they are first checked.",
|
|
6287
|
+
"`alerts list` shows each alert's listing and currency, its last reading and when (or `not checked yet`), and when it was created, in ISO 8601 UTC.",
|
|
6288
|
+
"Creating, re-arming and deleting an alert go in the app's alert log beside fired alerts (`gloom fn ALRT --tab history`)."
|
|
6289
|
+
]
|
|
5993
6290
|
},
|
|
5994
6291
|
{
|
|
5995
6292
|
"type": "paragraph",
|
|
5996
|
-
"text": "`
|
|
6293
|
+
"text": "`alerts list --csv` keeps its first eight columns in their original order, and adds five after them:"
|
|
5997
6294
|
},
|
|
5998
6295
|
{
|
|
5999
|
-
"type": "
|
|
6000
|
-
"
|
|
6296
|
+
"type": "code",
|
|
6297
|
+
"code": "id,kind,target,trigger,eventDate,status,lastCheckedPrice,triggeredAt,createdAt,listing,currency,lastReading,lastReadingAt"
|
|
6298
|
+
},
|
|
6299
|
+
{
|
|
6300
|
+
"type": "heading",
|
|
6301
|
+
"level": 2,
|
|
6302
|
+
"text": "Status line and times"
|
|
6303
|
+
},
|
|
6304
|
+
{
|
|
6305
|
+
"type": "paragraph",
|
|
6306
|
+
"text": "Reports end with their source and a dated status line:"
|
|
6307
|
+
},
|
|
6308
|
+
{
|
|
6309
|
+
"type": "code",
|
|
6310
|
+
"code": "Source: Gloom Cloud · US trading day Fri 9 Oct 2026 close · 15 min delayed · markets closed until Mon"
|
|
6311
|
+
},
|
|
6312
|
+
{
|
|
6313
|
+
"type": "list",
|
|
6314
|
+
"items": [
|
|
6315
|
+
"It says when the data is from (UTC, or a market's trading-day close, always with the year), how far it is held back, and when its market reopens.",
|
|
6316
|
+
"Screenshots draw the same line, without the source, in the pane footer inside the requested size. `--no-status` leaves it out.",
|
|
6317
|
+
"Times print in UTC. `gloom config set timezone Asia/Tokyo` (any `Region/City`; `none` turns it off) adds your clock beside them:"
|
|
6318
|
+
]
|
|
6319
|
+
},
|
|
6320
|
+
{
|
|
6321
|
+
"type": "code",
|
|
6322
|
+
"code": "Sat 10 Oct 2026 16:56 UTC (Sun 11 Oct 01:56 Asia/Tokyo)"
|
|
6001
6323
|
},
|
|
6002
6324
|
{
|
|
6003
6325
|
"type": "paragraph",
|
|
6004
|
-
"text": "
|
|
6326
|
+
"text": "A trading day keeps its market's date in every zone, and `--json` and `--csv` keep the raw values."
|
|
6005
6327
|
},
|
|
6006
6328
|
{
|
|
6007
6329
|
"type": "heading",
|
|
6008
6330
|
"level": 2,
|
|
6009
|
-
"text": "
|
|
6331
|
+
"text": "Files and Windows"
|
|
6010
6332
|
},
|
|
6011
6333
|
{
|
|
6012
|
-
"type": "
|
|
6013
|
-
"
|
|
6334
|
+
"type": "list",
|
|
6335
|
+
"items": [
|
|
6336
|
+
"`--output` writes the export in UTF-8 without a byte-order mark, and prints `Saved` or `Replaced` with its full path.",
|
|
6337
|
+
"Without `--csv`, `--json` or `--ndjson` it is refused, except on a command with an `--output` of its own.",
|
|
6338
|
+
"Those keep theirs: `fn` writes its report in the format asked for, text included; `shot` writes a PNG; a plugin command what its help says.",
|
|
6339
|
+
"On Windows, use `--output` rather than a `>` redirect: Windows PowerShell 5.1 writes UTF-16, which a spreadsheet misreads.",
|
|
6340
|
+
"Output uses UTF-8 (long dashes, `€`, `·`). Windows Terminal and PowerShell show it; in an older cmd.exe console, run `chcp 65001` first.",
|
|
6341
|
+
"cmd.exe drops a bare `^`, so quote an index symbol: `gloom quote \"^SPX\"`."
|
|
6342
|
+
]
|
|
6343
|
+
},
|
|
6344
|
+
{
|
|
6345
|
+
"type": "heading",
|
|
6346
|
+
"level": 2,
|
|
6347
|
+
"text": "Plain output"
|
|
6348
|
+
},
|
|
6349
|
+
{
|
|
6350
|
+
"type": "list",
|
|
6351
|
+
"items": [
|
|
6352
|
+
"`--plain` drops rule lines, writes arrows as words and keeps every table column, with a dash in an empty cell.",
|
|
6353
|
+
"A narrow table moves columns under each row instead of dropping them.",
|
|
6354
|
+
"It is on without the flag when output is piped or redirected, or `NO_COLOR` is non-empty, which also turns colour off. `--no-plain` turns it off.",
|
|
6355
|
+
"Without `--width`, the terminal's width applies; piped output fits `COLUMNS` when set."
|
|
6356
|
+
]
|
|
6014
6357
|
}
|
|
6015
6358
|
]
|
|
6016
6359
|
},
|
|
@@ -6023,22 +6366,22 @@
|
|
|
6023
6366
|
"agents",
|
|
6024
6367
|
"remote",
|
|
6025
6368
|
"cli",
|
|
6026
|
-
"automation"
|
|
6369
|
+
"automation",
|
|
6370
|
+
"setup"
|
|
6027
6371
|
],
|
|
6028
|
-
"updatedAt": "2026-
|
|
6372
|
+
"updatedAt": "2026-11-08",
|
|
6029
6373
|
"blocks": [
|
|
6030
6374
|
{
|
|
6031
|
-
"type": "
|
|
6032
|
-
"
|
|
6033
|
-
"text": "What this is"
|
|
6375
|
+
"type": "paragraph",
|
|
6376
|
+
"text": "`gloom remote` drives a Gloom app running on this machine, terminal (TUI) or desktop. Scripts and local agents read the screen, open panes, pick tickers and arrange layouts by name."
|
|
6034
6377
|
},
|
|
6035
6378
|
{
|
|
6036
|
-
"type": "
|
|
6037
|
-
"
|
|
6379
|
+
"type": "code",
|
|
6380
|
+
"code": "gloom # one terminal: the app\ngloom remote help # another: the agent guide\ngloom remote get app://snapshot --json # what is on screen"
|
|
6038
6381
|
},
|
|
6039
6382
|
{
|
|
6040
6383
|
"type": "paragraph",
|
|
6041
|
-
"text": "
|
|
6384
|
+
"text": "Leave `--app` out when one app runs. Pass `--app tui` or `--app desktop` when both do."
|
|
6042
6385
|
},
|
|
6043
6386
|
{
|
|
6044
6387
|
"type": "table",
|
|
@@ -6049,122 +6392,242 @@
|
|
|
6049
6392
|
"rows": [
|
|
6050
6393
|
[
|
|
6051
6394
|
"A script or local agent on the same machine as the app",
|
|
6052
|
-
"
|
|
6395
|
+
"`gloom remote`: no account, no network"
|
|
6053
6396
|
],
|
|
6054
6397
|
[
|
|
6055
6398
|
"Claude Code, Codex or another assistant connected to Gloom Cloud",
|
|
6056
6399
|
"The [MCP server](/docs/mcp) with [Terminal control](/docs/mcp#terminal-control): the same operations, one MCP for data and the terminal, and the app asks you before an assistant takes over and before anything leaves the app"
|
|
6057
6400
|
],
|
|
6058
6401
|
[
|
|
6059
|
-
"Anything that needs Cloud data with no
|
|
6402
|
+
"Anything that needs Cloud data with no app open",
|
|
6060
6403
|
"The [MCP server](/docs/mcp) without Terminal control"
|
|
6061
6404
|
]
|
|
6062
6405
|
]
|
|
6063
6406
|
},
|
|
6064
6407
|
{
|
|
6065
6408
|
"type": "paragraph",
|
|
6066
|
-
"text": "
|
|
6409
|
+
"text": "For headless data, reports and a screenshot of a function with no app open, use the [CLI](/docs/cli-functions)."
|
|
6067
6410
|
},
|
|
6068
6411
|
{
|
|
6069
6412
|
"type": "heading",
|
|
6070
6413
|
"level": 2,
|
|
6071
|
-
"text": "
|
|
6414
|
+
"text": "Commands"
|
|
6072
6415
|
},
|
|
6073
6416
|
{
|
|
6074
6417
|
"type": "table",
|
|
6075
6418
|
"headers": [
|
|
6076
|
-
"
|
|
6077
|
-
"
|
|
6419
|
+
"Command",
|
|
6420
|
+
"Use"
|
|
6078
6421
|
],
|
|
6079
6422
|
"rows": [
|
|
6080
6423
|
[
|
|
6081
|
-
"
|
|
6082
|
-
"
|
|
6424
|
+
"`gloom remote help`",
|
|
6425
|
+
"Agent-focused usage from the running app"
|
|
6083
6426
|
],
|
|
6084
6427
|
[
|
|
6085
|
-
"
|
|
6086
|
-
"
|
|
6428
|
+
"`gloom remote schema`",
|
|
6429
|
+
"Resource URIs, operations, request and response shapes"
|
|
6087
6430
|
],
|
|
6088
6431
|
[
|
|
6089
|
-
"
|
|
6090
|
-
"
|
|
6432
|
+
"`gloom remote get <resource>`",
|
|
6433
|
+
"Read one resource"
|
|
6091
6434
|
],
|
|
6092
6435
|
[
|
|
6093
|
-
"
|
|
6094
|
-
"
|
|
6436
|
+
"`gloom remote call <operation> [json] [--dry-run]`",
|
|
6437
|
+
"Invoke one operation"
|
|
6438
|
+
],
|
|
6439
|
+
[
|
|
6440
|
+
"`gloom remote patch <resource> <json-patch> [--expect-rev rev] [--dry-run]`",
|
|
6441
|
+
"JSON Patch a mutable resource"
|
|
6442
|
+
],
|
|
6443
|
+
[
|
|
6444
|
+
"`gloom remote batch <json> [--dry-run]`",
|
|
6445
|
+
"Run a multi-step workflow"
|
|
6446
|
+
],
|
|
6447
|
+
[
|
|
6448
|
+
"`gloom remote watch <resource> [--interval ms] [--limit n]`",
|
|
6449
|
+
"Poll for changes"
|
|
6095
6450
|
]
|
|
6096
6451
|
]
|
|
6097
6452
|
},
|
|
6098
6453
|
{
|
|
6099
6454
|
"type": "paragraph",
|
|
6100
|
-
"text": "
|
|
6455
|
+
"text": "All take `--app tui|desktop` and `--json`. `--dry-run` on `call` only echoes the payload, with no check of the operation or its fields; on `patch` it returns the patched result without saving."
|
|
6101
6456
|
},
|
|
6102
6457
|
{
|
|
6103
6458
|
"type": "heading",
|
|
6104
6459
|
"level": 2,
|
|
6105
|
-
"text": "
|
|
6460
|
+
"text": "When no app answers"
|
|
6461
|
+
},
|
|
6462
|
+
{
|
|
6463
|
+
"type": "paragraph",
|
|
6464
|
+
"text": "With `--json` the reason is in `error.code`, with `message` and `details` (what to do), and the command exits 1:"
|
|
6106
6465
|
},
|
|
6107
6466
|
{
|
|
6108
6467
|
"type": "table",
|
|
6109
6468
|
"headers": [
|
|
6110
|
-
"
|
|
6111
|
-
"
|
|
6469
|
+
"`error.code`",
|
|
6470
|
+
"Means, and what to do"
|
|
6112
6471
|
],
|
|
6113
6472
|
"rows": [
|
|
6114
6473
|
[
|
|
6115
|
-
"`
|
|
6116
|
-
"
|
|
6474
|
+
"`app_not_running`",
|
|
6475
|
+
"No app of this profile runs. Start `gloom` in another terminal, or open the desktop app"
|
|
6117
6476
|
],
|
|
6118
6477
|
[
|
|
6119
|
-
"`
|
|
6120
|
-
"
|
|
6478
|
+
"`app_ambiguous`",
|
|
6479
|
+
"The terminal and desktop apps both run, and neither is the one started last. Pass `--app tui` or `--app desktop`"
|
|
6121
6480
|
],
|
|
6122
6481
|
[
|
|
6123
|
-
"`
|
|
6124
|
-
"
|
|
6482
|
+
"`app_unreachable`",
|
|
6483
|
+
"The app's port does not answer from here, but nothing proves it gone: usually a sandbox that blocks localhost. Run the command where it can reach 127.0.0.1, or start Gloom again"
|
|
6484
|
+
]
|
|
6485
|
+
]
|
|
6486
|
+
},
|
|
6487
|
+
{
|
|
6488
|
+
"type": "paragraph",
|
|
6489
|
+
"text": "An endpoint file left by an app that exited without quitting is removed once its process is gone and its port refuses. An unreachable app's file is kept."
|
|
6490
|
+
},
|
|
6491
|
+
{
|
|
6492
|
+
"type": "paragraph",
|
|
6493
|
+
"text": "Asked for the desktop app while only the terminal app runs:"
|
|
6494
|
+
},
|
|
6495
|
+
{
|
|
6496
|
+
"type": "code",
|
|
6497
|
+
"code": "{ \"ok\": false, \"error\": { \"code\": \"app_not_running\", \"message\": \"The Gloom desktop app is not running.\", \"details\": \"The terminal app is: pass --app tui, or leave --app out.\" } }"
|
|
6498
|
+
},
|
|
6499
|
+
{
|
|
6500
|
+
"type": "paragraph",
|
|
6501
|
+
"text": "Anything else that fails, such as an operation the app refuses, is `cli_error`."
|
|
6502
|
+
},
|
|
6503
|
+
{
|
|
6504
|
+
"type": "heading",
|
|
6505
|
+
"level": 2,
|
|
6506
|
+
"text": "Read the screen"
|
|
6507
|
+
},
|
|
6508
|
+
{
|
|
6509
|
+
"type": "paragraph",
|
|
6510
|
+
"text": "`app://snapshot` is what is on screen in one read:"
|
|
6511
|
+
},
|
|
6512
|
+
{
|
|
6513
|
+
"type": "table",
|
|
6514
|
+
"headers": [
|
|
6515
|
+
"Key",
|
|
6516
|
+
"Holds"
|
|
6517
|
+
],
|
|
6518
|
+
"rows": [
|
|
6519
|
+
[
|
|
6520
|
+
"`app`",
|
|
6521
|
+
"Focus and command bar. Read `app.focusedPaneId`; `app.activePanel` is deprecated and always `left`"
|
|
6125
6522
|
],
|
|
6126
6523
|
[
|
|
6127
|
-
"`
|
|
6128
|
-
"
|
|
6524
|
+
"`config`",
|
|
6525
|
+
"Settings and the layouts"
|
|
6129
6526
|
],
|
|
6130
6527
|
[
|
|
6131
|
-
"`
|
|
6132
|
-
"
|
|
6528
|
+
"`panes`",
|
|
6529
|
+
"Each pane, where it is, and whether it has focus"
|
|
6133
6530
|
],
|
|
6134
6531
|
[
|
|
6135
|
-
"`
|
|
6136
|
-
"
|
|
6532
|
+
"`commandBar`, `form`",
|
|
6533
|
+
"The command bar, and an open form or the setup dialog"
|
|
6137
6534
|
],
|
|
6138
6535
|
[
|
|
6139
|
-
"`
|
|
6140
|
-
"
|
|
6536
|
+
"`ui`",
|
|
6537
|
+
"The labelled UI controls"
|
|
6538
|
+
],
|
|
6539
|
+
[
|
|
6540
|
+
"`references`",
|
|
6541
|
+
"Where to read what the snapshot leaves out"
|
|
6542
|
+
]
|
|
6543
|
+
]
|
|
6544
|
+
},
|
|
6545
|
+
{
|
|
6546
|
+
"type": "paragraph",
|
|
6547
|
+
"text": "It leaves out what an agent reads once or rarely:"
|
|
6548
|
+
},
|
|
6549
|
+
{
|
|
6550
|
+
"type": "table",
|
|
6551
|
+
"headers": [
|
|
6552
|
+
"Left out",
|
|
6553
|
+
"Read it from"
|
|
6554
|
+
],
|
|
6555
|
+
"rows": [
|
|
6556
|
+
[
|
|
6557
|
+
"Every resource and operation with its input",
|
|
6558
|
+
"`gloom remote schema`, once"
|
|
6559
|
+
],
|
|
6560
|
+
[
|
|
6561
|
+
"Recipes and caveats",
|
|
6562
|
+
"`gloom remote help` (`app://remote/help`)"
|
|
6563
|
+
],
|
|
6564
|
+
[
|
|
6565
|
+
"What each pane loaded (`runtimeState`, a saved layout's `paneState`)",
|
|
6566
|
+
"`app://pane-state/{paneId}`, `app://panes`, `app://config`"
|
|
6567
|
+
],
|
|
6568
|
+
[
|
|
6569
|
+
"Unlabelled UI nodes",
|
|
6570
|
+
"`ui://tree`"
|
|
6141
6571
|
]
|
|
6142
6572
|
]
|
|
6143
6573
|
},
|
|
6144
6574
|
{
|
|
6145
6575
|
"type": "paragraph",
|
|
6146
|
-
"text": "
|
|
6576
|
+
"text": "`app://snapshot/full` has all of it inline, the shape the snapshot had before 0.20.5. It is often several times the size: 413 KB against 73 KB with nine panes open."
|
|
6577
|
+
},
|
|
6578
|
+
{
|
|
6579
|
+
"type": "code",
|
|
6580
|
+
"code": "gloom remote get app://pane-templates --json\ngloom remote get ui://tree --json"
|
|
6581
|
+
},
|
|
6582
|
+
{
|
|
6583
|
+
"type": "paragraph",
|
|
6584
|
+
"text": "`pane.screenshot` returns a pane as a PNG (base64 in `image.data`, with its pixel size): the focused pane, or `paneId` from `app://panes`. Desktop only: the terminal app draws text."
|
|
6585
|
+
},
|
|
6586
|
+
{
|
|
6587
|
+
"type": "code",
|
|
6588
|
+
"code": "gloom remote call pane.screenshot '{}' --app desktop --json"
|
|
6147
6589
|
},
|
|
6148
6590
|
{
|
|
6149
6591
|
"type": "heading",
|
|
6150
6592
|
"level": 2,
|
|
6151
|
-
"text": "
|
|
6593
|
+
"text": "First-run setup"
|
|
6152
6594
|
},
|
|
6153
6595
|
{
|
|
6154
6596
|
"type": "paragraph",
|
|
6155
|
-
"text": "
|
|
6597
|
+
"text": "On a new profile the setup dialog covers the app. `app://form` (and the snapshot's `form`) reads `\"open\": true, \"kind\": \"setup\"`, with its `step`, `title`, `fields` by `id` and `buttons`:"
|
|
6156
6598
|
},
|
|
6157
6599
|
{
|
|
6158
6600
|
"type": "code",
|
|
6159
|
-
"code": "
|
|
6601
|
+
"code": "{ \"open\": true, \"kind\": \"setup\", \"step\": \"PORTFOLIO\", \"title\": \"What do you hold?\",\n \"fields\": [{ \"id\": \"ticker\", \"label\": \"Ticker\", \"value\": \"\" }, { \"id\": \"shares\" }, { \"id\": \"avgCost\" }, { \"id\": \"currency\" }],\n \"buttons\": [{ \"label\": \"Skip\" }, { \"label\": \"Continue\", \"disabled\": true, \"shortcut\": \"Enter\" }] }"
|
|
6160
6602
|
},
|
|
6161
6603
|
{
|
|
6162
6604
|
"type": "paragraph",
|
|
6163
|
-
"text": "
|
|
6605
|
+
"text": "While it is open:"
|
|
6606
|
+
},
|
|
6607
|
+
{
|
|
6608
|
+
"type": "list",
|
|
6609
|
+
"items": [
|
|
6610
|
+
"`app.search` and `app.openCommandBar` refuse, and `app.closeDialog` does not close it.",
|
|
6611
|
+
"A change made behind it still runs, and its answer carries `warnings` saying the setup dialog covers it.",
|
|
6612
|
+
"Its own controls match first in `ui.invokeMatching`."
|
|
6613
|
+
]
|
|
6614
|
+
},
|
|
6615
|
+
{
|
|
6616
|
+
"type": "paragraph",
|
|
6617
|
+
"text": "Add a ticker and continue, or skip a step:"
|
|
6164
6618
|
},
|
|
6165
6619
|
{
|
|
6166
6620
|
"type": "code",
|
|
6167
|
-
"code": "gloom remote call
|
|
6621
|
+
"code": "gloom remote batch '{ \"type\": \"batch\", \"requests\": [\n { \"type\": \"call\", \"operation\": \"ui.invokeMatching\", \"input\": { \"role\": \"form-field\", \"metadata\": { \"fieldId\": \"ticker\" }, \"action\": \"setValue\", \"input\": \"NVDA\" } },\n { \"type\": \"call\", \"operation\": \"ui.invokeMatching\", \"input\": { \"role\": \"form-field\", \"metadata\": { \"fieldId\": \"ticker\" }, \"action\": \"submit\" } },\n { \"type\": \"call\", \"operation\": \"ui.invokeMatching\", \"input\": { \"role\": \"form\", \"action\": \"submit\" } }\n] }' --json\ngloom remote call ui.invokeMatching '{ \"role\": \"button\", \"label\": \"Skip\", \"action\": \"press\" }' --json"
|
|
6622
|
+
},
|
|
6623
|
+
{
|
|
6624
|
+
"type": "list",
|
|
6625
|
+
"items": [
|
|
6626
|
+
"Submit on the Ticker field adds the position; `{ \"role\": \"form\", \"action\": \"submit\" }` presses the button Enter would.",
|
|
6627
|
+
"Skip leaves one step unfilled. A new profile has two steps, Portfolio and Desks.",
|
|
6628
|
+
"A step can change after the call answers, so read `app://form` again before the next call.",
|
|
6629
|
+
"When setup is run again, `form.actions` includes `cancel`, which skips all of it."
|
|
6630
|
+
]
|
|
6168
6631
|
},
|
|
6169
6632
|
{
|
|
6170
6633
|
"type": "heading",
|
|
@@ -6177,7 +6640,7 @@
|
|
|
6177
6640
|
},
|
|
6178
6641
|
{
|
|
6179
6642
|
"type": "code",
|
|
6180
|
-
"code": "gloom remote call pane.createFromTemplate '{ \"templateId\": \"market-heatmap-pane\" }' --
|
|
6643
|
+
"code": "gloom remote call pane.createFromTemplate '{ \"templateId\": \"market-heatmap-pane\" }' --json\ngloom remote call ticker.pin '{ \"symbol\": \"NVDA\", \"forceNewPane\": true }' --json"
|
|
6181
6644
|
},
|
|
6182
6645
|
{
|
|
6183
6646
|
"type": "paragraph",
|
|
@@ -6185,7 +6648,7 @@
|
|
|
6185
6648
|
},
|
|
6186
6649
|
{
|
|
6187
6650
|
"type": "code",
|
|
6188
|
-
"code": "gloom remote batch '{\n \"type\": \"batch\",\n \"include\": [\"panes\", \"commandBar\"],\n \"requests\": [\n { \"type\": \"call\", \"operation\": \"app.search\", \"input\": { \"mode\": \"ticker\", \"query\": \"NVDA\" } },\n { \"type\": \"call\", \"operation\": \"commandBar.activateResult\", \"input\": { \"index\": 0 } }\n ]\n}' --
|
|
6651
|
+
"code": "gloom remote batch '{\n \"type\": \"batch\",\n \"include\": [\"panes\", \"commandBar\"],\n \"requests\": [\n { \"type\": \"call\", \"operation\": \"app.search\", \"input\": { \"mode\": \"ticker\", \"query\": \"NVDA\" } },\n { \"type\": \"call\", \"operation\": \"commandBar.activateResult\", \"input\": { \"index\": 0 } }\n ]\n}' --json"
|
|
6189
6652
|
},
|
|
6190
6653
|
{
|
|
6191
6654
|
"type": "heading",
|
|
@@ -6194,19 +6657,15 @@
|
|
|
6194
6657
|
},
|
|
6195
6658
|
{
|
|
6196
6659
|
"type": "code",
|
|
6197
|
-
"code": "gloom remote call layout.setGrid '{ \"columns\": 2 }' --
|
|
6660
|
+
"code": "gloom remote call layout.setGrid '{ \"columns\": 2 }' --json\ngloom remote call layout.focusRegion '{ \"region\": \"right\" }' --json\ngloom remote call layout.closeFloating '{}' --json\ngloom remote call app.switchPanel '{ \"panel\": \"right\" }' --json"
|
|
6198
6661
|
},
|
|
6199
6662
|
{
|
|
6200
6663
|
"type": "paragraph",
|
|
6201
|
-
"text": "
|
|
6202
|
-
},
|
|
6203
|
-
{
|
|
6204
|
-
"type": "code",
|
|
6205
|
-
"code": "gloom remote call app.switchPanel '{ \"panel\": \"right\" }' --app desktop --json"
|
|
6664
|
+
"text": "`remote patch` works on what `remote schema` marks patchable: `app://config`, `app://layout/current`, `app://pane-state/{paneId}` and `app://pane-settings/{paneId}`."
|
|
6206
6665
|
},
|
|
6207
6666
|
{
|
|
6208
6667
|
"type": "paragraph",
|
|
6209
|
-
"text": "
|
|
6668
|
+
"text": "Read the resource and its `rev` first, then pass `--expect-rev`, so a stale edit fails instead of overwriting."
|
|
6210
6669
|
},
|
|
6211
6670
|
{
|
|
6212
6671
|
"type": "heading",
|
|
@@ -6219,11 +6678,48 @@
|
|
|
6219
6678
|
},
|
|
6220
6679
|
{
|
|
6221
6680
|
"type": "code",
|
|
6222
|
-
"code": "gloom remote
|
|
6681
|
+
"code": "gloom remote call ui.invokeMatching '{ \"role\": \"button\", \"label\": \"Open Help\", \"action\": \"press\" }' --json"
|
|
6223
6682
|
},
|
|
6224
6683
|
{
|
|
6225
6684
|
"type": "paragraph",
|
|
6226
6685
|
"text": "Use it sparingly; higher-level operations survive UI changes."
|
|
6686
|
+
},
|
|
6687
|
+
{
|
|
6688
|
+
"type": "heading",
|
|
6689
|
+
"level": 2,
|
|
6690
|
+
"text": "Concepts"
|
|
6691
|
+
},
|
|
6692
|
+
{
|
|
6693
|
+
"type": "table",
|
|
6694
|
+
"headers": [
|
|
6695
|
+
"Concept",
|
|
6696
|
+
"Meaning"
|
|
6697
|
+
],
|
|
6698
|
+
"rows": [
|
|
6699
|
+
[
|
|
6700
|
+
"App kind",
|
|
6701
|
+
"`tui` and `desktop` are separate apps; `--app` picks one"
|
|
6702
|
+
],
|
|
6703
|
+
[
|
|
6704
|
+
"Resources",
|
|
6705
|
+
"State to read: `app://snapshot`, `app://form`, `app://panes`, `app://pane-templates`, `app://commands`, `app://capabilities`, `ui://tree`"
|
|
6706
|
+
],
|
|
6707
|
+
[
|
|
6708
|
+
"Operations",
|
|
6709
|
+
"Changes: `app.search`, `commandBar.activateResult`, `pane.createFromTemplate`, `pane.focus`, `ticker.navigate`, `layout.setGrid`, `ui.invokeMatching`"
|
|
6710
|
+
],
|
|
6711
|
+
[
|
|
6712
|
+
"Capabilities",
|
|
6713
|
+
"Plugin service operations, for plugin-owned data and side effects. The UI goes through app operations"
|
|
6714
|
+
]
|
|
6715
|
+
]
|
|
6716
|
+
},
|
|
6717
|
+
{
|
|
6718
|
+
"type": "list",
|
|
6719
|
+
"items": [
|
|
6720
|
+
"Every operation changes only the local app, except `capability.invoke`, which runs a plugin capability and can reach external services.",
|
|
6721
|
+
"`watchlist.add` and `watchlist.remove` ask in the app first and answer with what happened. Nothing else asks."
|
|
6722
|
+
]
|
|
6227
6723
|
}
|
|
6228
6724
|
]
|
|
6229
6725
|
},
|
|
@@ -6241,15 +6737,15 @@
|
|
|
6241
6737
|
"terminal",
|
|
6242
6738
|
"remote control"
|
|
6243
6739
|
],
|
|
6244
|
-
"updatedAt": "2026-11-
|
|
6740
|
+
"updatedAt": "2026-11-08",
|
|
6245
6741
|
"blocks": [
|
|
6246
6742
|
{
|
|
6247
6743
|
"type": "paragraph",
|
|
6248
|
-
"text": "Gloom Cloud
|
|
6744
|
+
"text": "Gloom Cloud's [MCP](https://modelcontextprotocol.io) server at `https://api.gloom.sh/mcp` has the research tools Gloom's own assistant uses, and with access your notes, [teams](/docs/teams) and brokers."
|
|
6249
6745
|
},
|
|
6250
6746
|
{
|
|
6251
6747
|
"type": "paragraph",
|
|
6252
|
-
"text": "The same keys work for the [REST API](/docs/rest-api) and [Google Sheets](/docs/google-sheets).
|
|
6748
|
+
"text": "Part of [Gloom Pro](/cloud). The same keys work for the [REST API](/docs/rest-api) and [Google Sheets](/docs/google-sheets). [Terminal control](#terminal-control) also drives your open app; for one-off reports, use the [CLI](/docs/cli-functions)."
|
|
6253
6749
|
},
|
|
6254
6750
|
{
|
|
6255
6751
|
"type": "heading",
|
|
@@ -6258,7 +6754,7 @@
|
|
|
6258
6754
|
},
|
|
6259
6755
|
{
|
|
6260
6756
|
"type": "paragraph",
|
|
6261
|
-
"text": "**Sign in from the client.** OAuth clients (Claude Code, claude.ai, Cursor and most recent
|
|
6757
|
+
"text": "**Sign in from the client.** OAuth clients (Claude Code, claude.ai, Cursor and most recent ones) need only the endpoint. The first call opens a browser tab to choose what the client may reach."
|
|
6262
6758
|
},
|
|
6263
6759
|
{
|
|
6264
6760
|
"type": "code",
|
|
@@ -6266,7 +6762,11 @@
|
|
|
6266
6762
|
},
|
|
6267
6763
|
{
|
|
6268
6764
|
"type": "paragraph",
|
|
6269
|
-
"text": "**Use a key
|
|
6765
|
+
"text": "**Use a key** for scripts and clients without a browser. Create one in [Cloud settings, Agents](/cloud/account?view=agents) and send it as a bearer token (`x-api-key` also works)."
|
|
6766
|
+
},
|
|
6767
|
+
{
|
|
6768
|
+
"type": "paragraph",
|
|
6769
|
+
"text": "Keys are shown once; you can hold up to 10."
|
|
6270
6770
|
},
|
|
6271
6771
|
{
|
|
6272
6772
|
"type": "code",
|
|
@@ -6315,8 +6815,27 @@
|
|
|
6315
6815
|
]
|
|
6316
6816
|
},
|
|
6317
6817
|
{
|
|
6318
|
-
"type": "
|
|
6319
|
-
"
|
|
6818
|
+
"type": "list",
|
|
6819
|
+
"items": [
|
|
6820
|
+
"A key's access, Terminal control and optional team pin are fixed at creation.",
|
|
6821
|
+
"Signed-in clients get the same levels through the `mcp:read`, `mcp:write` and `mcp:terminal` scopes; the consent page leaves Terminal control unticked.",
|
|
6822
|
+
"`tools/list` returns only what the caller may call."
|
|
6823
|
+
]
|
|
6824
|
+
},
|
|
6825
|
+
{
|
|
6826
|
+
"type": "heading",
|
|
6827
|
+
"level": 2,
|
|
6828
|
+
"text": "Plans and limits"
|
|
6829
|
+
},
|
|
6830
|
+
{
|
|
6831
|
+
"type": "list",
|
|
6832
|
+
"items": [
|
|
6833
|
+
"Creating keys needs Pro. Any valid key can `initialize` and `tools/list`, but tool calls need Pro, except `portfolio.*`.",
|
|
6834
|
+
"Tool calls get real-time quotes and the live news wire.",
|
|
6835
|
+
"Keys allow 120 requests a minute and 5,000 a day; over the limit returns `429` with `Retry-After`.",
|
|
6836
|
+
"If Pro lapses, keys stay but tool calls are refused.",
|
|
6837
|
+
"Revoking a key applies on the next request. A disconnected client's token expires within two hours; its terminal calls stop at once."
|
|
6838
|
+
]
|
|
6320
6839
|
},
|
|
6321
6840
|
{
|
|
6322
6841
|
"type": "heading",
|
|
@@ -6325,7 +6844,7 @@
|
|
|
6325
6844
|
},
|
|
6326
6845
|
{
|
|
6327
6846
|
"type": "paragraph",
|
|
6328
|
-
"text": "Read-only unless marked write. Most take `limit`; `?` marks an optional argument
|
|
6847
|
+
"text": "Read-only unless marked write. Most take `limit`; `?` marks an optional argument, and `tools/list` has the full schema. Start with `market.search` when a ticker is ambiguous."
|
|
6329
6848
|
},
|
|
6330
6849
|
{
|
|
6331
6850
|
"type": "heading",
|
|
@@ -6365,10 +6884,14 @@
|
|
|
6365
6884
|
],
|
|
6366
6885
|
[
|
|
6367
6886
|
"`market.options_flow`",
|
|
6368
|
-
"`symbol?`, `days?`, `minPremium?`
|
|
6887
|
+
"`symbol?`, `days?`, `minPremium?`"
|
|
6369
6888
|
]
|
|
6370
6889
|
]
|
|
6371
6890
|
},
|
|
6891
|
+
{
|
|
6892
|
+
"type": "paragraph",
|
|
6893
|
+
"text": "`market.options_flow` with a filter searches recorded prints, not the live tape."
|
|
6894
|
+
},
|
|
6372
6895
|
{
|
|
6373
6896
|
"type": "heading",
|
|
6374
6897
|
"level": 3,
|
|
@@ -6413,7 +6936,7 @@
|
|
|
6413
6936
|
],
|
|
6414
6937
|
[
|
|
6415
6938
|
"`sec.insider_transactions`",
|
|
6416
|
-
"`ticker`, `since?`, `until
|
|
6939
|
+
"`ticker`, `since?`, `until?`, `offset?`"
|
|
6417
6940
|
],
|
|
6418
6941
|
[
|
|
6419
6942
|
"`sec.thirteenf_holders`",
|
|
@@ -6429,6 +6952,10 @@
|
|
|
6429
6952
|
]
|
|
6430
6953
|
]
|
|
6431
6954
|
},
|
|
6955
|
+
{
|
|
6956
|
+
"type": "paragraph",
|
|
6957
|
+
"text": "`sec.insider_transactions` takes trade dates (`YYYY-MM-DD`) for `since` and `until`, returns every Form 4 of the window, and says which days it covers."
|
|
6958
|
+
},
|
|
6432
6959
|
{
|
|
6433
6960
|
"type": "heading",
|
|
6434
6961
|
"level": 3,
|
|
@@ -6718,53 +7245,20 @@
|
|
|
6718
7245
|
{
|
|
6719
7246
|
"type": "heading",
|
|
6720
7247
|
"level": 2,
|
|
6721
|
-
"text": "
|
|
6722
|
-
},
|
|
6723
|
-
{
|
|
6724
|
-
"type": "paragraph",
|
|
6725
|
-
"text": "Connect a broker in Gloom and every client with read access reaches it through Gloom. The `portfolio.*` tools cover every connected broker in one call and need no Pro."
|
|
7248
|
+
"text": "Terminal control"
|
|
6726
7249
|
},
|
|
6727
7250
|
{
|
|
6728
7251
|
"type": "paragraph",
|
|
6729
|
-
"text": "
|
|
7252
|
+
"text": "Terminal control reaches everything the [remote API](/docs/agents) does in your open, signed-in desktop or TUI: the screen, panes, tickers, layouts, UI actions and plugin capabilities."
|
|
6730
7253
|
},
|
|
6731
7254
|
{
|
|
6732
|
-
"type": "
|
|
6733
|
-
"
|
|
6734
|
-
"
|
|
6735
|
-
"
|
|
6736
|
-
"
|
|
6737
|
-
],
|
|
6738
|
-
"rows": [
|
|
6739
|
-
[
|
|
6740
|
-
"Interactive Brokers",
|
|
6741
|
-
"`ibkr.*`: positions, balances, trades, orders, contract search, prices, alerts, watchlists",
|
|
6742
|
-
"Order instructions, alerts and watchlists, when trading instructions are enabled"
|
|
6743
|
-
],
|
|
6744
|
-
[
|
|
6745
|
-
"Robinhood",
|
|
6746
|
-
"`robinhood.*`: accounts and equity positions",
|
|
6747
|
-
"None"
|
|
6748
|
-
]
|
|
7255
|
+
"type": "list",
|
|
7256
|
+
"items": [
|
|
7257
|
+
"The app asks once before an assistant takes over.",
|
|
7258
|
+
"Plugin capabilities, button presses, commands and anything that reaches an outside service (orders, transfers, messages) ask you in the app on every call.",
|
|
7259
|
+
"An unanswered one is denied after 60 seconds."
|
|
6749
7260
|
]
|
|
6750
7261
|
},
|
|
6751
|
-
{
|
|
6752
|
-
"type": "paragraph",
|
|
6753
|
-
"text": "An IBKR order instruction is not an order: IBKR returns a link where you review and submit it yourself."
|
|
6754
|
-
},
|
|
6755
|
-
{
|
|
6756
|
-
"type": "paragraph",
|
|
6757
|
-
"text": "IBKR allows one AI connection per user, and Gloom holds it: connecting IBKR in Gloom disconnects IBKR from other AI apps, so reach it through Gloom instead of connecting it directly. The IBKR sign-in ends seven days after you consent, however often it is used, and only signing in again brings it back. A day before, the Brokers pane shows when it ends and Gloom emails you once. Background: [IBKR in Claude or ChatGPT](/answers/ibkr-claude-chatgpt-connector)."
|
|
6758
|
-
},
|
|
6759
|
-
{
|
|
6760
|
-
"type": "heading",
|
|
6761
|
-
"level": 2,
|
|
6762
|
-
"text": "Terminal control"
|
|
6763
|
-
},
|
|
6764
|
-
{
|
|
6765
|
-
"type": "paragraph",
|
|
6766
|
-
"text": "Terminal control reaches everything the [remote API](/docs/agents) does in your open, signed-in desktop or TUI: read the screen, open and arrange panes, navigate tickers, switch and edit layouts, semantic UI actions and plugin capabilities. The app asks once before an assistant takes over; plugin capabilities, button presses, commands and anything that reaches an outside service (orders, transfers, messages) ask you in the app on every call, and an unanswered one is denied after 60 seconds."
|
|
6767
|
-
},
|
|
6768
7262
|
{
|
|
6769
7263
|
"type": "code",
|
|
6770
7264
|
"code": "Claude Code ──MCP──> api.gloom.sh/mcp ──Cloud socket──> your Gloom app ──> panes, layouts, tickers\n │\n asks you: once per assistant, every call that leaves the app"
|
|
@@ -6790,7 +7284,7 @@
|
|
|
6790
7284
|
],
|
|
6791
7285
|
[
|
|
6792
7286
|
"`terminal.pane.screenshot`",
|
|
6793
|
-
"One pane of the desktop app as a PNG image, as it looks on screen (`paneId?`, `width?`)
|
|
7287
|
+
"One pane of the desktop app as a PNG image, as it looks on screen (`paneId?`, `width?`)"
|
|
6794
7288
|
],
|
|
6795
7289
|
[
|
|
6796
7290
|
"`terminal.get_resource`, `terminal.patch_resource`",
|
|
@@ -6807,25 +7301,71 @@
|
|
|
6807
7301
|
]
|
|
6808
7302
|
},
|
|
6809
7303
|
{
|
|
6810
|
-
"type": "
|
|
6811
|
-
"
|
|
7304
|
+
"type": "list",
|
|
7305
|
+
"items": [
|
|
7306
|
+
"Each tool takes `device?`, an id or name from `terminal.devices`. Its description gives the operation's tier and whether you confirm each call.",
|
|
7307
|
+
"A call that waits on you over 45 seconds answers `pending` with a `callId`; `terminal.call_result` reads the outcome.",
|
|
7308
|
+
"With no app open, tools answer `no_terminal`.",
|
|
7309
|
+
"`terminal.pane.screenshot` is a read: once you approved the assistant it runs without asking. Up to 1600 px on the long side and 512 KB; the TUI answers `unsupported`.",
|
|
7310
|
+
"Revoke an assistant in the app (Account Management, Agents), or revoke its key or disconnect it here, and its next call stops."
|
|
7311
|
+
]
|
|
6812
7312
|
},
|
|
6813
7313
|
{
|
|
6814
7314
|
"type": "heading",
|
|
6815
7315
|
"level": 2,
|
|
6816
|
-
"text": "
|
|
7316
|
+
"text": "Brokers"
|
|
6817
7317
|
},
|
|
6818
7318
|
{
|
|
6819
7319
|
"type": "paragraph",
|
|
6820
|
-
"text": "
|
|
7320
|
+
"text": "Connect a broker in Gloom and every client with read access reaches it through Gloom. The `portfolio.*` tools cover every connected broker in one call and need no Pro."
|
|
6821
7321
|
},
|
|
6822
7322
|
{
|
|
6823
|
-
"type": "
|
|
6824
|
-
"
|
|
7323
|
+
"type": "table",
|
|
7324
|
+
"headers": [
|
|
7325
|
+
"Broker",
|
|
7326
|
+
"Tools",
|
|
7327
|
+
"Writes (read and write access)"
|
|
7328
|
+
],
|
|
7329
|
+
"rows": [
|
|
7330
|
+
[
|
|
7331
|
+
"Interactive Brokers",
|
|
7332
|
+
"`ibkr.*`: positions, balances, trades, orders, contract search, prices, alerts, watchlists",
|
|
7333
|
+
"Order instructions, alerts and watchlists, when trading instructions are enabled"
|
|
7334
|
+
],
|
|
7335
|
+
[
|
|
7336
|
+
"Robinhood",
|
|
7337
|
+
"`robinhood.*`: accounts and equity positions",
|
|
7338
|
+
"None"
|
|
7339
|
+
]
|
|
7340
|
+
]
|
|
7341
|
+
},
|
|
7342
|
+
{
|
|
7343
|
+
"type": "list",
|
|
7344
|
+
"items": [
|
|
7345
|
+
"With no connection, `portfolio.*` returns no rows and a note. A broker that fails adds an `error` row, and the result is `partial`.",
|
|
7346
|
+
"They read brokerage accounts, not team portfolios (use `collections.get`).",
|
|
7347
|
+
"An IBKR order instruction is not an order: IBKR returns a link where you review and submit it yourself.",
|
|
7348
|
+
"IBKR allows one AI connection per user, and Gloom holds it: connecting IBKR in Gloom disconnects it from other AI apps, so reach it through Gloom.",
|
|
7349
|
+
"The IBKR sign-in ends seven days after you consent, however often it is used; only signing in again brings it back.",
|
|
7350
|
+
"A day before, the Brokers pane shows when it ends, and Gloom emails you once."
|
|
7351
|
+
]
|
|
6825
7352
|
},
|
|
6826
7353
|
{
|
|
6827
7354
|
"type": "paragraph",
|
|
6828
|
-
"text": "
|
|
7355
|
+
"text": "Background: [IBKR in Claude or ChatGPT](/answers/ibkr-claude-chatgpt-connector)."
|
|
7356
|
+
},
|
|
7357
|
+
{
|
|
7358
|
+
"type": "heading",
|
|
7359
|
+
"level": 2,
|
|
7360
|
+
"text": "Results"
|
|
7361
|
+
},
|
|
7362
|
+
{
|
|
7363
|
+
"type": "list",
|
|
7364
|
+
"items": [
|
|
7365
|
+
"Each call returns text plus `structuredContent` with `status`, `rowCount`, `truncated`, `asOf` and `data`. Results are capped at 256 KB.",
|
|
7366
|
+
"`status` is `ok`, `partial` when a limit removed rows, or `error`. A failed source returns `status: \"error\"` with `data.error = { code, source, reason }`.",
|
|
7367
|
+
"`terminal.pane.screenshot` returns the same JSON as text plus an image block, and no `structuredContent`: some clients read only that and would drop the image."
|
|
7368
|
+
]
|
|
6829
7369
|
}
|
|
6830
7370
|
]
|
|
6831
7371
|
},
|
|
@@ -8187,7 +8727,7 @@
|
|
|
8187
8727
|
{
|
|
8188
8728
|
"url": "/academy/rates-bonds-credit/rates/auctions",
|
|
8189
8729
|
"title": "Treasury auctions (AUCT)",
|
|
8190
|
-
"summary": "AUCT lists upcoming and recent US Treasury auctions with the rate each cleared at, how well it was covered and who bought.",
|
|
8730
|
+
"summary": "AUCT lists upcoming and recent US Treasury auctions with the rate each cleared at, how well it was covered and who bought, and Hong Kong's government paper tenders.",
|
|
8191
8731
|
"chapter": "Rates, bonds and credit",
|
|
8192
8732
|
"minutes": 5
|
|
8193
8733
|
},
|