@gloom-sh/terminal 0.0.0-stage → 0.19.0

package/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2026 Gloomberb Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+When using this software in a product or service, attribution to the Gloomberb
+project (https://github.com/gloom-sh/gloomberb) is appreciated and encouraged,
+though not legally required beyond preserving the above copyright notice.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,74 @@
-# Temporary Holding Version
+<div align="center">
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<img src="src/assets/gloomberb-logo.svg" alt="Gloom logo" width="76" />
+
+# Gloom
+
+**Open-source finance terminal. Fast, keyboard-driven, and extensible.**
+
+Desktop app for macOS and Windows. Terminal UI for macOS, Linux, and Windows.
+
+<a href="https://gloom.sh/download/desktop"><strong>Download desktop</strong></a>
+&nbsp;&middot;&nbsp;
+<a href="#install"><strong>Install the TUI</strong></a>
+&nbsp;&middot;&nbsp;
+<a href="https://term.gloom.sh"><strong>Open in browser</strong></a>
+&nbsp;&middot;&nbsp;
+<a href="https://gloom.sh/discord">Discord</a>
+&nbsp;&middot;&nbsp;
+<a href="README.zh-CN.md">简体中文</a>
+
+<br />
+<br />
+
+<img src="https://gloom.sh/landing-terminal.png" alt="Gloom terminal showing portfolio, watchlists, market data, and chart panels." width="720" />
+
+<sub>Backed by <a href="https://adjacent.markets/?ref=gloomberb"><img src="docs/assets/adjacent.svg" alt="" width="12" height="12" /> Adjacent</a></sub>
+
+</div>
+
+Quotes, charts, financials, filings, options, news, portfolios and alerts in one workspace. Browse every function in the [function catalog](https://gloom.sh/docs/functions).
+
+## Install
+
+On **macOS (Apple Silicon)**:
+
+```bash
+brew install --cask gloomberb
+```
+
+On **Windows 11**, [download the installer](https://github.com/gloom-sh/gloomberb/releases/latest/download/stable-win-x64-GloomberbSetup.exe). It is not code-signed yet, so SmartScreen may ask you to click **More info**, then **Run anyway**.
+
+For the terminal on **macOS or Linux**:
+
+```bash
+curl -fsSL gloom.sh/install | bash
+```
+
+The script downloads the prebuilt release from GitHub and checks its SHA-256 against the digest GitHub lists. Apple Silicon Macs get the desktop app and the `gloom` command; Linux and Intel Macs get the standalone binary. It asks for `sudo` only if the destination isn't writable. Prefer to download it yourself? See the [installation guide](docs/installation.md).
+
+With [Bun](https://bun.sh), on any supported OS:
+
+```bash
+bun install -g gloomberb
+```
+
+Then run `gloom`. The command was called `gloomberb` before 0.18.4, and that name still works. For chart graphics, use a Kitty-compatible terminal such as Ghostty, Kitty, or WezTerm. Windows Terminal draws charts as text; the desktop app draws them in full.
+
+## Start
+
+Press `Ctrl+P` for the command bar, or `` ` `` to search for a ticker. Try `DES AAPL` for company details or `GP NVDA` for a price chart. `HELP` lists commands and shortcuts.
+
+The [user guide](docs/usage.md) covers charts, broker setup, shortcuts, and the CLI (`gloom quote AAPL`).
+
+## Data and privacy
+
+The app is MIT licensed. Market data and Ask Gloom use [Gloom Cloud](https://gloom.sh/cloud), our hosted service, which is not open source. Free market data is delayed 15 minutes; Pro adds real-time data. See [what is open and what is not](docs/open-source.md). The [browser app](https://term.gloom.sh) has a smaller feature set ([limits](docs/browser.md)).
+
+Crash reports and usage counts can be turned off. See [what is sent and how to opt out](docs/telemetry.md).
+
+## Plugins and contributing
+
+Plugins add panes, data providers, broker connections, and commands. Install one from GitHub with `gloom install gloom-sh/gloom-tv`. See the [plugin guide](PLUGINS.md) and the [contributing guide](CONTRIBUTING.md).
+
+[MIT licensed](LICENSE). Built with [OpenTUI](https://opentui.com/). [Sponsor Gloom](https://gloom.sh/sponsor).

package/README.zh-CN.md

@@ -0,0 +1,116 @@
+<div align="center">
+
+<img src="src/assets/gloomberb-logo.svg" alt="Gloom 标志" width="76" />
+
+# Gloom
+
+**开源金融终端。快速、键盘驱动、可扩展。**
+
+桌面应用支持 macOS 和 Windows。终端界面（TUI）支持 macOS、Linux 和 Windows。
+
+<a href="https://gloom.sh/download/desktop"><strong>下载桌面版</strong></a>
+&nbsp;&middot;&nbsp;
+<a href="#安装"><strong>安装 TUI</strong></a>
+&nbsp;&middot;&nbsp;
+<a href="https://term.gloom.sh"><strong>在浏览器中打开</strong></a>
+&nbsp;&middot;&nbsp;
+<a href="https://gloom.sh/discord">Discord</a>
+&nbsp;&middot;&nbsp;
+<a href="README.md">English</a>
+
+<br />
+<br />
+
+<img src="https://gloom.sh/landing-terminal.png" alt="Gloom 终端界面，显示投资组合、自选列表、市场数据和图表面板。" width="720" />
+
+<sub>由 <a href="https://adjacent.markets/?ref=gloomberb"><img src="docs/assets/adjacent.svg" alt="" width="12" height="12" /> Adjacent</a> 赞助支持</sub>
+
+</div>
+
+> 本文档为社区维护的简体中文翻译。若与 [英文原版 README](README.md) 有出入，以英文版为准。
+
+- **公司研究**：行情、图表、财务报表、监管文件、期权与分析师评级。
+- **市场追踪**：新闻、全球股指、外汇、经济事件与市场扫描工具。
+- **工作区管理**：投资组合、自选列表、券商连接、提醒、笔记与 AI 工具。
+
+桌面版和 TUI 共享同一套命令语言与插件系统。[浏览器版](https://term.gloom.sh) 提供部分功能，需要免费 Gloom Cloud 账户：免费行情有请求频率限制，并延迟 15 分钟；Pro 提供实时行情。详见[浏览器版功能与限制（英文）](docs/browser.md)。
+
+## 安装
+
+### 桌面版
+
+在 **macOS（Apple Silicon）** 上：
+
+```bash
+brew install --cask gloomberb
+```
+
+在 **Windows 11** 上，[下载安装程序](https://github.com/gloom-sh/gloomberb/releases/latest/download/stable-win-x64-GloomberbSetup.exe)。支持 x64，也可通过 x64 仿真在 ARM64 上运行。
+
+两个平台的桌面安装程序均包含 `gloom` 终端命令。
+
+### 终端版
+
+在 **macOS 或 Linux** 上：
+
+```bash
+curl -fsSL gloom.sh/install | bash
+```
+
+在 Apple Silicon Mac 上，此脚本会安装桌面版和 TUI；在 Intel Mac 和 Linux 上，会安装独立的 TUI。
+
+也可在 macOS、Linux 或 Windows x64 上通过 [Bun](https://bun.sh) 安装：
+
+```bash
+bun install -g gloomberb
+```
+
+运行 `gloom` 即可启动。0.18.4 之前命令名为 `gloomberb`，该名称仍可使用。要显示图形，请使用兼容 Kitty 图形协议的终端，例如 Ghostty、Kitty 或 WezTerm。直接下载、安装位置与更新方式详见[安装指南（英文）](docs/installation.md)。
+
+## 开始使用
+
+按 `Ctrl+P` 打开命令栏，或按 `` ` `` 搜索股票代码。桌面版也支持 `Cmd/Ctrl+K`。
+
+| 试试 | 打开 |
+|-----|-------|
+| `DES AAPL` | 公司详情 |
+| `GP NVDA` | 价格图表 |
+| `TOP` | 市场新闻 |
+| `PF` | 投资组合与自选列表 |
+| `HELP` | 命令与键盘快捷键 |
+
+使用 `Tab` 切换面板，`j` / `k` 浏览列表。[使用指南（英文）](docs/usage.md) 包含图表、券商配置、键盘快捷键与完整命令参考。
+
+## 命令行（CLI）
+
+直接在 shell 中运行命令：
+
+```bash
+gloom quote AAPL
+gloom quote AAPL --json
+gloom help
+```
+
+默认输出便于阅读；脚本可使用 `--json`、`--csv` 或 `--ndjson` 获取结构化输出。命令与参数详见 [CLI 参考（英文）](docs/usage.md#cli)。
+
+## 插件与贡献
+
+插件可添加面板、数据源、券商连接与命令。从 GitHub 安装插件：
+
+```bash
+gloom install gloom-sh/gloom-tv
+```
+
+详见[插件开发指南（英文）](PLUGINS.md)、[直播电视配置（英文）](docs/usage.md#live-tv)或[贡献指南（英文）](CONTRIBUTING.md)。
+
+界面支持英语、西班牙语、简体中文、繁体中文、日语与韩语。在命令栏中输入 `LANG` 即可切换，详见[语言设置（英文）](docs/usage.md#localized-interface)。
+
+采用 [MIT 许可证](LICENSE)。基于 [OpenTUI](https://opentui.com/) 构建。
+
+## 赞助商
+
+<a href="https://adjacent.markets/?ref=gloomberb"><img src="docs/assets/adjacent.svg" alt="Adjacent" width="56" /></a>
+
+[Adjacent](https://adjacent.markets/?ref=gloomberb) 提供预测市场指数、参考利率与数据。感谢其对 Gloom 开源开发的支持。
+
+如需赞助 Gloom，请发送邮件至 [hello@gloom.sh](mailto:hello@gloom.sh)。

package/bin/gloom

@@ -0,0 +1,13 @@
+#!/usr/bin/env bun
+
+// The package installs this as both `gloom` and `gloomberb`.
+//
+// Bun applies patchedDependencies only to the root project, so a global
+// `bun install -g` runs react-reconciler without
+// patches/react-reconciler@0.33.0.patch. Its dev build then records a
+// performance.measure for every component render, which Bun keeps forever.
+// The reconciler reads console.timeStamp once at load to decide, so hide it
+// before React is imported.
+delete console.timeStamp;
+
+await import("../src/cli/entry.ts");

package/package.json

@@ -1,6 +1,146 @@
 {
   "name": "@gloom-sh/terminal",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.19.0",
+  "packageManager": "bun@1.3.11",
+  "description": "Market research and portfolio tracker for the terminal",
+  "module": "src/public/index.ts",
+  "type": "module",
+  "exports": {
+    ".": "./src/public/index.ts",
+    "./types/plugin": "./src/types/plugin.ts",
+    "./types/persistence": "./src/types/persistence.ts",
+    "./ui": "./src/ui/index.tsx",
+    "./components": "./src/components/index.ts",
+    "./theme": "./src/theme/colors.ts",
+    "./capabilities": "./src/capabilities/index.ts",
+    "./utils": "./src/public/utils.ts",
+    "./react": "./src/public/react.ts",
+    "./test-support": "./src/public/test-support.ts",
+    "./package.json": "./package.json",
+    "./types/broker": "./src/types/broker.ts",
+    "./types/config": "./src/types/config.ts",
+    "./types/data-provider": "./src/types/data-provider.ts",
+    "./types/financials": "./src/types/financials.ts",
+    "./types/instrument": "./src/types/instrument.ts",
+    "./types/ticker": "./src/types/ticker.ts",
+    "./types/trading": "./src/types/trading.ts",
+    "./time-series": "./src/public/time-series.ts",
+    "./layout": "./src/public/layout.ts",
+    "./market-data": "./src/public/market-data.ts",
+    "./quotes": "./src/public/quotes.ts",
+    "./tickers": "./src/public/tickers.ts",
+    "./i18n": "./src/public/i18n.ts",
+    "./remote": "./src/public/remote.ts",
+    "./dialog": "./src/ui/dialog.tsx",
+    "./broker": "./src/public/broker.ts"
+  },
+  "bin": {
+    "gloom": "bin/gloom",
+    "gloomberb": "bin/gloom"
+  },
+  "files": [
+    "bin",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test.tsx",
+    "!src/**/test-harness.tsx",
+    "!src/**/fixtures/**",
+    "!src/**/*.fixture.json",
+    "!src/**/test-fixture*.ts",
+    "!src/**/*.test-data.ts",
+    "patches"
+  ],
+  "scripts": {
+    "dev": "bun run --watch src/cli/entry.ts",
+    "start": "bun src/cli/entry.ts",
+    "build": "bun run scripts/build.ts",
+    "build:all": "bun run scripts/build.ts --all",
+    "desktop:view:build": "bun run scripts/build-electrobun-view.ts",
+    "web:build": "bun run scripts/build-web.ts",
+    "web:audit": "bun run web:build && bun run scripts/audit-web-bundle.ts",
+    "cloudflare:dry-run": "bun run web:build && wrangler deploy --dry-run --env production",
+    "desktop:dev": "bun run scripts/electrobun-dev.ts",
+    "desktop:build": "electrobun build",
+    "desktop:release": "electrobun build --env=stable",
+    "desktop:release:windows": "electrobun build --env=stable --targets=win-x64",
+    "docs:snapshot": "bun run scripts/update-docs-snapshot.ts",
+    "plugins:manifest": "bun run scripts/generate-plugin-manifest.ts",
+    "plugins:manifest:check": "bun run scripts/generate-plugin-manifest.ts --check",
+    "plugins:registry:check": "bun run scripts/check-registry-plugins.ts",
+    "web:proxy-hosts": "bun run scripts/generate-web-proxy-hosts.ts",
+    "map:data": "bun run scripts/generate-world-map-data.ts",
+    "glyphs:terminal": "bun run scripts/generate-terminal-glyphs.ts",
+    "macro-releases:update": "bun run scripts/update-macro-releases.ts",
+    "web:proxy-hosts:check": "bun run scripts/generate-web-proxy-hosts.ts --check",
+    "typecheck": "bun run typecheck:opentui && bun run typecheck:dom && bun run typecheck:cloudflare && bun run typecheck:scripts && bun run typecheck:plugin-tests",
+    "typecheck:opentui": "tsc --project tsconfig.opentui.json",
+    "typecheck:dom": "tsc --project tsconfig.dom.json",
+    "typecheck:cloudflare": "tsc --project tsconfig.cloudflare.json",
+    "typecheck:scripts": "tsc --project tsconfig.scripts.json",
+    "typecheck:plugin-tests": "tsc --project tsconfig.plugin-tests.json",
+    "knip": "bunx knip@6.39.0",
+    "test": "bun test",
+    "benchmark:tui:navigation": "bun run scripts/benchmark-tui-navigation.ts",
+    "benchmark:tui:compare": "bun run scripts/benchmark-tui-compare.ts",
+    "benchmark:tui:memory": "bun run scripts/benchmark-tui-memory.ts",
+    "benchmark:startup": "bun run scripts/benchmark-startup.ts",
+    "check:pane-chrome": "bun run scripts/pane-chrome/checks.ts",
+    "check:chat-mentions": "bun scripts/pane-chrome/chat-mentions.ts",
+    "check:pane-screenshot": "bun run scripts/pane-chrome/screenshot.ts",
+    "check:pane-rest": "bun run scripts/pane-chrome/rest-diff.ts",
+    "check:pane-layout": "bun run scripts/pane-chrome/layout-sweep.ts",
+    "check:ui-tokens": "bun run scripts/pane-chrome/ui-tokens.ts",
+    "ui:benchmark": "bun run scripts/pane-chrome/ui-benchmark.ts",
+    "audit:ui": "bun run scripts/pane-chrome/ui-audit.ts",
+    "check:call-player": "bun run scripts/pane-chrome/call-player.ts",
+    "check:chart-axis-zoom": "bun run scripts/pane-chrome/chart-axis-zoom.ts",
+    "check:chart-panel-layout": "bun run scripts/pane-chrome/chart-panel-layout.ts",
+    "kit:page": "bun run scripts/pane-chrome/kit-page.ts",
+    "audit:ui:compare": "bun run scripts/pane-chrome/ui-audit-compare.ts",
+    "benchmark:pane-drag:compare": "bun run scripts/pane-chrome/frame-budget.ts",
+    "test:global-upgrade": "bun run scripts/smoke-global-upgrade.ts",
+    "release": "./scripts/release.sh"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gloom-sh/gloomberb"
+  },
+  "keywords": [
+    "terminal",
+    "tui",
+    "stocks",
+    "portfolio",
+    "finance"
+  ],
+  "devDependencies": {
+    "@types/bun": "^1.3.14",
+    "@types/react-dom": "^19.2.3",
+    "@types/three": "0.165.0",
+    "electrobun": "^1.18.1",
+    "gloom-polls": "github:gloom-sh/gloom-polls",
+    "gloom-prediction-markets": "github:gloom-sh/gloom-prediction-markets",
+    "happy-dom": "^20.11.1",
+    "playwright-core": "1.60.0",
+    "png-to-ico": "^2.1.8",
+    "rcedit": "^4.0.1",
+    "typescript": "^5.9.2",
+    "wrangler": "^4.0.0"
+  },
+  "dependencies": {
+    "@opentui/core": "^0.3.2",
+    "@opentui/react": "^0.3.2",
+    "@tanstack/react-virtual": "^3.14.2",
+    "hls.js": "1.6.13",
+    "jimp": "1.6.1",
+    "qrcode-generator": "^2.0.4",
+    "react": "19.2.7",
+    "react-dom": "19.2.7",
+    "web-tree-sitter": "0.25.10"
+  },
+  "patchedDependencies": {
+    "@opentui/core@0.3.2": "patches/@opentui%2Fcore@0.3.2.patch",
+    "electrobun@1.18.1": "patches/electrobun@1.18.1.patch",
+    "react-reconciler@0.33.0": "patches/react-reconciler@0.33.0.patch"
+  }
+}