{"id":49065631,"url":"https://github.com/aranair/pulse","last_synced_at":"2026-04-20T04:39:06.082Z","repository":{"id":342879084,"uuid":"1175418412","full_name":"aranair/pulse","owner":"aranair","description":"Vim-like Finance and Portfolio Tracker ","archived":false,"fork":false,"pushed_at":"2026-03-07T22:38:01.000Z","size":146,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-08T01:23:58.707Z","etag":null,"topics":["finance","investment","portfolio","rust","tracker","vim"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aranair.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-07T17:27:19.000Z","updated_at":"2026-03-07T22:38:04.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/aranair/pulse","commit_stats":null,"previous_names":["aranair/pulse"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/aranair/pulse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aranair%2Fpulse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aranair%2Fpulse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aranair%2Fpulse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aranair%2Fpulse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aranair","download_url":"https://codeload.github.com/aranair/pulse/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aranair%2Fpulse/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32032943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["finance","investment","portfolio","rust","tracker","vim"],"created_at":"2026-04-20T04:39:05.440Z","updated_at":"2026-04-20T04:39:06.065Z","avatar_url":"https://github.com/aranair.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pulse\n\nA local-first, keyboard-driven Rust TUI for portfolio tracking.\n\n`pulse` is an in-progress finance and investment tracker focused on:\n- stocks / ETFs\n- crypto spot\n- cash / FX balances\n- custom manual assets\n- SQLite-backed local persistence\n- ledger-first transaction tracking\n- projection-based positions, cash, and P\u0026L\n\n## Current status\n\nThis project is under active development. The current build already supports:\n- SQLite migrations and local database bootstrap\n- entities, accounts, and currency pockets\n- manual assets\n- deposits, withdrawals, fees, interest, dividends\n- buys and sells\n- transaction void / soft delete / revisions\n- cash transfers between accounts\n- FX conversion inside an account\n- manual quote entry\n- manual FX rate entry\n- projection-backed dashboard, positions, cash/FX, transactions, reports, and activity log screens\n\n## Tech stack\n\n- Rust\n- ratatui\n- crossterm\n- rusqlite\n- rust_decimal\n\n## Getting started\n\n### 1. Clone and enter the repo\n\n```bash\ngit clone \u003cyour-repo-url\u003e\ncd pulse\n```\n\n### 2. Optional: create a local config\n\nYou can run without a config file, but the easiest setup is:\n\n```bash\ncp pulse.example.toml pulse.toml\nmkdir -p data backups\n```\n\nThe example config stores the SQLite database at:\n\n- `./data/pulse.db`\n\n`pulse` looks for config in this order:\n1. `./pulse.toml`\n2. your default OS config directory\n3. built-in defaults\n\n### 3. Run the app\n\n```bash\ncargo run\n```\n\n### 4. Run tests\n\n```bash\ncargo test\n```\n\nOptional:\n\n```bash\ncargo check\n```\n\n## Basic usage\n\nWhen the TUI opens:\n- `?` toggle help\n- `:` enter command mode\n- `q` quit\n- `r` rebuild projections + reload\n\nCommand mode supports both direct commands and bare-command forms:\n- type a full command like `:buy 1 AAPL 2 185.50 CAD 0 \"starter position\"`\n- or type a bare command like `:buy`, `:sell`, or `:deposit` to open a modal form\n- inside forms, use `Tab` or arrow keys to move, type to edit, `Enter` to submit, and `Esc` to cancel\n- use `:help \u003ccommand\u003e` or `:\u003ccommand\u003e help` for command-specific usage\n\nNavigation:\n- `gd` dashboard\n- `ge` entities\n- `ga` accounts\n- `gp` positions\n- `gt` transactions\n- `gx` cash / FX\n- `gr` reports\n- `gs` settings\n- `gl` activity log\n\n## Quick smoke test\n\nPaste these commands one by one in command mode:\n\n```text\n:entity new \"Personal\" person CAD\n:account new 1 \"Brokerage\" Taxable CAD \"Manual\"\n:pocket new 1 CAD \"Main CAD\" default\n:pocket new 1 USD \"USD Pocket\"\n:asset new AAPL USD equity \"Apple Inc\"\n:deposit 1 CAD 1000 \"initial funding\"\n:fx 1 CAD 200 USD 150 2 \"convert cash\"\n:buy 1 AAPL 2 185 CAD 0 \"starter position\"\n:price AAPL USD 210.50 \"manual mark\"\n:fxrate USD CAD 1.35\n```\n\nThen inspect:\n- `gp` for positions\n- `gx` for cash / FX balances\n- `gr` for valuation-backed report totals\n\n## Supported commands\n\nYou can either enter the full command directly, or type a bare command keyword to open a form for many workflows.\n\nExamples:\n- `:buy` opens a buy form\n- `:sell` opens a sell form\n- `:deposit` opens a deposit form\n- `:account` opens an account-creation form\n- `:help buy` or `:buy help` shows command-specific help\n\n### Setup\n\n```text\n:entity new \u003cname\u003e [person|household|corporation|trust|custom] [reporting_currency]\n:account new \u003centity_id\u003e \u003cname\u003e [AccountType] [reporting_currency] [Institution]\n:pocket new \u003caccount_id\u003e \u003ccurrency\u003e [Label] [default]\n:asset new \u003cticker\u003e [quote_currency] [asset_type] [Name]\n```\n\n### Market data\n\n```text\n:price \u003cticker\u003e \u003ccurrency\u003e \u003cprice\u003e [note]\n:fxrate \u003cbase_currency\u003e \u003cquote_currency\u003e \u003crate\u003e\n```\n\n### Cash flows\n\n```text\n:deposit \u003caccount_id\u003e \u003ccurrency\u003e \u003camount\u003e [note]\n:withdraw \u003caccount_id\u003e \u003ccurrency\u003e \u003camount\u003e [note]\n:fee \u003caccount_id\u003e \u003ccurrency\u003e \u003camount\u003e [note]\n:interest \u003caccount_id\u003e \u003ccurrency\u003e \u003camount\u003e [note]\n:dividend \u003caccount_id\u003e \u003cticker\u003e \u003ccurrency\u003e \u003camount\u003e [note]\n:transfer \u003cfrom_account_id\u003e \u003cto_account_id\u003e \u003ccurrency\u003e \u003camount\u003e [note]\n:fx \u003caccount_id\u003e \u003cfrom_currency\u003e \u003cfrom_amount\u003e \u003cto_currency\u003e \u003cto_amount\u003e [fee] [note]\n```\n\n### Trading\n\n```text\n:buy \u003caccount_id\u003e \u003cticker\u003e \u003cqty\u003e \u003cunit_price\u003e \u003csettlement_currency\u003e [fee] [note]\n:sell \u003caccount_id\u003e \u003cticker\u003e \u003cqty\u003e \u003cunit_price\u003e \u003csettlement_currency\u003e [fee] [note]\n```\n\n### Transaction lifecycle\n\n```text\n:void \u003ctransaction_id\u003e [reason]\n:delete \u003ctransaction_id\u003e [reason]\n:revisions \u003ctransaction_id\u003e\n:help\n```\n\n## Project principles\n\n- local-first\n- ledger-first\n- transactions are the source of truth\n- projection tables are derived and rebuildable\n- weighted average cost basis for v1\n- offline-friendly behavior with cached/manual market data\n\n## Roadmap highlights\n\nPlanned or incomplete areas include:\n- provider-backed quote / FX refresh\n- richer revision inspection UI\n- benchmark tracking\n- broader reporting\n- transaction edit flows\n- import/export improvements\n\n## Development notes\n\nProject notes and planning artifacts live in:\n- `notes/`\n\nExample config:\n- `pulse.example.toml`\n\n## License\n\nSee `LICENSE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faranair%2Fpulse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faranair%2Fpulse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faranair%2Fpulse/lists"}