stonks-cli 0.2.1

CLI tool for tracking investment portfolio

stonks-cli

Track your investment portfolio directly from the terminal.

Features

• terminal dashboard (TUI)
• tracks stock portfolio with live market prices including extended-hours quotes
• calculates a total portfolio value converted to USD and unrealized P&L
• Yahoo Finance integration (no API token required)
• open source (MIT licensed)

---

Installation

Requirements: Python 3.11+

pip install stonks-cli

Or with pipx (recommended -- keeps the tool isolated):

pipx install stonks-cli

Preparing configuration in YAML format

stonks-cli stores your portfolio in a YAML file. By default the file is read from ~/.config/stonks/portfolio.yaml; you can override this with the -p / --portfolio option (see Usage).

First run: if ~/.config/stonks/ contains no .yaml files, stonks-cli automatically creates a sample portfolio at ~/.config/stonks/portfolio.yaml so you can explore the dashboard right away. Replace its contents with your own positions whenever you are ready.

File structure

portfolio:
  positions:
    - symbol: AAPL
      quantity: 10
      avg_cost: 150.00
      currency: USD

    - symbol: ASML.AS
      quantity: 5
      avg_cost: 680.00
      currency: EUR

    - symbol: 7203.T
      quantity: 100
      avg_cost: 1850.00
      currency: JPY

  cash:
    - currency: USD
      amount: 4250.00

    - currency: EUR
      amount: 2100.00

Positions fields:

Field	Type	Required	Description
symbol	string	yes	Yahoo Finance ticker (case-insensitive)
quantity	int	yes	Shares held (positive integer)
avg_cost	float	yes	Average cost per share (positive)
currency	string	no	ISO 4217 code; defaults to USD

Cash fields:

Field	Type	Required	Description
currency	string	yes	ISO 4217 code (e.g. USD, EUR)
amount	float	yes	Cash held (positive)

The file is created and updated automatically when you use the add, remove, add-cash, and remove-cash commands, so you only need to create it manually if you prefer to seed your data by hand.

Ticker symbols and exchange suffixes

Yahoo Finance uses a dot-suffix convention to identify non-US exchanges. Append the appropriate suffix to the base ticker symbol.

Americas

Suffix	Exchange	Country
(none)	NYSE / NASDAQ / AMEX	USA
.SA	B3 (São Paulo)	Brazil
.BA	Buenos Aires Stock Exchange	Argentina
.MX	Bolsa Mexicana de Valores	Mexico
.SN	Santiago Stock Exchange	Chile
.LIM	Lima Stock Exchange	Peru

Canada

Suffix	Exchange	Country
.TO	Toronto Stock Exchange	Canada
.V	TSX Venture Exchange	Canada

Europe

Suffix	Exchange	Country
.L	London Stock Exchange	UK
.PA	Euronext Paris	France
.AS	Euronext Amsterdam	Netherlands
.BR	Euronext Brussels	Belgium
.LS	Euronext Lisbon	Portugal
.MI	Borsa Italiana	Italy
.DE	XETRA	Germany
.F	Frankfurt Stock Exchange	Germany
.SW	SIX Swiss Exchange	Switzerland
.ST	Nasdaq Stockholm	Sweden
.HE	Nasdaq Helsinki	Finland
.CO	Nasdaq Copenhagen	Denmark
.OL	Oslo Børs	Norway
.WA	Warsaw Stock Exchange	Poland
.AT	Athens Stock Exchange	Greece

Asia-Pacific

Suffix	Exchange	Country
.AX	Australian Securities Exchange	Australia
.NZ	New Zealand Exchange	New Zealand
.HK	Hong Kong Stock Exchange	Hong Kong
.T	Tokyo Stock Exchange	Japan
.KS	Korea Exchange (KOSPI)	South Korea
.KQ	KOSDAQ	South Korea
.TW	Taiwan Stock Exchange	Taiwan
.TWO	Taiwan OTC	Taiwan
.SS	Shanghai Stock Exchange	China
.SZ	Shenzhen Stock Exchange	China
.NS	National Stock Exchange	India
.BO	Bombay Stock Exchange	India
.JK	Indonesia Stock Exchange	Indonesia
.SI	Singapore Exchange	Singapore
.KL	Bursa Malaysia	Malaysia
.BK	Stock Exchange of Thailand	Thailand
.VN	Ho Chi Minh Stock Exchange	Vietnam

Examples

Symbol	Instrument
AAPL	Apple (NASDAQ)
ASML.AS	ASML (Euronext Amsterdam)
7203.T	Toyota (Tokyo SE)
HSBA.L	HSBC (London SE)
005930.KS	Samsung (KOSPI)
BTC-USD	Bitcoin / USD
ETH-EUR	Ethereum / EUR

---

Usage

stonks [OPTIONS] COMMAND [ARGS]...

Options:
  -p, --portfolio PATH  Portfolio YAML file
                        (default: ~/.config/stonks/portfolio.yaml)
  --help                Show this message and exit.

Commands:
  add         Add QUANTITY shares of SYMBOL at PRICE to the portfolio.
  remove      Remove QUANTITY shares of SYMBOL from the portfolio.
  add-cash    Add AMOUNT of CURRENCY cash to the portfolio.
  remove-cash Remove AMOUNT of CURRENCY cash from the portfolio.
  dashboard   Display the current portfolio with live prices and P&L.

Show the portfolio

Running stonks without a subcommand launches the dashboard automatically:

# Launch the TUI (dashboard is the default command)
stonks

# Equivalent -- explicit subcommand
stonks dashboard

# Refresh prices every 30 seconds
stonks dashboard --refresh 30

Add a position

# Add 10 shares of Apple at $150.00
stonks add AAPL 10 150.00

# Add a non-US stock (ASML on Euronext Amsterdam)
stonks add ASML.AS 5 680.00

# Use a custom portfolio file
stonks -p ~/my-portfolio.yaml add NVDA 2 800.00

When a symbol is added a second time, the quantity is increased and the average cost is recalculated as a weighted average automatically.

Remove a position

# Remove 5 shares (partial close)
stonks remove AAPL 5

# Remove all shares (position deleted)
stonks remove AAPL 10

Manage cash

# Deposit cash
stonks add-cash USD 5000.00
stonks add-cash EUR 2000.00

# Withdraw cash (partial)
stonks remove-cash USD 500.00

# Withdraw all remaining cash of a currency (position deleted)
stonks remove-cash EUR 2000.00

Cash is displayed in the dashboard below the stock positions and is included in the total portfolio value converted to the base currency.

The TUI displays a table with the following columns:

Column	Description
Instrument	Ticker symbol
Exchange	Exchange name derived from ticker suffix (e.g. NYSE/NASDAQ)
Qty	Number of shares held
Avg Cost	Average purchase price per share
Last Price	Most recent price from Yahoo Finance; tagged PRE / AH / CLS
Mkt Value	Current market value (Qty * Last Price)
Unrealized P&L	Profit/loss vs. average cost (green/red)

A Total (USD) line at the bottom converts all positions to USD using live forex rates and sums them up.

Press q to quit.

---

Running with Docker

Build the image

docker build -t stonks .

Run the container

docker run --rm -it \
  -v ./config/sample_portfolio.yaml:/data/portfolio.yaml:ro \
  stonks --portfolio /data/portfolio.yaml dashboard

The -v flag bind-mounts a local YAML file into the container. Replace ./config/sample_portfolio.yaml with the path to your own portfolio file. Drop :ro if you want add / remove commands to persist changes back to the host.

---

Market analysis

Looks bullish.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for development setup, coding style, commit message conventions, and the pull request workflow.

For the release process, see RELEASING.md.

---

License

MIT License. See LICENSE for details.