@catena/cli 0.0.0-bootstrap.0 → 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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 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 accept and charge a
+      fee for accepting 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2025 Catena Labs, Inc.
+
+   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

@@ -1,3 +1,315 @@
 # @catena/cli
 
-Bootstrap placeholder. Use @catena/cli@latest once the CI-published release is available.
+Catena CLI lets an approved agent act from a named local profile: inspect the
+policy it has been assigned, list the accounts and counterparties it can see,
+and submit policy-checked money movement intents.
+
+Run it without installing:
+
+```bash
+pnpm dlx @catena/cli <command> [args]
+```
+
+The package exposes the `catena` binary. Examples use `pnpm dlx @catena/cli` so
+they work directly from npm; pnpm selects `catena` because it is the package's
+only executable.
+
+## How it works
+
+`link` connects a profile to an agent through a browser approval flow. After
+linking, Catena writes routing metadata to `~/.catena/profiles.json` and stores
+session material in the OS credential store. Every other command resolves the
+selected profile and prints pretty JSON to stdout so it can be piped through
+tools such as `jq`; pass `--json` to print compact single-line JSON instead.
+`unlink` revokes only the selected profile's server link and removes that
+profile's local credential.
+
+By default the CLI talks to `https://api.catena.com`. Set `CATENA_API_URL` when
+you need to target another Catena environment.
+
+## First-time setup
+
+To create or choose an agent from the Catena console, run `link` without an
+agent id. Use `--name` to suggest a name when the console creates a new agent;
+the approving operator can edit it before approval.
+
+```bash
+pnpm dlx @catena/cli link --name "Hermes Runtime"
+```
+
+To link a specific existing agent, ask the Catena customer for the agent id
+shown in the Catena console. It looks like `agent_...`.
+
+```bash
+pnpm dlx @catena/cli link <agent-id>
+```
+
+The browser approval window stays open for up to 5 minutes. If the approval is
+denied or times out, run the command again.
+
+Useful flags:
+
+| Flag         | Description                                             | Default                         |
+| ------------ | ------------------------------------------------------- | ------------------------------- |
+| `--bank-url` | Bank API URL.                                           | `$CATENA_API_URL` or prod       |
+| `--name`     | Suggested name when creating an agent from the console. | none                            |
+| `--profile`  | Credential profile name.                                | configured default or `default` |
+
+## Commands
+
+### `link [agent-id]`
+
+Connect the selected profile to an agent. Omit `agent-id` to create or choose an
+agent from the Catena console.
+
+```bash
+pnpm dlx @catena/cli link --name "Hermes Runtime"
+pnpm dlx @catena/cli link <agent-id>
+```
+
+### `unlink`
+
+Disconnect the selected profile from its agent and remove its local credential.
+
+```bash
+pnpm dlx @catena/cli unlink
+```
+
+### `profiles current`
+
+Show the selected credential profile and its routing metadata.
+
+```bash
+pnpm dlx @catena/cli profiles current
+```
+
+### `profiles list`
+
+List linked credential profiles and mark the selected default profile.
+
+```bash
+pnpm dlx @catena/cli profiles list
+```
+
+### `profiles use <profile>`
+
+Set the selected default profile. The profile must already be linked.
+
+```bash
+pnpm dlx @catena/cli profiles use mcp
+```
+
+### `whoami`
+
+Show which agent the selected profile is linked to.
+
+```bash
+pnpm dlx @catena/cli whoami
+```
+
+### `policy show`
+
+Show the policy assigned to the linked agent. Read this before creating
+counterparties or submitting intents.
+
+```bash
+pnpm dlx @catena/cli policy show
+```
+
+The policy includes `policyCapabilities` rows. Each row grants one `read`,
+`send`, or `transfer` capability on one account and carries block or approval
+`rules`. It also includes `counterpartyRules` for send recipient scope and
+counterparty creation.
+
+### `accounts list`
+
+List the accounts available under the agent's policy.
+
+```bash
+pnpm dlx @catena/cli accounts list
+```
+
+### `counterparties list`
+
+List counterparties and their rails. Use rail ids from this output with `send`.
+
+```bash
+pnpm dlx @catena/cli counterparties list
+```
+
+### `counterparties create bank`
+
+Request creation of a bank-rail counterparty. The command returns an intent
+envelope; policy may complete it, block it, or route it to approval.
+
+```bash
+pnpm dlx @catena/cli counterparties create bank \
+  --name "Acme Vendor" \
+  --bank-name "Chase" \
+  --routing-number 021000021 \
+  --account-number 123456789 \
+  --address-street "123 Main St" \
+  --address-city "New York" \
+  --address-state NY \
+  --address-postal-code 10001
+```
+
+Required flags: `--name`, `--bank-name`, `--routing-number`, `--account-number`,
+`--address-street`, `--address-city`, `--address-state`,
+`--address-postal-code`.
+
+Optional flags: `--account-type` (`checking` or `savings`), `--address-country`,
+`--email`.
+
+### `counterparties create wallet`
+
+Request creation of a wallet-rail counterparty. The command returns an intent
+envelope; policy may complete it, block it, or route it to approval.
+
+```bash
+pnpm dlx @catena/cli counterparties create wallet \
+  --name "DAO Treasury" \
+  --address 0xAbC123...
+```
+
+Required flags: `--name`, `--address`.
+
+Optional flags: `--network` (defaults to `base`; Base is the only supported
+wallet network), `--email`.
+
+### `send`
+
+Request a USD send to a counterparty rail.
+
+```bash
+pnpm dlx @catena/cli send \
+  --account acct_... \
+  --rail cprl_... \
+  --amount 125.00 \
+  --method ach
+```
+
+Required flags: `--account`, `--rail`, `--amount`, `--method`.
+
+Optional flags: `--memo`, `--description`, `--idempotency-key`.
+
+`--method` must be one of `ach`, `wire`, or `on-chain`.
+
+To check whether a send completed, run `intents get <id>` with the returned
+intent id. If the original command is retried with the same details after a
+network error, the server deduplicates it automatically and returns the original
+intent instead of sending again. Use `--idempotency-key` only when you
+intentionally want another payment with the same details.
+
+### `transfer`
+
+Request a USD transfer between two accounts visible to the agent.
+
+```bash
+pnpm dlx @catena/cli transfer \
+  --from acct_... \
+  --to acct_... \
+  --amount 125.00
+```
+
+Required flags: `--from`, `--to`, `--amount`.
+
+Optional flags: `--memo`, `--description`, `--idempotency-key`.
+
+To check whether a transfer completed, run `intents get <id>` with the returned
+intent id. Identical retries are deduplicated automatically and return the
+original intent. Use `--idempotency-key` only when you intentionally want
+another transfer with the same details.
+
+### `accounts balance`
+
+Read an account balance through the policy engine.
+
+```bash
+pnpm dlx @catena/cli accounts balance acct_...
+```
+
+### `accounts transactions`
+
+Read an account's transaction history through the policy engine. Granted by the
+same read access as `accounts balance` and never creates an intent. Returns
+`{ accountId, transactions, total }` newest-first.
+
+```bash
+pnpm dlx @catena/cli accounts transactions acct_...
+```
+
+Optional flags: `--start` / `--end` (ISO 8601 bounds), `--limit` (default 50,
+max 200), `--offset` (pagination). Page until
+`offset + transactions.length >= total`.
+
+### `accounts deposit-address`
+
+Read an account deposit address through the policy engine. `--network` and
+`--asset` default to `base` and `usdc`.
+
+```bash
+pnpm dlx @catena/cli accounts deposit-address acct_... --network base --asset usdc
+```
+
+### `intents get`
+
+Look up the current state of an intent created by this agent.
+
+```bash
+pnpm dlx @catena/cli intents get int_...
+```
+
+The response includes a `data` field carrying the associated result once one
+exists: the linked transaction for `send`/`transfer` intents, or the created
+counterparty for `create_counterparty`. It is `null` when there is no associated
+result yet. When `data` has a console destination, `metadata.dataUrl` contains
+the browser URL for that result.
+
+### `feedback <message>`
+
+Send free-form feedback about Catena to the Catena team. Use it to report a bug,
+request a feature, or share an observation about working with Catena. The
+message must be 1-4000 characters after trimming. Write-only: previously
+submitted feedback cannot be read back.
+
+Pass the message as a single quoted argument, or omit it and pipe the message on
+stdin. Use stdin (or `--` before the argument) when the message starts with `-`
+or spans multiple lines.
+
+```bash
+pnpm dlx @catena/cli feedback "The transfer flow worked great"
+
+pnpm dlx @catena/cli feedback <<'EOF'
+- transfer failed
+- policy was confusing
+EOF
+```
+
+## Output and exit codes
+
+Non-`link` commands print pretty JSON to stdout. Errors print to stderr and exit
+with code 1.
+
+`send` and `transfer` exit as soon as the intent is created and any immediate
+next action is submitted. Inspect the returned `.status` and `.reasons` fields,
+then use `pnpm dlx @catena/cli intents get <intent-id>` to check whether it
+later completes, requires approval, or fails.
+
+## Configuration
+
+| Variable         | Purpose       | Default                  |
+| ---------------- | ------------- | ------------------------ |
+| `CATENA_API_URL` | Bank API URL. | `https://api.catena.com` |
+
+## Discovering options
+
+Every command supports `--help`.
+
+```bash
+pnpm dlx @catena/cli --help
+pnpm dlx @catena/cli send --help
+pnpm dlx @catena/cli counterparties create --help
+pnpm dlx @catena/cli counterparties create bank --help
+pnpm dlx @catena/cli counterparties create wallet --help
+```