HomeDocsRepository
Documentation

Install it. Run it.
Learn the keys.

ApeTerm is a terminal app, not a web dashboard. There's no account. Everything below is what you'll actually type or press.

macOS · Apple Silicon Linux · x86_64 Windows · x86_64
01

Install

One script puts apeterm on your PATH, installs the runtime under ~/.local/share/apeterm, and sets up the private Python runtime used for streaming quotes.

$curl -fsSL https://github.com/LongdeLao/apeterm/raw/master/install.sh | bash

On Windows, download apeterm-x86_64-pc-windows-msvc.zip from GitHub Releases and put apeterm.exe somewhere on your PATH.

02

First run

Launch it. If your shell hasn't picked up the new PATH, open a fresh terminal window. You land on the dashboard with News, Watchlist, Calendar and Notes.

$apeterm
03

CLI

Beyond the interactive terminal, a few subcommands run outside the TUI.

apeterm sec-sync
Sync SEC EDGAR entities (13F, Form 4, congress) into the local DB.
apeterm update
Pull the latest release and replace the installed binary.
apeterm --check-locales
Validate the bundled en / de translation files.
04

Keys

Vim-style motions throughout. No command palette — just single keys.

j / kmove selection
h / vsplit focused panel
Ctrl + h/j/k/lresize panel
aopen the agent
/open search
,open settings
gtoggle en / de
wadd symbol to watchlist
?show help
05

Config

A single config.json in your platform's app-config directory holds watchlists, provider keys and preferences. Delete it to reset.

06

Providers

Open settings with ,, or set these environment variables before launch:

  • APETERM_FINNHUB_API_KEYFinnhub — deeper fundamentals
  • APETERM_FMP_API_KEYFMP — financial statements
  • OPENROUTER_API_KEYAgent — model of your choice
07

FAQ

Where does my data live?

A single SQLite file on your machine, alongside config.json. Nothing is synced unless you turn it on.

Is telemetry on by default?

No.

Windows?

Yes. Download the Windows x86_64 zip from GitHub Releases.

Found something wrong? File an issue.