### Initialize a database with a currency Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Initializes the database with the specified currency. Use `cargo run --release --` for a quick start from a checkout. ```powershell cargo run --release -- init --currency USD ``` -------------------------------- ### Verify Helius installation on Linux Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Installation.md Run the installed binary to verify. ```bash ./helius --help ``` -------------------------------- ### Use the guided shell Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Starts the interactive guided shell. Supports shortcuts like account, income, expense, budget, reconcile, and recurring, and also accepts raw CLI commands. ```powershell helius shell ``` -------------------------------- ### Verify helius.exe starts with --help Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Installation Run the downloaded executable to confirm it launches. The output should show usage information. ```powershell .\helius.exe --help ``` -------------------------------- ### Build Helius Docker image Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Installation.md Build the Docker image for Helius. ```bash docker build -t helius . ``` -------------------------------- ### Run Helius in Docker with named volume Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Installation.md Create a named volume and start Helius interactively. Mounts /data for persistence. ```bash docker volume create helius-data docker run --rm -it -v helius-data:/data helius ``` -------------------------------- ### Open the TUI Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Launches the Helius terminal user interface. ```powershell helius ``` -------------------------------- ### Default database paths Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Shows the default database file locations for Windows and Unix-like systems. ```text %LOCALAPPDATA%\Helius\tracker.db ~/.local/share/helius/tracker.db ``` -------------------------------- ### Verify Helius installation on Windows Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Installation.md Run the installed command or the executable directly to verify. ```powershell helius --help ``` ```powershell .\helius.exe --help ``` -------------------------------- ### Useful commands Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Common commands for checking balance, listing transactions, listing presets, viewing monthly summary, listing recurring items, and showing forecast. ```powershell cargo run --release -- balance cargo run --release -- tx list --limit 20 cargo run --release -- import csv --list-presets cargo run --release -- summary month cargo run --release -- recurring list cargo run --release -- forecast show ``` -------------------------------- ### Binary output path Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Installation The compiled executable is located at this path after a release build. ```text target\release\helius.exe ``` -------------------------------- ### Pre-Migration Backup Example Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Data-and-Storage Example backup filename for a migration from version 7 to 8. ```text tracker.pre-v7-to-v8.20260318T142501.db ``` -------------------------------- ### Install from local checkout with cargo install --path . Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Installation Installs the helius binary from the current directory into the Cargo bin directory. ```powershell cargo install --path . ``` -------------------------------- ### Run tests and build release Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Development Common commands for testing and building the project in a Windows PowerShell environment. ```powershell cargo test cargo build --release ``` -------------------------------- ### Run Helius direct commands in Docker Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Installation.md Run non-interactive commands like balance or tx list in Docker. ```bash docker run --rm -v helius-data:/data helius balance docker run --rm -v helius-data:/data helius tx list --limit 20 ``` -------------------------------- ### Import a statement using presets Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Lists available presets, then performs a dry-run and actual import using the `revolut-csv` preset. The dry-run lets you preview changes without applying them. ```powershell cargo run --release -- import csv --list-presets cargo run --release -- import csv --input .\bank.csv --account Checking --preset revolut-csv --dry-run cargo run --release -- import csv --input .\bank.csv --account Checking --preset revolut-csv ``` -------------------------------- ### Install Helius on Windows via PowerShell Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md One-command installer for Windows that downloads the latest release, verifies its SHA-256 checksum, and installs `helius` into `%LOCALAPPDATA%\Programs\Helius`, adding that folder to the user `PATH`. Run the same command again to upgrade. ```powershell # Windows (PowerShell) irm https://raw.githubusercontent.com/Helius-Finance/helius-finance-tracker/main/install.ps1 | iex ``` -------------------------------- ### Run Docker smoke script Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Development.md Verifies Docker packaging separately. ```powershell ./scripts/docker-smoke.ps1 ``` -------------------------------- ### Override database path Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Uses the `--db` flag to specify a custom database file location. ```powershell cargo run --release -- --db .\tracker.db balance ``` -------------------------------- ### Install Helius on Linux via curl Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md One-command installer for Linux that downloads the latest release, verifies its SHA-256 checksum, and installs `helius` into `~/.local/bin`. Requires glibc 2.34 or newer; on older distributions or musl-based systems use Docker or build from source. Run the same command again to upgrade. ```bash # Linux curl -fsSL https://raw.githubusercontent.com/Helius-Finance/helius-finance-tracker/main/install.sh | sh ``` -------------------------------- ### Check the ledger Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Displays the balance, lists recent transactions, and shows a monthly summary. ```powershell helius balance helius tx list --limit 20 helius summary month 2026-03 ``` -------------------------------- ### Default Windows database path Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Shows the default Windows path where the Helius database is stored. ```text %LOCALAPPDATA%\Helius\tracker.db ``` -------------------------------- ### Initialize a database with helius init Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Initializes the default database explicitly with a 3-letter currency code. If no database exists, Helius creates one on first launch and prompts for the currency code. ```powershell helius init --currency USD ``` -------------------------------- ### Inspect CLI with helius --help Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Development.md Shows CLI help without entering the TUI. ```powershell helius --help ``` -------------------------------- ### Enter transactions manually Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Adds income and expense transactions to the specified account with category and payee. ```powershell cargo run --release -- tx add --type income --amount 2500.00 --date 2026-03-01 --account Checking --category Salary --payee Employer cargo run --release -- tx add --type expense --amount 68.40 --date 2026-03-02 --account Checking --category Groceries --payee Supermarket ``` -------------------------------- ### Add basic data: account and categories Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Adds a checking account and income/expense categories. These are prerequisites for importing statements or entering transactions. ```powershell cargo run --release -- account add Checking --type checking --opening-balance 1000.00 cargo run --release -- category add Salary --kind income cargo run --release -- category add Groceries --kind expense ``` -------------------------------- ### Inspect CLI help Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Development Command to view CLI help without entering the TUI. ```powershell .\Helius.exe --help ``` -------------------------------- ### Install specific Helius version on Windows Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Set `HELIUS_VERSION` before running the installer to install a specific version. The installer downloads the release, verifies its SHA-256 checksum, and installs into `%LOCALAPPDATA%\Programs\Helius`, adding that folder to the user `PATH`. ```powershell $env:HELIUS_VERSION = "v1.4.4"; irm https://raw.githubusercontent.com/Helius-Finance/helius-finance-tracker/main/install.ps1 | iex ``` -------------------------------- ### Build release binary with cargo build --release Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Installation Compile the project in release mode. The resulting binary is placed at target\release\helius.exe. ```powershell cargo build --release ``` -------------------------------- ### Use custom database path with --db Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Installation Runs helius with a custom database file location. The HELIUS_DB_PATH environment variable provides a persistent override. ```powershell helius --db C:\path\to\tracker.db balance ``` -------------------------------- ### Install specific Helius version on Linux Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Set `HELIUS_VERSION` before running the installer to install a specific version. The installer downloads the release, verifies its SHA-256 checksum, and installs into `~/.local/bin`. ```bash curl -fsSL https://raw.githubusercontent.com/Helius-Finance/helius-finance-tracker/main/install.sh | HELIUS_VERSION=v1.4.4 sh ``` -------------------------------- ### Record a transfer transaction Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Adds a transfer transaction between accounts using the --to-account option. ```powershell helius tx add --type transfer --amount 200.00 --date 2026-03-03 --account Checking --to-account Cash --note "ATM withdrawal" ``` -------------------------------- ### Export & Scripting Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Commands for exporting data to CSV and getting JSON output for scripting. ```bash helius export csv --kind transactions --output transactions.csv --month 2026-03 helius balance --json helius forecast bills --days 30 --json ``` -------------------------------- ### Import a statement manually or via camt053 Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/QUICKSTART.md Manual CSV mapping requires specifying date, amount, description columns and an expense category. The camt053 import supports limited formats and includes a dry-run option. ```powershell cargo run --release -- import csv --input .\bank.csv --account Checking --date-column Date --amount-column Amount --description-column Description --expense-category Groceries cargo run --release -- import camt053 --input .\statement.xml --account Checking --dry-run ``` -------------------------------- ### Reconciliation commands: start, list, delete Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Start a reconciliation for an account with a statement balance and transaction IDs, list reconciliations, and delete one by ID. ```powershell helius reconcile start --account Checking --to 2026-03-31 --statement-balance 3174.60 --transaction-id 10 --transaction-id 11 --transaction-id 12 helius reconcile list --json helius reconcile delete 4 ``` -------------------------------- ### Add accounts and categories Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Adds a checking account and two categories (income and expense) using the CLI. Account types include cash, checking, savings, credit; category kinds are income and expense. ```powershell helius account add Checking --type checking --opening-balance 1000.00 --opened-on 2026-03-01 helius category add Salary --kind income helius category add Groceries --kind expense ``` -------------------------------- ### Record income and expense transactions Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Getting-Started Adds an income and an expense transaction using the helius tx add command. ```powershell helius tx add --type income --amount 2500.00 --date 2026-03-01 --account Checking --category Salary --payee Employer helius tx add --type expense --amount 68.40 --date 2026-03-02 --account Checking --category Groceries --payee Supermarket ``` -------------------------------- ### helius reconcile start Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Starts a reconciliation for an account with a statement balance and transaction IDs. ```APIDOC ## [CLI] helius reconcile start ### Description Starts a reconciliation for an account with a statement balance and transaction IDs. ### Command `helius reconcile start --account --to --statement-balance --transaction-id [--transaction-id ...]` ### Parameters - **--account** (string) - Required - The account name. - **--to** (string) - Required - The end date in YYYY-MM-DD format. - **--statement-balance** (number) - Required - The statement balance. - **--transaction-id** (integer) - Required - A transaction ID to include. Can be repeated. ### Example ```powershell helius reconcile start --account Checking --to 2026-03-31 --statement-balance 3174.60 --transaction-id 10 --transaction-id 11 --transaction-id 12 ``` ``` -------------------------------- ### helius recurring add Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Adds a recurring rule with type, amount, account, category, cadence, and start date. ```APIDOC ## [CLI] helius recurring add ### Description Adds a recurring rule with type, amount, account, category, cadence, and start date. ### Command `helius recurring add --type --amount --account --category --cadence [--day-of-month ] [--start-on ]` ### Parameters - **name** (string) - Required - The recurring rule name. - **--type** (string) - Required - The type (e.g., expense). - **--amount** (number) - Required - The amount. - **--account** (string) - Required - The account name. - **--category** (string) - Required - The category name. - **--cadence** (string) - Required - The cadence. Allowed values: `weekly`, `monthly`. - **--day-of-month** (integer) - Optional - The day of the month for monthly cadence. - **--start-on** (string) - Optional - The start date in YYYY-MM-DD format. ### Example ```powershell helius recurring add "Monthly Rent" --type expense --amount 900.00 --account Checking --category Housing --cadence monthly --day-of-month 6 --start-on 2026-03-01 ``` ``` -------------------------------- ### Initialize and use Helius CLI commands Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Set up Helius from the command line: `helius init` prompts for a 3-letter currency code and creates the database, then add accounts, import CSV statements, and check balances. The `--dry-run` flag on `import csv` previews the import without applying changes. ```bash helius init --currency USD helius account add Checking --type checking --opening-balance 1000.00 helius import csv --input statement.csv --account Checking --preset chase-us --dry-run helius balance ``` -------------------------------- ### Planning, Scenarios & Goals Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Commands for forecasting, adding scenarios, and setting goals. ```bash helius forecast show --days 90 helius scenario add "Recovery Plan" helius goal add "Cash Floor" --kind balance-target --account Checking --minimum-balance 100.00 ``` -------------------------------- ### Bank import commands Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Commands to list CSV presets, import a CSV with a preset, and import a camt.053 XML file. Always preview with --dry-run first to see what would be written without touching the database. ```bash helius import csv --list-presets helius import csv --input statement.csv --account Checking --preset revolut-csv --dry-run helius import camt053 --input statement.xml --account Checking --dry-run ``` -------------------------------- ### Add goals Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Planning-and-Forecasts Create sinking-fund and balance-target goals, then list them. `--target-amount` is used for sinking-fund, `--minimum-balance` for balance-target. ```powershell helius goal add "Vacation Fund" --kind sinking-fund --account Checking --target-amount 1500.00 --due-on 2026-08-01 helius goal add "Cash Floor" --kind balance-target --account Checking --minimum-balance 250.00 helius goal list --json ``` -------------------------------- ### Build Helius from source Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Clone the repository and build the release binary with the stable Rust toolchain. The binary is produced at `target/release/helius`. ```bash git clone https://github.com/Helius-Finance/helius-finance-tracker.git cd helius-finance-tracker cargo build --release # binary: target/release/helius ``` -------------------------------- ### Everyday Commands Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Common commands for daily use: check balances, list transactions, view monthly summaries, budget status, and forecasts. ```bash helius balance # balances across accounts helius tx list --limit 20 # recent transactions helius summary month 2026-03 # income vs. expenses for a month helius budget status 2026-03 # budget progress helius forecast show # 90-day cash-flow forecast helius forecast bills # bills due in the next 30 days ``` -------------------------------- ### Run host verification script on Linux Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Release-Process.md Run the host verification script on Linux using PowerShell 7 (`pwsh`). Expects an `x86_64-unknown-linux-gnu` toolchain and is intended for an x86_64 Linux host. ```powershell pwsh ./scripts/verify-host-release.ps1 -Platform linux-x86_64 ``` -------------------------------- ### Clone the Wiki Repository Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Publishing-the-Wiki.md Clones the GitHub wiki repository for the project. If the wiki was just enabled, GitHub may not create the remote repository until the first page exists; create a placeholder page in the web UI first, then clone again. ```powershell git clone https://github.com/STVR393/helius-personal-finance-tracker.wiki.git ``` -------------------------------- ### Manage planning items Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Planning-and-Forecasts Add, list, and post planning items. Posting a planning item creates a real transaction. ```powershell helius plan item add "Emergency Repair" --scenario Downside --type expense --amount 700.00 --date 2026-03-24 --account Checking --category Housing helius plan item list --scenario Downside --json helius plan item post 5 ``` -------------------------------- ### Run Helius in Docker Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Build the Docker image, create a volume for persistent data, and run the container. Use `-it` for the TUI and interactive shell; the database is stored at `/data/tracker.db`. ```bash docker build -t helius . docker volume create helius-data docker run --rm -it -v helius-data:/data helius # TUI docker run --rm -v helius-data:/data helius balance # direct command ``` -------------------------------- ### Show forecast commands Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Planning-and-Forecasts Display forecasts with default or custom day ranges and JSON output. `forecast show` defaults to 90 days, `forecast bills` to 30 days. ```powershell helius forecast show helius forecast show --days 90 --json helius forecast bills --days 30 --json ``` -------------------------------- ### Commit and Push Wiki Pages Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Publishing-the-Wiki.md Stages all changes, commits with the message 'Add initial Helius wiki', and pushes to the master branch. GitHub Wikis usually use the master branch even when the main source repo uses main. ```powershell git add . git commit -m "Add initial Helius wiki" git push origin master ``` -------------------------------- ### Pre-Migration Backup Pattern Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Data-and-Storage Pattern for backup filenames created before schema migrations. ```text tracker.pre-vFROM-to-vTO.YYYYMMDDTHHMMSS.db ``` -------------------------------- ### Preview and import CSV with preset Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Bank-Import.md Runs a dry run first to parse the file, resolve categories, check duplicates, and show rows without changing the database. Then imports the CSV using the `chase-us` preset for the `Checking` account. ```powershell helius import csv --input .\statement.csv --account Checking --preset chase-us --dry-run helius import csv --input .\statement.csv --account Checking --preset chase-us ``` -------------------------------- ### Manual CSV mapping for split debit/credit files Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Bank-Import.md Use this command for files with separate debit and credit columns. You must use either --amount-column or the --debit-column/--credit-column pair, not both. Split files must have exactly one side filled per row; empty cells or 0.00 count as unfilled, and rows with both or neither values are rejected. --default-type cannot be combined with split columns. ```powershell helius import csv --input .\bank.csv --account Checking ` --date-column Date ` --debit-column Debit ` --credit-column Credit ` --description-column Description ` --dry-run ``` -------------------------------- ### Set budgets and scenario overrides Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Planning-and-Forecasts Set a budget for the baseline plan or override it within a scenario, then check status. The scenario override uses the same month and account. ```powershell helius budget set Groceries --month 2026-03 --amount 200.00 --account Checking helius budget set Groceries --month 2026-03 --amount 500.00 --scenario "Stress Case" helius budget status 2026-03 --scenario "Stress Case" --json ``` -------------------------------- ### List CSV presets Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Bank-Import.md Lists every CSV preset. Works before `helius init`. The `--json` flag outputs machine-readable data for comparing preset columns with your CSV header row. ```powershell helius import csv --list-presets helius import csv --list-presets --json ``` -------------------------------- ### Preview and import camt.053 XML Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Bank-Import.md Runs a dry run first to parse the file, resolve categories, check duplicates, and show rows without changing the database. Then imports the ISO 20022 `camt.053` XML statement for the `Checking` account. ```powershell helius import camt053 --input .\statement.xml --account Checking --dry-run helius import camt053 --input .\statement.xml --account Checking ``` -------------------------------- ### Global Option --db Source: https://github.com/helius-finance/helius-finance-tracker/wiki/CLI-Reference Use --db to target a specific SQLite file. ```text --db ``` -------------------------------- ### Accounts, Categories & Transactions Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Commands to manage accounts, categories, and transactions: add accounts/categories, add/edit/delete/restore transactions. ```bash helius account add Cash --type cash helius category add Groceries --kind expense helius category add Salary --kind income helius tx add --type income --amount 2500.00 --date 2026-03-01 --account Checking --category Salary --payee Employer helius tx add --type expense --amount 42.50 --date 2026-03-02 --account Checking --category Groceries --payee Market helius tx edit 12 --note "corrected note" helius tx delete 12 helius tx restore 12 ``` -------------------------------- ### Budgets, Recurring Rules & Reconciliation Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/README.md Commands for setting budgets, adding recurring rules, running them, and reconciling accounts. ```bash helius budget set Groceries --month 2026-03 --amount 300.00 --account Checking helius recurring add "Monthly Rent" --type expense --amount 900.00 --account Checking \ --category Housing --cadence monthly --day-of-month 6 --start-on 2026-03-01 helius recurring run --through 2026-04-30 helius reconcile start --account Checking --to 2026-03-31 --statement-balance 3174.60 \ --transaction-id 10 --transaction-id 11 ``` -------------------------------- ### Default database paths per platform Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Data-and-Storage.md Default SQLite database file locations for Windows, macOS, and Linux. Helius resolves the default through `directories::ProjectDirs`, preferring `LOCALAPPDATA` on Windows when available. ```text %LOCALAPPDATA%\Helius\tracker.db ~/Library/Application Support/Helius/tracker.db ~/.local/share/helius/tracker.db ``` -------------------------------- ### Override Database Path with --db Flag Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Data-and-Storage Use the --db flag to specify a custom database path for any command. ```powershell helius --db C:\Finance\tracker.db balance ``` -------------------------------- ### Manual CSV mapping for signed amount files Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Bank-Import.md Use this command when the bank is not listed or a preset is close but not exact. It maps date, amount, and description columns for files with a single signed amount column. The --dry-run flag previews the import without applying changes. ```powershell helius import csv --input .\bank.csv --account Checking ` --date-column Date ` --amount-column Amount ` --description-column Description ` --dry-run ``` -------------------------------- ### Budgets, Planning, and Forecasting Commands Source: https://github.com/helius-finance/helius-finance-tracker/wiki/CLI-Reference Commands for budgets, scenarios, plan items, goals, and forecasts. Goal kinds are sinking-fund and balance-target. ```powershell helius budget set Groceries --month 2026-03 --amount 300.00 helius budget status 2026-03 --json helius scenario add "Stress Case" --note "Higher spending month" helius plan item add "Insurance" --type expense --amount 120.00 --date 2026-03-20 --account Checking --category Housing helius goal add "Cash Floor" --kind balance-target --account Checking --minimum-balance 100.00 helius forecast show --days 90 --json helius forecast bills --days 30 --json ``` -------------------------------- ### Import CSV Commands Source: https://github.com/helius-finance/helius-finance-tracker/wiki/CLI-Reference Import a CSV file with optional --dry-run. Defaults: --date-format %Y-%m-%d, --delimiter ,. Use --category when no category column, and --allow-duplicates to skip duplicate detection. ```powershell helius import csv --input .\bank.csv --account Checking --date-column Date --amount-column Amount --description-column Description --category-column Category --dry-run --json helius import csv --input .\bank.csv --account Checking --date-column Date --amount-column Amount --description-column Description --category-column Category --json ``` -------------------------------- ### Raw CLI commands in the shell Source: https://github.com/helius-finance/helius-finance-tracker/wiki/TUI-and-Shell The shell accepts raw CLI commands, such as listing transactions, checking budget status, and listing recurring items. ```text tx list --account Checking budget status 2026-03 recurring list ``` -------------------------------- ### Manage scenarios Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Planning-and-Forecasts Add, list, edit, and delete planning scenarios. Scenario IDs are used in edit and delete commands. ```powershell helius scenario add "Downside" --note "Emergency spending month" helius scenario list --json helius scenario edit 1 --name "Stress Case" helius scenario delete 1 ``` -------------------------------- ### Run host verification script Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/CONTRIBUTING.md Run the host verification script before opening a pull request if you touch release packaging. ```powershell ./scripts/verify-host-release.ps1 -Platform windows-x86_64 ``` -------------------------------- ### helius scenario list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all scenarios, optionally in JSON format. ```APIDOC ## [CLI] helius scenario list ### Description Lists all scenarios, optionally in JSON format. ### Command `helius scenario list [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius scenario list --json ``` ``` -------------------------------- ### helius goal list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all goals, optionally in JSON format. ```APIDOC ## [CLI] helius goal list ### Description Lists all goals, optionally in JSON format. ### Command `helius goal list [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius goal list --json ``` ``` -------------------------------- ### helius account list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all accounts. Supports --json for JSON output. ```APIDOC ## helius account list ### Description Lists all accounts. ### Command `helius account list [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius account list --json ``` ``` -------------------------------- ### Add recurring rule and run Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Planning-and-Forecasts Add a recurring expense rule and run it to post due entries. `recurring run` posts due recurring entries into the ledger. ```powershell helius recurring add "Rent" --type expense --amount 900.00 --account Checking --category Housing --cadence monthly --day-of-month 6 --start-on 2026-03-01 helius recurring run --through 2026-04-30 ``` -------------------------------- ### Import using a preset Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Imports a CSV using a preset, which auto-fills column names, delimiter, and date format. The --dry-run flag performs a dry run without committing changes. ```powershell helius import csv --input .\alpha.csv --account Checking --preset alpha-bank-gr --dry-run ``` -------------------------------- ### Import with split debit and credit columns Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Imports a CSV where debits and credits are in separate columns, using --debit-column and --credit-column instead of a single amount column. ```powershell helius import csv --input .\bank.csv --account Checking --debit-column Debit --credit-column Credit --description-column Description ``` -------------------------------- ### helius plan item list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all plan items, optionally in JSON format. ```APIDOC ## [CLI] helius plan item list ### Description Lists all plan items, optionally in JSON format. ### Command `helius plan item list [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius plan item list --json ``` ``` -------------------------------- ### Budget commands: set, list, status, delete Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Manage budgets for a specific month. Use --json for machine-readable output. The status command reports budget status for the month. ```powershell helius budget set Groceries --month 2026-03 --amount 300.00 helius budget list --month 2026-03 --json helius budget status 2026-03 --json helius budget delete Groceries --month 2026-03 ``` -------------------------------- ### Accounts and Categories Commands Source: https://github.com/helius-finance/helius-finance-tracker/wiki/CLI-Reference Commands to add, list, edit, and delete accounts and categories. Account types and category kinds are not specified here. ```powershell helius account add "Cash" --type cash helius account list --json helius account edit "Cash" --name "Wallet" helius account delete "Wallet" helius category add "Housing" --kind expense helius category list --json helius category edit "Housing" --name "Rent" helius category delete "Rent" ``` -------------------------------- ### helius scenario add Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Adds a new scenario with an optional note. ```APIDOC ## [CLI] helius scenario add ### Description Adds a new scenario with an optional note. ### Command `helius scenario add [--note ]` ### Parameters - **name** (string) - Required - The scenario name. - **--note** (string) - Optional - A note describing the scenario. ### Example ```powershell helius scenario add "Stress Case" --note "Higher spending month" ``` ``` -------------------------------- ### Override preset defaults with manual flags Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Bank-Import.md Use this PowerShell command to import a CSV while overriding preset column names. The --preset flag selects a preset, and --date-column and --amount-column override the preset's defaults. ```powershell helius import csv --input .\bank.csv --account Checking --preset revolut-csv ` --date-column "Completed Date" --amount-column "Base amount" ``` -------------------------------- ### helius goal add Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Adds a goal with a kind, account, and optional minimum balance. ```APIDOC ## [CLI] helius goal add ### Description Adds a goal with a kind, account, and optional minimum balance. ### Command `helius goal add --kind --account [--minimum-balance ]` ### Parameters - **name** (string) - Required - The goal name. - **--kind** (string) - Required - The goal kind. Allowed values: `sinking-fund`, `balance-target`. - **--account** (string) - Required - The account name. - **--minimum-balance** (number) - Optional - The minimum balance for balance-target goals. ### Example ```powershell helius goal add "Cash Floor" --kind balance-target --account Checking --minimum-balance 100.00 ``` ``` -------------------------------- ### Override Database Path with HELIUS_DB_PATH Environment Variable Source: https://github.com/helius-finance/helius-finance-tracker/wiki/Data-and-Storage Set the HELIUS_DB_PATH environment variable to override the default database path. ```powershell $env:HELIUS_DB_PATH = 'C:\Finance\tracker.db' helius balance ``` -------------------------------- ### helius budget list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all budgets for a given month, optionally in JSON format. ```APIDOC ## [CLI] helius budget list ### Description Lists all budgets for a given month, optionally in JSON format. ### Command `helius budget list --month [--json]` ### Parameters - **--month** (string) - Required - The month in YYYY-MM format. - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius budget list --month 2026-03 --json ``` ``` -------------------------------- ### Transactions and Reporting Commands Source: https://github.com/helius-finance/helius-finance-tracker/wiki/CLI-Reference Commands to add, list, edit, delete, and restore transactions, plus balance and summary reporting. Transaction kinds are income, expense, and transfer. ```powershell helius tx add --type expense --amount 290.00 --date 2026-03-06 --account Checking --category Housing --payee Landlord helius tx list --account Checking --limit 25 helius tx edit 12 --note "Corrected memo" helius tx delete 12 helius tx restore 12 helius balance --json helius summary month 2026-03 --json helius summary range --from 2026-03-01 --to 2026-03-31 --json ``` -------------------------------- ### helius plan item post Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Posts a plan item by its ID. ```APIDOC ## [CLI] helius plan item post ### Description Posts a plan item by its ID. ### Command `helius plan item post ` ### Parameters - **id** (integer) - Required - The plan item ID. ### Example ```powershell helius plan item post 3 ``` ``` -------------------------------- ### Add recurring rule and run it Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/Planning-and-Forecasts.md Recurring rules are included in forecasts and can also be posted into real transactions. `forecast show` is read-only and does not advance a recurring rule's stored next due date; `recurring run` is what actually posts due recurring entries into the ledger. ```powershell helius recurring add "Gym" --type expense --amount 35.00 --account Checking --category Misc --cadence monthly --day-of-month 15 --start-on 2026-03-01 helius recurring run --through 2026-04-30 ``` -------------------------------- ### Export CSV Commands Source: https://github.com/helius-finance/helius-finance-tracker/wiki/CLI-Reference Export transactions or summary data to CSV. Use --kind transactions or --kind summary with appropriate options. ```powershell helius export csv --kind transactions --output .\transactions.csv --month 2026-03 helius export csv --kind summary --output .\summary.csv --from 2026-03-01 --to 2026-03-31 ``` -------------------------------- ### Customize uncategorized fallback categories Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Imports a CSV with a preset and overrides the default uncategorized income and expense buckets. Rows without an inline category land in these custom buckets instead of the built-in 'Uncategorized Income' / 'Uncategorized Expense'. ```powershell helius import csv --input .\bank.csv --account Checking --preset revolut-csv \ --income-category "Inbound" --expense-category "Outbound" ``` -------------------------------- ### helius plan item add Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Adds a plan item with type, amount, date, account, and category. ```APIDOC ## [CLI] helius plan item add ### Description Adds a plan item with type, amount, date, account, and category. ### Command `helius plan item add --type --amount --date --account --category ` ### Parameters - **name** (string) - Required - The plan item name. - **--type** (string) - Required - The type of plan item (e.g., expense). - **--amount** (number) - Required - The amount. - **--date** (string) - Required - The date in YYYY-MM-DD format. - **--account** (string) - Required - The account name. - **--category** (string) - Required - The category name. ### Example ```powershell helius plan item add "Insurance" --type expense --amount 120.00 --date 2026-03-20 --account Checking --category Housing ``` ``` -------------------------------- ### helius budget set Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Sets a budget amount for a specific category and month. ```APIDOC ## [CLI] helius budget set ### Description Sets a budget amount for a specific category and month. ### Command `helius budget set --month --amount ` ### Parameters - **category** (string) - Required - The budget category name. - **--month** (string) - Required - The month in YYYY-MM format. - **--amount** (number) - Required - The budget amount. ### Example ```powershell helius budget set Groceries --month 2026-03 --amount 300.00 ``` ``` -------------------------------- ### helius category list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all categories. Supports --json for JSON output. ```APIDOC ## helius category list ### Description Lists all categories. ### Command `helius category list [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius category list --json ``` ``` -------------------------------- ### helius balance Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Displays the current balance. Supports --json for JSON output. ```APIDOC ## helius balance ### Description Displays the current balance. ### Command `helius balance [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius balance --json ``` ``` -------------------------------- ### helius summary month Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Displays a summary for a specific month. Supports --json for JSON output. ```APIDOC ## helius summary month ### Description Displays a summary for a specific month. ### Command `helius summary month [--json]` ### Parameters - **** (string) - Required - Month in YYYY-MM format. - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius summary month 2026-03 --json ``` ``` -------------------------------- ### Import a camt.053 bank statement Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Imports a camt.053 (ISO 20022 XML) bank statement. The first command performs a dry run with JSON output; the second performs the actual import with custom income and expense categories and JSON output. ```powershell helius import camt053 --input .\statement.xml --account Checking --dry-run --json helius import camt053 --input .\statement.xml --account Checking \ --income-category "Inbound" --expense-category "Outbound" --json ``` -------------------------------- ### Recurring rules commands: add, list, pause, resume, run Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Manage recurring rules with cadence values weekly or monthly. Weekly rules accept weekday values mon through sun. ```powershell helius recurring add "Monthly Rent" --type expense --amount 900.00 --account Checking --category Housing --cadence monthly --day-of-month 6 --start-on 2026-03-01 helius recurring list --json helius recurring pause 2 helius recurring resume 2 helius recurring run --through 2026-04-30 ``` -------------------------------- ### helius forecast show Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Shows a forecast for a specified number of days, optionally in JSON format. ```APIDOC ## [CLI] helius forecast show ### Description Shows a forecast for a specified number of days, optionally in JSON format. ### Command `helius forecast show --days [--json]` ### Parameters - **--days** (integer) - Required - The number of days to forecast. - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius forecast show --days 90 --json ``` ``` -------------------------------- ### helius summary range Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Displays a summary for a date range. Supports --json for JSON output. ```APIDOC ## helius summary range ### Description Displays a summary for a date range. ### Command `helius summary range --from --to [--json]` ### Parameters - **--from** (string) - Required - Start date (YYYY-MM-DD). - **--to** (string) - Required - End date (YYYY-MM-DD). - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius summary range --from 2026-03-01 --to 2026-03-31 --json ``` ``` -------------------------------- ### helius tx list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists transactions with optional filtering by account and limit. ```APIDOC ## helius tx list ### Description Lists transactions. ### Command `helius tx list [--account ] [--limit ]` ### Parameters - **--account** (string) - Optional - Filter by account name. - **--limit** (integer) - Optional - Maximum number of transactions to return. ### Example ```powershell helius tx list --account Checking --limit 25 ``` ``` -------------------------------- ### helius account add Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Adds a new account to the Helius tracker. Use the --type option to specify the account type. ```APIDOC ## helius account add ### Description Adds a new account to the Helius tracker. ### Command `helius account add --type ` ### Parameters - **name** (string) - Required - The name of the account. - **--type** (string) - Required - The account type (e.g., cash). ### Example ```powershell helius account add "Cash" --type cash ``` ``` -------------------------------- ### Run smoke script Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/CONTRIBUTING.md Run the smoke script from a PowerShell session where local scripts are allowed. On Windows PowerShell 5.1, one option is `powershell -NoProfile -ExecutionPolicy Bypass`. ```powershell ./scripts/smoke.ps1 ``` -------------------------------- ### helius reconcile list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all reconciliations, optionally in JSON format. ```APIDOC ## [CLI] helius reconcile list ### Description Lists all reconciliations, optionally in JSON format. ### Command `helius reconcile list [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius reconcile list --json ``` ``` -------------------------------- ### helius budget status Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Shows the status of budgets for a given month, optionally in JSON format. ```APIDOC ## [CLI] helius budget status ### Description Shows the status of budgets for a given month, optionally in JSON format. ### Command `helius budget status [--json]` ### Parameters - **** (string) - Required - The month in YYYY-MM format. - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius budget status 2026-03 --json ``` ``` -------------------------------- ### helius tx add Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Adds a new transaction. Requires type, amount, date, account, category, and payee. ```APIDOC ## helius tx add ### Description Adds a new transaction. ### Command `helius tx add --type --amount --date --account --category --payee ` ### Parameters - **--type** (string) - Required - Transaction kind: income, expense, or transfer. - **--amount** (number) - Required - Transaction amount. - **--date** (string) - Required - Transaction date (YYYY-MM-DD). - **--account** (string) - Required - Account name. - **--category** (string) - Required - Category name. - **--payee** (string) - Required - Payee name. ### Example ```powershell helius tx add --type expense --amount 290.00 --date 2026-03-06 --account Checking --category Housing --payee Landlord ``` ``` -------------------------------- ### helius recurring list Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Lists all recurring rules, optionally in JSON format. ```APIDOC ## [CLI] helius recurring list ### Description Lists all recurring rules, optionally in JSON format. ### Command `helius recurring list [--json]` ### Parameters - **--json** (flag) - Optional - Output in JSON format. ### Example ```powershell helius recurring list --json ``` ``` -------------------------------- ### helius tx restore Source: https://github.com/helius-finance/helius-finance-tracker/blob/main/wiki/CLI-Reference.md Restores a deleted transaction by ID. ```APIDOC ## helius tx restore ### Description Restores a deleted transaction. ### Command `helius tx restore ` ### Parameters - **id** (integer) - Required - Transaction ID. ### Example ```powershell helius tx restore 12 ``` ```