mirror of
https://github.com/MarkusZoppelt/portfolio_rs.git
synced 2026-11-22 12:22:56 +01:00
The README had grown to ~600 lines, mostly MCP and HTTP API reference. It now keeps the pitch, installation, quick start, a short TUI section, the command table and an index of docs/. The reference material moved to docs/ (tui, agents, mcp, http-api, library, quotes, configuration), and the MCP docs test now checks docs/mcp.md. The TUI screenshots and the CLI demo gif were outdated and are removed; img/ is excluded from the published crate. Em-dashes are gone from the README, the new docs and the crate description.
1.9 KiB
1.9 KiB
TUI
The interactive Terminal User Interface (default mode) provides:
- Overview & Allocation Tab: Large display of total portfolio value, visual bar chart, and detailed allocation breakdown
- Balances Tab: Detailed table of all positions with amounts, current values, and edit functionality
Customization
You may optionally specify which tab to open at start-up:
portfolio_rs [JSON_FILE] --tab overview # Start on Overview & Allocation tab (default)
portfolio_rs [JSON_FILE] --tab balances # Start on Balances tab
You can disable specific UI components using the --disable flag with comma-separated component names:
Overview Tab Components:
tab_bar- Top navigation tabstotal_value- Large portfolio value displayasset_allocation- Visual bar chartdetailed_allocation- Allocation percentage listhelp- Help text at bottom
Balances Tab Components:
tab_bar- Top navigation tabsname- Position name columnasset_class- Asset class columnamount- Amount/quantity columnbalance- Balance/value column
Examples:
# Hide tab bar and help text
portfolio_rs --disable tab_bar,help example_data.json
# Show only the allocation chart (hide detailed list)
portfolio_rs --disable detailed_allocation example_data.json
# Minimal balances view (name and balance only)
portfolio_rs --disable asset_class,amount example_data.json
Navigation
h/l: Switch tabs left/right (vim-style)j/k: Navigate up/down (select positions in Balances tab)e: Edit selected position amount (in Balances tab)Tab/←→: Switch between tabs1-2: Jump directly to specific tabsq/Esc: Quit the application
Editing
- Select any position with
j/kand presseto edit - Real-time balance preview and input validation
- Changes are saved automatically to your data file
- Supports decimal precision for crypto and fractional shares