lobo/zfin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

some readme cleanup

Browse source
This commit is contained in:
Emil Lerch 2026-03-01 12:11:40 -08:00
parent b510a86b09
commit 9d86ccf2e5
Signed by: lobo
GPG key ID: A7B62D657EF764F8
1 changed files with 52 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
README.md
View file

@ -121,15 +121,15 @@ Every data fetch follows the same pattern:
Cache files use [SRF](https://github.com/lobo/srf) (Simple Record Format), a line-oriented key-value format. Freshness is determined by file modification time vs. the TTL for that data type. Cache files use [SRF](https://github.com/lobo/srf) (Simple Record Format), a line-oriented key-value format. Freshness is determined by file modification time vs. the TTL for that data type.
| Data type | TTL | Rationale | | Data type | TTL | Rationale |
|---------------|--------------|-------------------------------------------------| |---------------|--------------|--------------------------------------------------|
| Daily candles | 24 hours | Only changes once per trading day | | Daily candles | 24 hours | Only changes once per trading day |
| Dividends | 7 days | Declared well in advance | | Dividends | 7 days | Declared well in advance |
| Splits | 7 days | Rare corporate events | | Splits | 7 days | Rare corporate events |
| Options | 1 hour | Prices change continuously during market hours | | Options | 1 hour | Prices change continuously during market hours |
| Earnings | 24 hours | Quarterly events, estimates update periodically | | Earnings | 24 hours | Quarterly events, estimates update periodically |
| ETF profiles | 30 days | Holdings/weights change slowly | | ETF profiles | 30 days | Holdings/weights change slowly |
| Quotes | Never cached | Intended for live price checks | | Quotes | Never cached | Intended for live price checks |
Manual refresh (`r` / `F5` in TUI) invalidates the cache for the current tab's data before re-fetching. Manual refresh (`r` / `F5` in TUI) invalidates the cache for the current tab's data before re-fetching.
@ -210,35 +210,35 @@ zfin i --default-keys > ~/.config/zfin/keys.srf
Default keybindings: Default keybindings:
| Key | Action | | Key | Action |
|---|---| |------------------------|------------------------------------------------------|
| `q`, `Ctrl+c` | Quit | | `q`, `Ctrl+c` | Quit |
| `r`, `F5` | Refresh current tab (invalidates cache) | | `r`, `F5` | Refresh current tab (invalidates cache) |
| `R` | Reload portfolio from disk (no network) | | `R` | Reload portfolio from disk (no network) |
| `h`, Left | Previous tab | | `h`, Left, Shift+Tab | Previous tab |
| `l`, Right, Tab | Next tab | | `l`, Right, Tab | Next tab |
| `1`-`6` | Jump to tab | | `1`-`6` | Jump to tab |
| `j`, Down | Select next row | | `j`, Down | Select next row |
| `k`, Up | Select previous row | | `k`, Up | Select previous row |
| `Enter` | Expand/collapse (positions, expirations, calls/puts) | | `Enter` | Expand/collapse (positions, expirations, calls/puts) |
| `s` | Select symbol from portfolio for other tabs | | `s` | Select symbol from portfolio for other tabs |
| `/` | Enter symbol search | | `/` | Enter symbol search |
| `e` | Edit portfolio/watchlist in `$EDITOR` | | `e` | Edit portfolio/watchlist in `$EDITOR` |
| `<` | Sort by previous column (portfolio tab) | | `<` | Sort by previous column (portfolio tab) |
| `>` | Sort by next column (portfolio tab) | | `>` | Sort by next column (portfolio tab) |
| `o` | Reverse sort direction (portfolio tab) | | `o` | Reverse sort direction (portfolio tab) |
| `[` | Previous chart timeframe (quote tab) | | `[` | Previous chart timeframe (quote tab) |
| `]` | Next chart timeframe (quote tab) | | `]` | Next chart timeframe (quote tab) |
| `c` | Toggle all calls collapsed/expanded (options tab) | | `c` | Toggle all calls collapsed/expanded (options tab) |
| `p` | Toggle all puts collapsed/expanded (options tab) | | `p` | Toggle all puts collapsed/expanded (options tab) |
| `Ctrl+1`-`Ctrl+9` | Set options near-the-money filter to +/- N strikes | | `Ctrl+1`-`Ctrl+9` | Set options near-the-money filter to +/- N strikes |
| `g` | Scroll to top | | `g` | Scroll to top |
| `G` | Scroll to bottom | | `G` | Scroll to bottom |
| `Ctrl+d` | Half-page down | | `Ctrl+d` | Half-page down |
| `Ctrl+u` | Half-page up | | `Ctrl+u` | Half-page up |
| `PageDown` | Page down | | `PageDown` | Page down |
| `PageUp` | Page up | | `PageUp` | Page up |
| `?` | Help screen | | `?` | Help screen |
Mouse: scroll wheel navigates, left-click selects rows and switches tabs, double-click expands/collapses. Mouse: scroll wheel navigates, left-click selects rows and switches tabs, double-click expands/collapses.
@ -426,20 +426,20 @@ account::HSA,tax_type::hsa
### Account fields ### Account fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
|---|---|---|---| |------------|--------|----------|-----------------------------------------------------------------|
| `account` | string | Yes | Account name (must match `account::` in portfolio lots exactly) | | `account` | string | Yes | Account name (must match `account::` in portfolio lots exactly) |
| `tax_type` | string | Yes | Tax classification (see below) | | `tax_type` | string | Yes | Tax classification (see below) |
### Tax types ### Tax types
| Value | Display label | | Value | Display label |
|---|---| |---------------|-----------------------|
| `taxable` | Taxable | | `taxable` | Taxable |
| `roth` | Roth (Post-Tax) | | `roth` | Roth (Post-Tax) |
| `traditional` | Traditional (Pre-Tax) | | `traditional` | Traditional (Pre-Tax) |
| `hsa` | HSA (Triple Tax-Free) | | `hsa` | HSA (Triple Tax-Free) |
| (other) | Shown as-is | | (other) | Shown as-is |
Accounts not listed in `accounts.srf` appear as "Unknown" in the tax type breakdown. Accounts not listed in `accounts.srf` appear as "Unknown" in the tax type breakdown.
@ -530,10 +530,10 @@ accounts.srf Account to tax type mapping for analysis
### Dependencies ### Dependencies
| Dependency | Source | Purpose | | Dependency | Source | Purpose |
|---|---|---| |----------------------------------------------------|---------------------|--------------------------------------------------|
| [SRF](https://github.com/lobo/srf) | Local (`../../srf`) | Cache file format and portfolio/watchlist parsing | | [SRF](https://github.com/lobo/srf) | Local (`../../srf`) | Cache file format and portfolio/watchlist parsing |
| [libvaxis](https://github.com/rockorager/libvaxis) | Git (v0.5.1) | Terminal UI rendering | | [libvaxis](https://github.com/rockorager/libvaxis) | Git (v0.5.1) | Terminal UI rendering |
## Building ## Building