What is it?
What it is
A minimal real-time market dashboard that runs in the terminal, displaying crypto, stocks, and ETFs with trend charts and key metrics.
Why it exists
To give developers and traders a lightweight, CLI-based tool for monitoring market data without leaving the terminal, incorporating caching and rate‑limit handling to reduce API errors.
Who should use it
Traders, investors, developers, and tech-savvy users who need a real-time market dashboard in their terminal for tracking crypto, stocks, and ETFs.
Who should avoid it
Users preferring GUI-based tools, those without Node.js installed, or individuals needing advanced customization beyond basic configuration.
How it works
A quick walkthrough in plain English
How stonks-dashboard works
Step 1 of 3
You interact with it
Open stonks-dashboard, send a request, or connect it to your stack.
Features
Advantages
- Minimal and lightweight terminal dashboard
- Zero‑setup quick start with npx or global npm install
- MIT license allows free use and modification
- Built‑in caching reduces API calls and avoids rate limits
- Customizable watchlist and update interval
- Real‑time data with multiple time‑frame charts
- Easy to extend or modify as open‑source JavaScript project
- Works on any system with Node.js LTS
Disadvantages
- Terminal‑only interface; no GUI or web version
- Requires Node.js installed
- Relies on third‑party APIs (CoinGecko, Yahoo Finance) which may change or impose limits
- Limited to predefined chart periods; no custom date ranges
- No built‑in alerting or notification features
- Configuration requires editing JSON file; no command‑line options for quick changes
- May not support all exchanges or instruments beyond those covered by the APIs
Installation
native
git clone https://github.com/pierridotite/stonks-dashboard.git cd stonks-dashboard npm install npm start
FAQ
How do I install Stonks Dashboard?
Use `npx stonks-dashboard` or install globally with `npm install -g stonks-dashboard`.
How can I customize the watchlist?
Edit `config.json` to add/remove tickers and crypto IDs.
What data sources does it use?
Crypto data from CoinGecko API and stocks/ETFs from Yahoo Finance API.
How do I add stocks from the London Stock Exchange?
Append `.L` to the ticker symbol (e.g., BARC.L).
How often is data cached?
Crypto details cache for ~30 minutes, price series for ~1 minute.
What are the system requirements?
Node.js LTS is required.
Featured in Videos
YouTube tutorials and walkthroughs for stonks-dashboard
Alternatives
Similar projects ranked by category, topics, and text overlap.
