Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/open-source-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- 'plugins/**'
- 'omarchy/**'
- 'raycast/**'
- 'metrix/**'
- 'Makefile'
- '.github/workflows/open-source-checks.yml'
push:
Expand All @@ -20,6 +21,7 @@ on:
- 'plugins/**'
- 'omarchy/**'
- 'raycast/**'
- 'metrix/**'
- 'Makefile'
- '.github/workflows/open-source-checks.yml'

Expand Down Expand Up @@ -65,8 +67,8 @@ jobs:
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
with:
node-version: '24'
- name: Test the Herdr mod and the opencode plugin (shared quote code)
run: make test-herdr test-opencode
- name: Test the Herdr mod, the opencode plugin (shared quote code) and the Metrix.Bar dashboard
run: make test-herdr test-opencode test-metrix
- name: Build the opencode plugin
working-directory: opencode
run: npm ci --no-audit --no-fund && npm run build
Expand Down
4 changes: 2 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Pulse public repository

This repository hosts Pulse for Omarchy, Pulse for Claude Code, Pulse for opencode, Pulse for Herdr and Pulse for Raycast. Current
This repository hosts Pulse for Omarchy, Pulse for Claude Code, Pulse for opencode, Pulse for Herdr, Pulse for Raycast and Pulse for Metrix.Bar. Current
commercial Mac and website source belongs in the private Pulse repository.

- Keep `omarchy`, `plugins/claude-code`, `opencode`, `herdr` and `raycast` independent; follow their
- Keep `omarchy`, `plugins/claude-code`, `opencode`, `herdr`, `raycast` and `metrix` independent; follow their
scoped AGENTS.md instructions (Raycast's live in docs/raycast.md, since the
Store ships everything in raycast/) and run checks appropriate to the changed edition.
- Do not restore current Mac source, website source, signing material, private
Expand Down
7 changes: 5 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.PHONY: test test-claude test-omarchy test-herdr test-opencode test-raycast validate
.PHONY: test test-claude test-omarchy test-herdr test-opencode test-raycast test-metrix validate

test: test-claude test-omarchy test-herdr test-opencode test-raycast
test: test-claude test-omarchy test-herdr test-opencode test-raycast test-metrix

test-claude:
claude plugin validate plugins/claude-code
Expand All @@ -16,6 +16,9 @@ test-herdr:
test-opencode:
node --test opencode/tests/*.test.mjs

test-metrix:
node --test metrix/tests/*.test.mjs

test-raycast:
cd raycast && npm ci && npm test && npm run lint && npm run build && npm run typecheck

Expand Down
91 changes: 72 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,29 @@

[Website](https://www.pulseticker.app/) · [Mac App Store](https://apps.apple.com/app/id6812160110) · [Feedback](https://github.com/fatwang2/Pulse/issues)

Pulse is available for Mac, Claude Code, opencode, Herdr, and Omarchy. The Mac app is closed source;
this repository maintains the MIT-licensed Claude Code plugin, opencode plugin, Herdr mod and Omarchy edition.

| Edition | Source | Get started |
| --- | --- | --- |
| **Pulse for Mac** | Closed source | [Website and downloads](https://www.pulseticker.app/) · [Mac App Store](https://apps.apple.com/app/id6812160110) |
| **Pulse MCP** | Built into Pulse for Mac (docs only) | [Tools and client setup](mcp/README.md) |
| **Pulse for Claude Code** | Open-source plugin, MIT | [Installation and commands](plugins/claude-code/README.md) |
| **Pulse for opencode** | Open-source plugin, MIT | [Installation and commands](opencode/README.md) |
| **Pulse for Herdr** | Open-source mod and layout, MIT | [Installation and features](herdr/README.md) |
| **Pulse for Omarchy** | Open source, MIT | [Installation and features](omarchy/README.md) |
Pulse keeps stock, index and crypto prices where you already are: the macOS
menu bar, your AI coding tools, your terminal and your desktop bar.
**Pulse for Mac** is the full app, closed source. This repository holds the
free, MIT-licensed editions for other tools, and the documentation for the MCP
server built into Pulse for Mac.

## Editions

| Edition | Runs in | What it does | Status | Get started |
| --- | --- | --- | --- | --- |
| **Pulse for Mac** | macOS menu bar | Named watchlists, intraday and candlestick charts, positions and P&L, MCP server | Closed source, paid, 30-day free trial | [Website](https://www.pulseticker.app/) · [App Store](https://apps.apple.com/app/id6812160110) |
| **Pulse MCP** | Pulse for Mac | Quotes, symbol search, watchlists and positions for AI agents | Built into Pulse for Mac (docs only) | [Guide](mcp/README.md) |
| **Pulse for Claude Code** | Claude Code, Claude Desktop's Code tab | Prices above the prompt, `/pulse` panel to manage tickers | Open source, MIT | [Guide](plugins/claude-code/README.md) |
| **Pulse for opencode** | opencode | Sidebar watchlist with today's line and a detail view, quote band | Open source, MIT, on npm | [Guide](opencode/README.md) |
| **Pulse for Herdr** | Herdr | Watchlist docked beside your agents, with a detail view | Open source, MIT | [Guide](herdr/README.md) |
| **Pulse for Metrix.Bar** | Metrix.Bar menu bar | Ticker in the menu bar, watchlist with search and a detail view | Open source, MIT | [Guide](metrix/README.md) |
| **Pulse for Omarchy** | Omarchy 4 bar (Linux) | Prices in the bar, named watchlists, search, charts | Open source, MIT | [Guide](omarchy/README.md) |
| **Pulse for Raycast** | Raycast | Search any symbol by ticker or name, with its price and today's chart | Open source, MIT, in Raycast Store review | [Guide](raycast/README.md) |

The open-source editions need no account or API key. Stocks and indices come
from Yahoo Finance and crypto pairs from Binance's public Spot data; each
guide describes its edition's data sources, storage and privacy.
Positions, P&L and the MCP server are only in Pulse for Mac.

## Pulse for Mac

Expand Down Expand Up @@ -49,9 +61,8 @@ free installers remain available. See [historical Mac source and downloads](docs

A Claude Code plugin that shows stock and crypto quotes with signed percentage
changes above the prompt, with a `/pulse` panel for adding and removing tickers,
refreshing prices, and pausing updates. Stocks and indices come from Yahoo
Finance and crypto pairs from Binance's public Spot data. Requires Claude Code
**2.1.287 or later**, with Mods enabled.
refreshing prices, and pausing updates. Requires Claude Code **2.1.287 or
later**, with Mods enabled.

![Pulse for Claude Code showing stock and crypto prices above the prompt](assets/readme/pulse-claude-code.png)

Expand Down Expand Up @@ -107,6 +118,26 @@ Read ~/.config/herdr-app/AGENTS.md, then add this layout: https://github.com/fat

See the [Herdr guide](herdr/README.md) for the mod on its own, usage and privacy.

## Pulse for Metrix.Bar

A [Metrix.Bar](https://metrix.bar) dashboard: your first ticker in the menu
bar, and a panel with your watchlist, today's line on every row and a detail
view with the day's chart, open, high, low and previous close. Press **+** to
search by ticker or company name in English, Chinese, Japanese or Korean;
right-click a row to reorder or remove it.

<img src="metrix/preview.png" alt="Pulse for Metrix.Bar panel" width="340">

With [Metrix.Bar](https://metrix.bar/download) running, run this in Terminal
(or open the link in a browser), then confirm in Metrix.Bar:

```sh
open "metrixbar://install/pulse?registry_url=https%3A%2F%2Fraw.githubusercontent.com%2Ffatwang2%2FPulse%2Fmain%2Fmetrix%2Findex.json"
```

Installed this way, Metrix.Bar offers new versions as they are published here.
See the [Metrix.Bar guide](metrix/README.md) for usage, settings and privacy.

## Pulse for Omarchy

An independent Pulse edition for Omarchy, with market data in the bar, named
Expand All @@ -126,17 +157,39 @@ The implementation is maintained in [`omarchy/`](omarchy/README.md).
See the [Omarchy guide](omarchy/README.md) for features and local development,
and [repository transition notes](docs/repository-transition.md) for migration details.

## Pulse for Raycast

A [Raycast](https://www.raycast.com) extension with one command, **Search
Symbol**: look up any stock, ETF, index or crypto pair by ticker or by its name
in English, Chinese, Japanese or Korean, and see its price, change and today's
chart. Search runs on your Mac over Pulse's symbol list.

The extension is in review for the Raycast Store
([raycast/extensions#33098](https://github.com/raycast/extensions/pull/33098)).
Until it is listed, run it from this repository with Raycast and Node.js
installed ([development notes](docs/raycast.md)):

```sh
cd raycast
npm install
npm run dev
```

See the [Raycast guide](raycast/README.md) for markets, search and privacy.

## Contributing and feedback

Start with [CONTRIBUTING.md](CONTRIBUTING.md). Each open-source edition has its
own implementation and tests; development does not require building the Mac app.
own folder, implementation and tests; development does not require building the
Mac app. `make test` runs every edition's checks.
Use [GitHub Issues](https://github.com/fatwang2/Pulse/issues) and identify the edition.
Mac support is also available at [hello@pulseticker.app](mailto:hello@pulseticker.app).
Report security issues privately to [sys@pulseticker.app](mailto:sys@pulseticker.app).

## License

The Omarchy edition and Claude Code plugin retain their [MIT license](LICENSE)
and any component notices. That license does not apply to the current commercial
Mac binaries or provide rights to third-party market data. Historical Mac source
retains its original license.
The open-source editions (`plugins/claude-code`, `opencode`, `herdr`, `metrix`,
`omarchy` and `raycast`) are released under the [MIT license](LICENSE), with any
component notices in their folders. That license does not apply to the current
commercial Mac binaries or provide rights to third-party market data. Historical
Mac source retains its original license.
28 changes: 28 additions & 0 deletions metrix/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Pulse for Metrix.Bar

- One `.bar` file (`pulse.bar`, Metrix.Bar protocol 0) and its registry entry
(`index.json`). Follow Metrix.Bar's docs (https://metrix.bar/docs/llms.txt):
the .bar format, components and local API. The Worker is plain JavaScript in
a CDATA block: no imports, no build step.
- `index.json` is generated by Metrix.Bar's `build.js` (see README) and carries
the SHA-256 of the exact `pulse.bar` bytes. Bump the `<bar version>` and
rebuild the index with every change to `pulse.bar`; a test checks they match.
The install link points at `main`, so what lands there ships.
- Validate every change with the app's `POST /v0/validate` and `POST /v0/check`
(fixtures and steps for the list, search, detail, light and dark, English and
Chinese) before claiming it works. Look at the screenshots. Fixtures are
limited to 2 MiB, so a check uses a trimmed catalog.
- The only hosts are `query1.finance.yahoo.com`, `data-api.binance.vision` and
`www.pulseticker.app` (the symbol catalog, at most once a day). Search runs
over that catalog on the user's computer: never send what they type to a
search API. Its ranking is ported from `raycast/src/lib/search.ts` (the Mac
app's SymbolSearchIndex); keep them in step. The only API beyond fetch is
`$metrix.openURL` on a Pulse link, on a click. Keep README, `<docs>` and code
in step on hosts, storage and behavior.
- Promote Pulse for Mac only (the footer link, the detail card, the tray menu,
the README); name no other edition. Links carry `utm_source=metrixbar`.
- Respect Yahoo cooldowns; never show cached data as fresh or an unknown delay
as real time. Crypto never waits on Yahoo.
- Sizes, colors and layout follow Pulse for Mac's watchlist within Metrix.Bar's
native components; the interface is English and Chinese.
- Never put a Metrix.Bar local API token in this repository, a fixture or a log.
93 changes: 93 additions & 0 deletions metrix/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Pulse for Metrix.Bar

A [Metrix.Bar](https://metrix.bar) dashboard from the makers of
[Pulse for Mac](https://www.pulseticker.app/?utm_source=metrixbar&utm_medium=readme):
a stock and crypto watchlist in your menu bar. Each ticker shows its price,
its change and today's line; click one for its day: a chart, the open, high,
low and previous close, and whether its market is open. Stocks and indices
come from Yahoo Finance, crypto pairs (`BTC/USDT`) from Binance's public Spot
data.

<img src="preview.png" alt="Pulse for Metrix.Bar: a watchlist with today's line for each ticker" width="340">

## Install

Install [Metrix.Bar](https://metrix.bar/download) and open it once. Then run
this in Terminal, or open the link in your browser:

```sh
open "metrixbar://install/pulse?registry_url=https%3A%2F%2Fraw.githubusercontent.com%2Ffatwang2%2FPulse%2Fmain%2Fmetrix%2Findex.json"
```

Metrix.Bar shows the hosts the dashboard contacts and its settings, and
installs it after you confirm. The link also adds this folder's
[`index.json`](index.json) as a dashboard source, so Metrix.Bar offers new
versions as they are published here.

An agent connected to Metrix.Bar's local API (its
[Agent Skill](https://metrix.bar/docs/agents)) can install
[`pulse.bar`](pulse.bar) for you instead. That copy is a local import and is
not offered updates.

Metrix.Bar's free plan holds a limited number of dashboards. If you are at the
limit, Pulse installs disabled until you remove one or upgrade.

## Use

- It starts with `AAPL`, `NVDA`, `^GSPC`, `0700.HK` and `BTC/USDT`. The first
ticker is shown in the menu bar, or choose **Pulse icon only** in the
dashboard's settings.
- **+** (or ⌘F) opens search: type a ticker or a company name in English,
Chinese, Japanese or Korean (`AAPL`, `Tencent`, `腾讯`, `600519`, `7203`,
`BTC`) and click **+**, or press Return for the top result. A full ticker
the search doesn't know (`GC=F`, `ETH/BTC`) can be added as typed. With the
field empty it lists your watchlist to reorder or remove.
- Right-click a row to move it to the top, up or down, or remove it.
- Click a ticker for its day; Esc goes back. ⌘R refreshes.
- Settings: **Starting watchlist** (editing it replaces the panel's list),
**Menu bar** and **Up / down colors** (green up or red up).

Quotes refresh every minute. Stock prices are Yahoo's regular-session quotes;
exchange delays vary and are shown when Yahoo reports them. Crypto changes and
lines are 24-hour. A quote from an earlier day carries its date. The interface
is in English or Chinese, following your system language; names follow it
too where the catalog has them.

Positions and P&L, US pre-market and after-hours charts, candlesticks from
5 minutes to monthly, a rotating menu bar ticker and named watchlists are in
[Pulse for Mac](https://www.pulseticker.app/?utm_source=metrixbar&utm_medium=readme),
free to try for 30 days.

## Privacy

The watchlist is saved in Metrix.Bar's storage for this dashboard on your
computer. Watching a ticker sends it to Yahoo Finance
(`query1.finance.yahoo.com`); watching a pair sends it to Binance
(`data-api.binance.vision`). Search runs on your computer over Pulse's symbol
catalog, downloaded from `www.pulseticker.app` when you first search (and at
start-up on a Chinese, Japanese or Korean system, for names) and at most once
a day after that; what you type is not sent anywhere. The dashboard contacts
no other host, reads no files and has no account or analytics. It opens
`https://www.pulseticker.app/` in your browser only when you click a Pulse
link, tagged `utm_source=metrixbar&utm_medium=dashboard` and `utm_content`
`footer`, `detail` or `menu`. See the
[Pulse privacy policy](https://www.pulseticker.app/privacy).

## Development

```sh
node --test metrix/tests/*.test.mjs
```

The tests check that `index.json` matches `pulse.bar` (its SHA-256 and
version), the declared hosts, and the Worker's symbol rules, search ranking
and price formatting. Rendering and live quotes need Metrix.Bar: validate and
preview a change with its local API (`POST /v0/validate` and
`POST /v0/check`), then rebuild the index:

```sh
curl -fsS https://metrix.bar/dashboards/build.js -o /tmp/build.js
mkdir -p /tmp/pulse-in && cp metrix/pulse.bar /tmp/pulse-in/
node /tmp/build.js --input /tmp/pulse-in --output /tmp/pulse-out --id pulse --name "Pulse"
cp /tmp/pulse-out/index.json metrix/index.json
```
27 changes: 27 additions & 0 deletions metrix/index.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"$schema": "https://metrix.bar/dashboards/schema.json",
"schema_version": 1,
"id": "pulse",
"name": "Pulse",
"dashboards": [
{
"id": "pulse",
"name": "Pulse for Metrix.Bar",
"protocol_version": "0",
"version": "1.0.0",
"category": "finance",
"placements": [
"menubar"
],
"open_mode": "flyout",
"window_style": "standard",
"description": "A lightweight edition of Pulse for Mac: a stock and crypto watchlist with intraday charts, from Yahoo Finance and Binance.",
"icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjEzNCAyMTUgNzU2IDU4MCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSJjdXJyZW50Q29sb3IiIHN0cm9rZS13aWR0aD0iNzIiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCI+PHBhdGggZD0iTTE3MCA1MTJIMjkyQzMxNiA1MTIgMzI4IDQ3NiAzNDggNDc2QzM3MSA0NzYgMzgzIDUzNyA0MDUgNTM3QzQyNSA1MzcgNDQ0IDQyMyA0OTMgMjc4QzUwMiAyNTEgNTIwIDI1MSA1MjkgMjgwTDYyNyA3MjhDNjM0IDc1OSA2NTQgNzU5IDY2NiA3MzBMNzM4IDUyMEM3NDQgNTAzIDc1NiA0OTggNzc0IDQ5OEg4NTQiLz48L3N2Zz4=",
"license": "MIT",
"homepage": "https://www.pulseticker.app/",
"docs": "Pulse for Metrix.Bar shows a watchlist of stocks, indices and crypto pairs with today's line for each, and a detail view with the day's chart, open, high, low and previous close.\n\nPress + in the panel to search by ticker or company name in English, Chinese, Japanese or Korean (AAPL, Tencent, 腾讯, 600519, BTC) and add to the watchlist. Search runs on your computer over Pulse's symbol catalog, downloaded from pulseticker.app at most once a day; what you type is not sent anywhere. Right-click a row to move it to the top, reorder it or remove it; the first one is shown in the menu bar. The watchlist is kept on your computer. The \"Starting watchlist\" setting takes Yahoo Finance tickers (AAPL, 0700.HK, 600519.SS, 7203.T, ^GSPC, GC=F) or Binance Spot pairs written BASE/QUOTE (BTC/USDT); editing it replaces the panel's list.\n\nQuotes refresh every minute and may be delayed by the exchange. Stocks come from Yahoo Finance, crypto from Binance's public Spot data. Pulse for Metrix.Bar is a free, lightweight edition. The full experience is Pulse for Mac: positions with today's and total P&L, US pre-market and after-hours charts, 5-minute to monthly candlesticks with volume, a rotating menu bar ticker, named watchlists, and a local MCP server for AI agents. Every feature is free to try for 30 days: https://www.pulseticker.app/",
"file": "pulse.bar",
"sha256": "f94afe95fc3906e10d303469f15d7f38904eff9af9b3ce8b0762f7d2ad0634f1"
}
]
}
Binary file added metrix/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading