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.
26 lines
1,022 B
Markdown
26 lines
1,022 B
Markdown
# Configuration
|
|
|
|
On first run, `portfolio_rs` creates a default config file.
|
|
`portfolio_rs config` shows its location.
|
|
|
|
- `portfolio_file`: the **absolute** path to your data file, used when no file
|
|
is given as an argument.
|
|
- `workspace_dir`: your workspace, for workspace users. The workspace's
|
|
`positions.json` then takes precedence.
|
|
- `currency`: the base currency for totals (default `EUR`). See
|
|
[Quotes, currencies and returns](quotes.md#base-currency).
|
|
- `llm_api_key`: a write-only secret. The `AppConfigDto` JSON view used by GUIs
|
|
always serializes it as `null` and exposes `hasLlmApiKey` instead. To clear a
|
|
stored key, set it to an empty string. A null or omitted key on an update
|
|
does not wipe it.
|
|
|
|
## GPG encryption
|
|
|
|
Portfolio files can be gpg-encrypted JSON. Decrypted values are never written
|
|
to disk.
|
|
|
|
# you will need a valid gpg key in ~/.gnupg/
|
|
portfolio_rs [COMMAND] data.json.gpg
|
|
|
|
Pro tip: use a plugin like [vim-gnupg](https://github.com/jamessan/vim-gnupg)
|
|
to edit your data file.
|