Running locally

A small local server, a persistent SQLite ledger.

Use Python 3.10 or newer. Runtime uses the Python standard library; tests require pytest. From the extracted source directory in Windows PowerShell:

python -m venv .venv
.\.venv\Scripts\python.exe -m pip install -e ".[test]"
.\.venv\Scripts\python.exe -m cashflow_copilot serve --db data/state.sqlite --port 8765

Open the product website, the app, or documentation at the same local port. The default local CLI binds to 127.0.0.1. A new database starts with the synthetic fixture; an existing database is preserved.

Restart without losing work

Stop the server with Ctrl+C and run the same command with the same database path. Saved requests and approved local work remain. Connection verification starts unverified after restart. In-progress staged reviews may expire and must be reviewed again.

Model-free use

The ledger, deterministic reports, scenarios and reviewed owner forms work without a model key. Natural-language task translation needs internet and an external compatible model. See model configuration.

The default service runs locally. Optional hosted modes are synthetic demonstrations: authenticated mode uses one shared owner credential; public mode gives each browser session a separate expiring synthetic workspace. Neither mode provides multi-user production identity.