@barrysongdev4real/flowm-cli

Flowm CLI

Safe local command line interface for inspecting and updating Flowm ledgers.

npx @barrysongdev4real/flowm-cli ledger-info
npx @barrysongdev4real/flowm-cli list-cashflow --limit 20
npx @barrysongdev4real/flowm-cli list-tags
npx @barrysongdev4real/flowm-cli create-tag --name 购物 --color '#5A8D74' --commit
npx @barrysongdev4real/flowm-cli get-tag <tag-id>
npx @barrysongdev4real/flowm-cli update-tag <tag-id> --name 京东购物 --commit
npx @barrysongdev4real/flowm-cli update-cashflow-tags <cashflow-id> --add-tag-id <tag-id> --commit
npx @barrysongdev4real/flowm-cli list-subscriptions
npx @barrysongdev4real/flowm-cli update-subscription <id> --amount 28.00 --commit
npx @barrysongdev4real/flowm-cli list-loans
npx @barrysongdev4real/flowm-cli update-loan <id> --current-principal 1750000.00 --commit
npx @barrysongdev4real/flowm-cli list-budget-periods --status active
npx @barrysongdev4real/flowm-cli budget-progress --budget-period-id <id>
npx @barrysongdev4real/flowm-cli list-linked-cashflow --owner-type loan --owner-id <id>
npx @barrysongdev4real/flowm-cli bind-cashflow --owner-type loan --owner-id <id> --event-id <id> --commit
npx @barrysongdev4real/flowm-cli apply-patch patch.json --dry-run

Writes are guarded and require --commit. By default, commands resolve the active Flowm desktop ledger. Use --db <path> or FLOWM_DB_PATH to target a specific SQLite ledger.

Tag commands cover list-tags, get-tag, create-tag, update-tag, and delete-tag. Updates preserve omitted fields; --clear-color removes a color. Deleting a tag removes its cashflow associations while preserving cashflow records. Tags referenced by budget scopes must be removed from those scopes before deletion. All writes preview by default and require --commit.

update-cashflow-tags <id> accepts one of three modes: repeatable --tag-id to replace the complete tag set; repeatable --add-tag-id and/or --remove-tag-id to edit the existing set; or --clear to remove every tag. Modes cannot be mixed. list-cashflow --tag-id <id> reads matching cashflow.

Budget commands cover sets, periods, items, and progress. Creating, updating, or archiving budget records is dry-run by default and requires --commit.

Subscription and loan commands cover plan listing, detail, creation, updates, archive/cancel flows, forecast occurrence generation, and future pressure summaries. These maintain future plans only; they do not create actual cashflow or asset-liability snapshots.

Cashflow-binding commands link real cashflow events to a subscription or loan as its deductions: list-linked-cashflow reads the bindings, bind-cashflow (repeatable --event-id) and unbind-cashflow <link-id> manage them and are dry-run by default. Bindings are explanatory only and never change forecast plans or statistics.