financy 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Open Finance AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,139 @@
+# financy
+
+Your Open-Finance / Financy banking data — connections, accounts, balances,
+transactions — in the terminal, with machine-first output for scripting, an
+embedded MCP server for agents, and agent skills in the box.
+
+```sh
+npx financy status
+```
+
+## Install
+
+```sh
+npm install -g financy     # or just use npx financy <command>
+```
+
+Node 20+ is the only prerequisite.
+
+## Requirements
+
+The CLI talks to your Open-Finance data through the Financy API, which is a **paid
+feature**. To use it you must:
+
+1. **Register for a Financy account** at [open-finance.ai](https://open-finance.ai).
+2. **Subscribe to a paid plan** (Starter or Pro) — the data API is **not** available
+   on the free plan (every data command returns exit code `4`).
+3. Copy your `clientId`, `clientSecret`, and `userId` from the Financy app →
+   **Settings → API**.
+
+## Setup
+
+```sh
+financy setup                 # interactive prompts (explains where to get the values)
+financy setup --no-input      # read FINANCY_CLIENT_ID / _SECRET / _USER_ID from env (agents/CI)
+```
+
+`setup` validates the credentials against the live API before saving, so an
+unregistered/free account is caught immediately (exit `3` for bad credentials,
+`4` for an ineligible plan).
+
+## Commands
+
+```
+financy status                       Are my connections fresh? one-line-per-bank rollup
+financy connections list|get <id>    Bank/card connections and their fetch state
+financy accounts list|get <id>       Accounts with balances (securities embedded)
+financy transactions list|get <id>   Transactions with --from/--to/--account/--type filters
+financy categories                   The category taxonomy (English + Hebrew)
+financy providers list|branches      Reference data: banks and branches
+financy refresh                      Trigger an on-demand refresh of all connections (20 credits)
+financy config                       Show resolved endpoints + credential sources (secret masked)
+financy skills list|install          Agent skills bundled with the CLI
+financy mcp                          Run the embedded MCP server (stdio)
+```
+
+Debugging tip: `financy config` shows which endpoints and credentials are in effect
+(and whether each came from env or the config file) without ever printing the secret.
+Set `FINANCY_DEBUG=1` to have the raw API response bodies printed to stderr.
+
+Every command takes `--json` for a stable machine-readable envelope
+(`{data, count, nextPage}` for lists, `{data}` for single resources; errors as
+`{error:{code,message}}` on stderr). List commands take `--limit`, `--cursor`, and
+`--all` (auto-paginate). Exit codes: `0` ok · `1` unexpected · `2` usage · `3` auth
+· `4` plan · `5` credits · `6` not-found · `7` api.
+
+## Agent skills
+
+Skills ship inside this package, so they can never drift from the CLI version they
+drive. Install them into a project's `.claude/skills/` directory:
+
+```sh
+financy skills list             # what's in the box
+financy skills install --all    # install every skill here
+financy skills install freshness-check --dir ~/work/analysis
+```
+
+| Skill | What it teaches an agent |
+|---|---|
+| `financy-setup` | Onboarding a user end to end: install, find the credentials, save them without ever echoing the secret, verify, and explain the paid-plan requirement on exit `4`. |
+| `freshness-check` | Reading `financy status --json`, deciding whether the data is current enough to answer with, and confirming the 20-credit cost before triggering a refresh. |
+
+Skills are plain `SKILL.md` files — read them under [`skills/`](skills/) before you
+install them.
+
+## MCP server (for AI agents)
+
+`financy mcp` runs a stdio [Model Context Protocol](https://modelcontextprotocol.io)
+server exposing the command surface 1:1 as `verb_noun` tools (`list_connections`,
+`get_status`, `refresh_connections`, …) with the same `{data, …}` envelopes. Add it
+to Claude Code:
+
+```sh
+claude mcp add financy -- npx financy mcp
+```
+
+Credentials resolve exactly as the CLI does (config file or `FINANCY_*` env vars);
+an unconfigured server returns a structured `NOT_CONFIGURED` error from every tool.
+`refresh_connections` costs 20 credits — its tool description tells agents to
+confirm with the user first.
+
+## Updating
+
+```sh
+financy update
+```
+
+Detects how it was installed and does the right thing: a global install runs
+`npm install -g financy@latest`; under `npx` it reminds you that npx always
+runs the latest; as a project dependency it defers to your project's package manager.
+
+## Releasing
+
+1. Update `CHANGELOG.md` (move items out of _Unreleased_ into the new version).
+2. `npm version <patch|minor|major>` — bumps `package.json` and creates a `vX.Y.Z` tag.
+3. `git push --follow-tags`.
+4. The **Release** workflow (`.github/workflows/release.yml`) runs on the tag: it
+   re-runs lint/typecheck/test/build, verifies the tag matches `package.json`, and
+   publishes to npm with `--provenance` (via the `NPM_TOKEN` secret and `id-token`
+   trusted publishing). The published version shows its provenance attestation on npm.
+
+Before tagging, run the manual staging smoke test (not part of CI) with a real
+paid-org credential:
+
+```sh
+npm run build
+FINANCY_CLIENT_ID=… FINANCY_CLIENT_SECRET=… FINANCY_USER_ID=… \
+FINANCY_AUTH_URL=… FINANCY_API_URL=… FINANCY_CHAT_URL=… FINANCY_AUDIENCE=… \
+npm run smoke
+```
+
+## Spec & design
+
+- **Spec:** [docs/plan/PRD.md](docs/plan/PRD.md)
+- **Build issues:** [docs/plan/build-issues/](docs/plan/build-issues/)
+- **Interface reference** (locked runnable prototype): [docs/plan/prototype/](docs/plan/prototype/)
+
+## License
+
+[Apache-2.0](LICENSE)