<div align="center">
<img src="src/assets/gloomberb-logo.svg" alt="Gloom logo" width="76" />
# Gloom
**Open-source finance terminal. Fast, keyboard-driven, and extensible.**
<a href="#install"><strong>Install</strong></a>
·
<a href="https://gloom.sh/download/desktop"><strong>Desktop app</strong></a>
·
<a href="https://term.gloom.sh"><strong>Try it in the browser</strong></a>
·
<a href="https://gloom.sh/discord">Discord</a>
·
<a href="README.zh-CN.md">简体中文</a>
·
<a href="README.ja.md">日本語</a>
<br />
<br />
<img src="docs/assets/gloom-desktop.webp" alt="Gloom showing a chart, an options chain, company details and analyst ratings for NVDA." width="840" />
<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 and your portfolio in one workspace you drive from the keyboard. Type `DES AAPL` for company details or `GP NVDA` for a chart. It runs in your terminal (macOS, Linux, Windows), as a desktop app (macOS, Windows), and in the browser.
## Install
macOS or Linux:
```bash
curl -fsSL gloom.sh/install | bash
```
Windows, in PowerShell:
```powershell
irm https://gloom.sh/install.ps1 | iex
```
Or with [Bun](https://bun.sh), on any of them:
```bash
bun install -g @gloom-sh/terminal
```
`npm install -g @gloom-sh/terminal` works too, but the command runs on Bun, so install [Bun](https://bun.sh) first.
Then run `gloom` (`gloomberb`, its old name, still works). On Apple Silicon the script also installs the desktop app, Gloom.app. Homebrew, the Windows desktop installer and manual downloads are in the [installation guide](docs/installation.md).
Charts draw as images in Kitty-compatible terminals such as Ghostty, Kitty and WezTerm, and as text elsewhere.
## Start
Press `Ctrl+P` for the command bar, or `` ` `` to search for a ticker. `HELP` lists every command and shortcut, and the [function catalog](https://gloom.sh/docs/functions) shows them all.
From your shell, `gloom quote AAPL` prints a quote; add `--json` for scripts. The [user guide](docs/usage.md) covers charts, brokers, shortcuts and the CLI.
## Data and privacy
Free market data is delayed: quotes by 15 minutes, news by 12 hours. Pro adds real-time data. Market data and Ask Gloom come from [Gloom Cloud](https://gloom.sh/cloud), a hosted service that is not open source; the app itself is MIT licensed. See [what is open and what is not](docs/open-source.md).
Crash reports and usage counts can be turned off: [what is sent](docs/telemetry.md).
## Plugins and contributing
Plugins add panes, data sources, brokers and commands. Install one from GitHub with `gloom install gloom-sh/gloom-tv`, or build your own with the [plugin guide](PLUGINS.md#your-first-pane). To work on Gloom itself, clone it with `git clone --filter=blob:none https://github.com/gloom-sh/gloomberb.git` and read [CONTRIBUTING.md](CONTRIBUTING.md).
[MIT licensed](LICENSE). Built with [OpenTUI](https://opentui.com/). [Sponsor Gloom](https://gloom.sh/sponsor).