Official ShekelSync Documentation

From first sync to financial clarity

A practical guide to setting up ShekelSync, understanding your data, and using its dashboards, analysis, investments, and privacy controls with confidence.

Windows, macOS & Linux

Local-first data model

Setup and feature guidance

Understand the security model before connecting an account

ShekelSync is a local-first desktop app. Saved credentials are encrypted at rest on your device and used locally to sign in directly to your bank or card provider during synchronization. Your device security and the release you install are part of the trust model.

Review security assumptions
Quick start

Getting Started

Follow this path on your first day with ShekelSync. Each step builds on the previous one and mirrors the onboarding checklist inside the app.

Section 1

Before you start

ShekelSync works differently from a hosted finance service: the desktop app and its local database run on your computer.

  • Use a maintained Windows, macOS, or Linux computer that only trusted people can access.
  • Download builds from the official ShekelSync GitHub release page.
  • Enable disk encryption, strong operating-system sign-in, and current security updates.
  • Expect bank and card provider flows to change occasionally; synchronization is best effort.

Good to know: Read the security notice on the installation page before entering real financial credentials.

Section 2

Download and install

The installation page detects your platform and links to the latest published ShekelSync release.

  • Windows: download and run the ShekelSync Setup executable.
  • macOS: download the universal DMG, open it, and move ShekelSync to Applications.
  • Linux: download the AppImage, make it executable if needed, and launch it.
  • Verify that the displayed version and download source match the official release.

Good to know: Operating systems may show an extra security prompt for community or unsigned builds. Only continue when the file came from the official release page.

Section 3

Complete first launch and your profile

On first launch, finish any registration or access prompt shown by the app, then complete the profile step in the onboarding checklist.

  • Register or sign in with your email when the app asks you to do so.
  • Open Profile and add the household details you are comfortable using for analysis.
  • Choose your language, display preferences, and privacy options in Settings.
  • Use the onboarding checklist to see which setup step is available next.

Good to know: Financial profiling uses profile details only when you explicitly generate an assessment.

Section 4

Connect bank and credit-card accounts

Use Add Account in the sidebar. The app guides you through the institution hierarchy and requests only the fields required by that provider.

  • Add your main bank account first, followed by each credit-card account you want to reconcile.
  • Give accounts recognizable nicknames so sync status and pairing are easier to understand.
  • Double-check usernames, IDs, card digits, and passwords before saving; providers limit repeated retries.
  • Use Accounts Management later to update credentials, sync one account, or remove an account.
Short product walkthrough recorded from ShekelSync.

Good to know: Saved credentials are encrypted locally. One-time OTP codes are entered when required and are not stored.

Section 5

Run your first synchronization

Open Sync Transactions and start a sync after your accounts are connected. Progress continues in the background while you use the app.

  • Select the institution or account you want to synchronize and confirm any requested one-time code.
  • Watch progress and transaction counts in the sync window or sidebar status.
  • Allow the first sync time to collect and normalize bank, card, balance, and investment data.
  • If a cooldown appears, wait until its stated retry time instead of repeatedly submitting logins.

Good to know: A sync can finish after you close the progress window; ShekelSync notifies the rest of the app when fresh data is ready.

Section 6

Review, categorize, and pair imported data

Treat the first import as a review pass. Correcting early classifications gives later dashboards and rules a stronger foundation.

  • Confirm that bank balances, credit-card charges, dates, and transaction amounts look reasonable.
  • Open Categories to resolve uncategorized transactions and organize the category hierarchy.
  • Create merchant rules only after confirming the category you want future transactions to use.
  • Use Pair Accounts to match credit-card settlements with the related bank debits and avoid double counting.

Good to know: If the current month is missing card activity, inspect unmatched accounts and run the offered recovery sync before judging totals.

Section 7

Take your first dashboard tour

Overview brings the current financial picture together after enough synchronized data is available.

  • Current Month summarizes income, expenses, pending settlements, investments, and capital returns.
  • Financial Health combines savings, diversity, impulse spending, and runway signals.
  • Money-flow and category visuals explain where funds came from and where spending went.
  • Transaction history and forecast views connect past activity with likely month-end outcomes.

Good to know: Unexpected totals usually come from stale syncs, missing card transactions, pairing gaps, or categories that still need review.

Reference guide

User Guide

Use this section as a reference after setup. It follows the app's four main workspaces and the supporting account, category, search, and settings tools.

Section 2

Accounts and synchronization

Accounts Management separates Banking & Transactions from Investments & Savings and provides actions for the full account lifecycle.

  • Add bank and card institutions through the guided provider hierarchy, or add manual investment accounts.
  • Update saved credentials without replacing an unchanged password, and enter OTP values only when requested.
  • Read each account's last-update state and synchronize stale or individual accounts from the sidebar.
  • Use Pair Accounts and recovery sync when bank settlements and card activity do not reconcile.

Good to know: Deleting an account can also remove associated local data and cannot be undone; export anything you need first.

Section 3

Transaction history, search, notes, and tags

ShekelSync keeps transaction review close to the charts so you can move from a trend to its underlying records.

  • Adjust the transaction-history period and aggregation to examine daily or broader cash movement.
  • Search globally by merchant or transaction text and open a result directly in its detail view.
  • Use filters and bulk actions when the same correction applies to several transactions.
  • Add notes and reusable tags to preserve context and make later searches easier.
Short product walkthrough recorded from ShekelSync.

Good to know: Open a transaction from a chart or search result before editing so you can verify its institution, date, amount, and existing classification.

Section 4

Categories, rules, and transaction pairing

Categories explain spending; rules automate repeated decisions; pairing prevents card purchases and their bank settlement from being counted twice.

  • Organize parent and child categories in the category hierarchy and resolve the uncategorized queue.
  • Categorize one transaction or apply a reviewed choice in bulk to similar records.
  • Create vendor rules for future transactions, then monitor them when merchant labels change.
  • Inspect unpaired transactions and account discrepancies before changing dashboard totals manually.
Short product walkthrough recorded from ShekelSync.

Good to know: Pairing links related records; it is different from categorization and should not be used merely because two amounts look similar.

Section 5

Dashboard, cash flow, and forecasting

Overview is the operational summary for the selected period, combining balances, current-month movement, spending structure, and forward-looking estimates.

  • Read income, expenses, pending settlements, investments, and capital returns as separate concepts.
  • Use category and money-flow visuals to trace totals back to their spending structure.
  • Compare actual history with the forecast zone and its confidence range rather than treating it as a guarantee.
  • Follow pairing-gap, missing-income, and stale-sync prompts before making conclusions from incomplete data.

Good to know: Pending card settlements are already included where the interface says so; do not add them to expenses a second time.

Section 6

Analysis, smart actions, and budgets

Analysis contains seven focused tabs so deeper tools do not overwhelm the everyday dashboard.

  • Dashboard summarizes financial rhythm and forward-looking signals; Actions tracks anomalies, overruns, and opportunities.
  • Spending explores category behavior, variability, recurring patterns, and transaction detail.
  • Budget compares actual and forecasted category spend with monthly limits and suggested actions.
  • Scoring, Subscriptions, and Profiling cover health metrics, recurring charges, and optional benchmarked household assessment.

Good to know: Resolve, dismiss, or snooze smart actions with a note so the action list remains useful instead of becoming noise.

Section 7

Investments and net worth

The Investments workspace combines synced and manually maintained holdings into portfolio, allocation, history, and balance-sheet views.

  • Add brokerage, pension, provident, study-fund, deposit, savings, or other supported account types.
  • Record dated value updates, optional cost basis, notes, and individual asset quantities where appropriate.
  • Review allocation, performance, roll-forward history, suggestions, and institution-level account detail.
  • Include supported illiquid assets such as real estate so net worth is not limited to market accounts.

Good to know: Keep valuation dates and cost basis consistent; stale or mixed-date manual values can distort performance and allocation.

Section 8

AI assistant and financial intelligence

AI features are optional tools for explaining tracked information, generating profiling narratives, and turning patterns into possible next actions.

  • Add your own OpenAI API key in Settings before using features that require model access.
  • Ask the financial assistant questions grounded in your available ShekelSync context.
  • Generate Financial Profiling only after completing the requested household fields and reviewing benchmark sources.
  • Control AI access and permissions from Privacy & Security instead of assuming every dataset is shared.

Good to know: AI output may be incomplete or wrong. Treat it as an explanation aid, not professional financial, legal, or tax advice.

Section 9

Settings

Settings is divided into five tabs that separate personal configuration from data, privacy, and system operations.

  • Profile stores household details used by selected analysis and profiling features.
  • Appearance controls language, theme, direction, and visual preferences.
  • Sync manages automatic synchronization behavior and related timing options.
  • Privacy & Security controls protected data and AI behavior; System contains diagnostics, version, and maintenance tools.

Good to know: After changing sync or privacy settings, read the confirmation message and verify the new state before closing the page.

Section 10

Privacy, security, export, and local data

Local-first reduces hosted data exposure, but it also makes device security, exports, backups, and local maintenance your responsibility.

  • Saved credentials are encrypted at rest and used locally to authenticate directly with providers during sync.
  • Use privacy mode and AI permissions to limit what is displayed or included in optional AI workflows.
  • Export data before major maintenance, account deletion, uninstallation, or moving to another device.
  • Use diagnostics and log bundles carefully because troubleshooting material can contain sensitive operational context.

Good to know: Store exported financial data only in an encrypted location and delete old copies you no longer need.

Operations and help

Operations & Reference

Protect your local data, configure optional connections, resolve common problems, and understand the financial terms used throughout ShekelSync.

Section 1

Backup, restore, and move to another device

A database backup preserves the local ShekelSync database in a restorable file. It is different from a CSV or JSON export intended for spreadsheets and external analysis.

  • Before a major update, account deletion, repair, or device move, open Settings → System → Diagnostics & Logs and select Backup database.
  • Save the generated SQLite backup in an encrypted folder or trusted encrypted drive, use a dated filename, and keep more than one recent copy.
  • To restore, open the same System panel, select Restore backup, confirm that the current database will be overwritten, and choose a .sqlite or .db backup.
  • Restart ShekelSync when the app recommends it, then check accounts, transaction dates, categories, pairing, and investment values before running a new sync.
  • For a new device, install the same or a newer ShekelSync version before restoring, and keep the original backup until the migrated copy has been verified.

Good to know: Restoring replaces the current local database. Create a fresh backup first, stop active synchronization, and treat every backup as sensitive financial data.

Section 2

Export financial data

Use Settings → System → Data Export when you need readable data for tax preparation, spreadsheets, analysis, or a portable archive that does not contain authentication secrets.

  • Choose Transactions, Categories, Vendors, Budgets & Goals, or Complete Export according to the job you are doing.
  • Choose CSV for Excel-compatible tabular work or JSON when you need structured data for another tool or script.
  • Select a preset or custom date range, then filter income, expenses, investments, categories, vendors, duplicates, and institution details.
  • Review the estimated record count and save the result with the native file dialog; the desktop export workflow writes directly to the folder you select.
  • Open a sample of the saved file and confirm its period, totals, encoding, and filters before relying on it for reporting.

Good to know: An export is not a restorable ShekelSync database backup. Exports exclude sensitive authentication information by default, but still contain private financial records.

Section 3

Optional integrations and automation

These connections are optional. Enable only the service you need, understand what it receives, and keep every token or API key private.

  • Configure automatic sync and Telegram from the Sync tab; configure OpenAI and its data permissions from Privacy & Security.
  • Add Interactive Brokers through Accounts Management and provide Flex Query details only if you want portfolio synchronization.
  • Review the next-run time or connection status after saving each integration instead of assuming it is active.
  • Disable an integration and rotate its token at the provider if a device, bot token, Flex token, or API key may be compromised.

Automatic synchronization

Setup: Open Settings → Sync, enable automatic synchronization, choose one of the offered intervals, and review startup, tray, headless, and browser-display options.

The panel shows the last result and next planned run. The computer and the configured app or tray process must be available when a background run is due.

Telegram notifications

Setup: Open Settings → Sync → Telegram, save your bot token, begin pairing, and send the displayed pairing code to your bot.

Choose the delivery mode and whether scheduled-sync results should be sent. Use Send test before depending on the connection.

OpenAI assistant

Setup: Open Settings → Privacy & Security, enable the chatbot, add your OpenAI API key, select a model tier, and grant only the transaction, category, or analytics permissions you want.

Requests use your own API key and the permissions selected in ShekelSync. Model output can be incomplete or incorrect and may incur provider charges.

Interactive Brokers

Setup: Create an IBKR Flex Query under Reports → Flex Queries, then add Interactive Brokers in Accounts Management and enter the Flex Query token and Query ID.

The credentials can be added later from account details. Confirm the query is available and portfolio values appear after the first successful synchronization.

Crash reporting telemetry

Setup: Open Settings → System → Diagnostics and choose whether to enable crash reporting when the packaged build supports it.

The panel shows whether reporting is supported, configured, and opted in. Diagnostics can still be inspected or exported locally.

Good to know: Never paste bank passwords, OTP codes, bot tokens, Flex tokens, OpenAI keys, or unredacted diagnostic data into a public post.

Section 4

Updates, diagnostics, and support reports

The title-bar update control and the System tab provide the version and operational context needed to maintain the app or report a reproducible problem.

  • Use the update icon in the title bar to check for a release. Depending on the platform and build, ShekelSync either downloads the update or opens the official manual download page.
  • Create a database backup before a major version change or migration, and do not interrupt the app while an update is being installed.
  • Find the installed version under Settings → System → About and include it with your operating system in every support report.
  • Under Diagnostics & Logs, open the log folder or copy/export a diagnostics bundle containing recent operational context, version, platform, and configuration health.
  • Before sharing, inspect screenshots and exported diagnostics for names, account identifiers, paths, transaction details, or other sensitive context.

Good to know: A useful report includes the app version, operating system, institution or feature, approximate time, exact visible error, expected result, and steps that reproduce it.

Section 5

Sync and data troubleshooting

Start with the visible symptom, protect the current data, and use the least destructive action that tests the likely cause.

  • Check account freshness, the last sync result, and the exact provider message before changing credentials or deleting anything.
  • Respect OTP expiry, provider cooldowns, and displayed retry times; repeated attempts can extend login restrictions.
  • Use Account Pairing and Recovery Sync for missing or duplicated card activity before manually changing dashboard data.
  • Back up the database before restoring, deleting an account, or attempting a larger repair.
SymptomLikely causeWhat to do
Sync fails immediatelyThe institution, identifier, password, or provider login flow changed.Open Accounts Management, verify the institution and saved identifier fields, update the current password, and try one controlled sync.
OTP is rejected or expiresThe code is time-limited, belongs to an earlier attempt, or was entered in the wrong provider flow.Wait for the active prompt, request a fresh code, enter it once, and never save the OTP as a password or permanent credential.
A cooldown or retry block appearsThe bank or card provider is rate-limiting login attempts.Stop retrying and wait until the displayed retry time. Verify credentials before the next attempt.
Credit-card spending is missingThe card account is stale, unmatched, or did not return the expected period.Open Pair Accounts, inspect unmatched accounts and freshness, then use Recovery Sync when ShekelSync offers it.
Expenses look duplicatedCard purchases and their bank settlement are not paired, or duplicate imported records remain.Review the matching bank and card records in Pair Accounts. Confirm dates and amounts before linking or excluding duplicates.
Automatic sync did not runAutomatic sync, startup, or tray execution is disabled, the device was unavailable, or the previous run was blocked.Open Settings → Sync, review the enabled state, next-run time, tray/startup options, and last result, then run Sync now as a test.
Dashboard remains out of dateA sync is still running, completed partially, or one connected account remains stale.Wait for completion, compare account freshness and transaction counts, then reopen the view. Investigate any account that still shows an older timestamp.
IBKR imports no portfolio dataThe Flex Query token, Query ID, query availability, or selected IBKR account is incorrect.Verify the Flex Query in IBKR Reports, update the token and Query ID in account details, then retry the IBKR synchronization.
Restored data looks older than expectedThe selected backup is an earlier snapshot or the app needs to reload the restored database.Restart when prompted, verify the backup date and key records, and run a fresh sync only after confirming that the correct snapshot was restored.

Good to know: Do not delete and recreate an account as the first troubleshooting step; deletion can remove associated local records and make diagnosis harder.

Section 6

Financial terminology

These definitions explain how common labels are used inside ShekelSync. They are product definitions, not accounting, tax, or investment advice.

  • Read the label and period together; the same transaction can affect different views depending on its date, type, category, and pairing state.
  • Open the underlying transactions whenever a summary term or total does not match your expectation.
  • Treat projections and scores as decision aids, not guaranteed outcomes or professional recommendations.
  • Keep categories, account pairing, valuation dates, and cost basis current so calculated terms remain meaningful.
Income
Money classified as incoming cash for the selected period. Transfers and capital returns may be shown separately rather than treated as ordinary income.
Expense
Money classified as spending for the selected period after applicable transaction pairing and duplicate handling.
Pending settlement
Tracked card activity whose related settlement or reconciliation with the bank account is not yet complete.
Capital return
Money returning from an investment or asset flow, kept separate from ordinary household income where the interface indicates.
Account pairing
The relationship between a credit-card account and its bank settlement records, used to reconcile activity and prevent double counting.
Net investment
The effective amount directed into investments after relevant recorded investment inflows and capital returns are considered.
Forecast
A model-based estimate of likely future cash movement using available transaction history and recurring patterns; it is not a guarantee.
Confidence range
The surrounding range of plausible forecast outcomes. A wider range communicates greater uncertainty.
Financial Health
A composite view of signals such as savings, diversity, impulse spending, and financial runway—not a credit score.
Net worth
The value of tracked assets minus tracked liabilities, subject to the freshness and completeness of synchronized and manual values.
Cost basis
The recorded acquisition cost used to understand investment gains, losses, and performance.
Recurring charge / subscription
A transaction pattern that appears repeatedly and may represent a subscription or other regular obligation; review the underlying transactions before confirming it.

Good to know: If a number looks wrong, verify the period, source accounts, last sync, categories, pairing, and underlying transactions before interpreting the result.

Help improve the guide

Documentation should reflect the product users actually see. Share corrections, vote on community posts, or request the next walkthrough.