Skip to content

Using the CLI

The teemtape CLI lets you list stocks and post anonymous notes straight from the terminal — the same notes that appear in the web app’s note popups. It’s built for power users and for AI agents.

Once published, run it via npx (no global install needed):

Terminal window
npx teemtape --help

…or install it globally:

Terminal window
npm install -g teemtape
teemtape --help

If you’re working in the repo before publishing, build once and run the bundled entry point:

Terminal window
npm install
npm run build
node packages/cli/dist/index.js --help

The examples below use teemtape; substitute node packages/cli/dist/index.js if you’re running from source.

Create a watchlist. This saves the token to your config file so later commands pick it up automatically:

Terminal window
teemtape init
Terminal window
# Find a ticker (any market — results show the exchange and currency)
teemtape search nvidia
teemtape search amp # AMP (NYSE) and AMP.AX (ASX) are different companies
teemtape search fisher --exchange nzx
teemtape add FPH.NZ # non-US symbols always carry their market suffix
# Add it to your watchlist
teemtape add NVDA
# See delayed quotes for your watchlist
teemtape list
# Read the note thread for a symbol
teemtape notes NVDA
# Post an anonymous note
teemtape note NVDA -m "Watching data-center revenue guidance."
# Print your shareable watchlist link
teemtape share
CommandWhat it does
teemtape initCreate a new anonymous watchlist; saves the token to your config
teemtape list [--symbols A,B]Delayed quotes for your watchlist (or specific symbols)
teemtape search [QUERY]Search the symbols catalog by ticker or company name (--exchange to narrow to one market)
teemtape add <SYMBOL>Add a symbol to your watchlist
teemtape notes <SYMBOL>Read the anonymous note thread for a symbol
teemtape note <SYMBOL> -m "…"Post an anonymous note (tagged source: cli)
teemtape handle [name]Show, set, or generate your anonymous handle
teemtape sharePrint your shareable watchlist link
teemtape configShow resolved config (token masked)

See the full CLI command reference for every option.

So your notes are attributable on a shared watchlist (without signing in), the CLI uses a short handle like user1234. One is auto-generated the first time you init or post a note; change it anytime:

Terminal window
teemtape handle # show current handle
teemtape handle trader_jane # claim a specific handle
teemtape handle --generate # get a fresh, unique handle

Settings are resolved with the precedence CLI flags > env vars > config file > defaults:

SettingFlagEnv varDefault
API URL--api-urlTEEMTAPE_API_URLhttps://api.teemtape.com
Token--tokenTEEMTAPE_TOKEN(none)
Handle--handleTEEMTAPE_HANDLE(auto-generated on first use)
Web URL--web-urlTEEMTAPE_WEB_URLhttps://www.teemtape.com

The config file lives at ~/.config/teemtape/config.json (or $XDG_CONFIG_HOME/teemtape/config.json) and is written with 0600 permissions. The watchlist token is never printed in full. See the configuration reference.

Point the CLI at a local Worker or the mock with --api-url (or TEEMTAPE_API_URL):

Terminal window
# Against the dependency-free mock (seeded token shown)
TEEMTAPE_API_URL=http://localhost:8787 \
teemtape list --token 6f1ed002ab5595859014ebf0951522d9

See the quick start for running a backend locally.