@settlemint/dalp-cli 3.1.33-main.43433008600 → 3.1.33-release.43440124932

package/LICENSE

@@ -1,8 +1,162 @@
-# SettleMint Commercial License
+# SETTLEMINT COMMERCIAL CUSTOMER SOURCE LICENSE
+
+**("License")**
+
+---
+
+## TL;DR (NON-BINDING SUMMARY)
+
+- You may view, fork, modify, and run this code ONLY while you have an active, paid contract with SettleMint.
+- You may use it internally (cloud, on-prem, or hybrid) only as agreed in your contract.
+- You may NOT resell it, offer it as a service, publish it, or use it to build or operate a competing product.
+- When your contract ends, your right to use the software ends immediately. You must stop all deployments and delete active copies.
+- This is NOT open source.
+
+*This summary is informational only. The legal terms below control.*
+
+---
 
 Copyright © 2025 SettleMint NV
 All rights reserved.
 
-SettleMint distributes DALP as container images and Helm charts under SettleMint's commercial license. DALP is distributed without its source code.
+This License governs the use of the Software (as defined below) and is a proprietary, source-available license. It is not an open-source license.
+
+By accessing, copying, modifying, or using the Software, You agree to be bound by this License and confirm that You are a Customer with an Active Contract.
+
+---
+
+## 1. DEFINITIONS
+
+**1.1 "Licensor"**
+SettleMint NV, a company incorporated under Belgian law, or any affiliated entity explicitly identified in the applicable Commercial Agreement.
+
+**1.2 "Customer" or "You"**
+The legal entity that has entered into an Active Contract with Licensor and whose employees or contractors access or use the Software.
+
+**1.3 "Commercial Agreement"**
+Any master services agreement, subscription agreement, order form, statement of work, or similar contract executed between Licensor and Customer governing commercial terms.
+
+**1.4 "Active Contract"**
+A Commercial Agreement that is in force, not terminated, and for which all undisputed fees due are paid.
+
+**1.5 "Software"**
+The source code, object code, build scripts, configuration files, documentation, and any other materials made available by Licensor in this repository, including all updates and modifications thereto.
+
+**1.6 "Derivative Works"**
+Any modification, adaptation, translation, or other work based on or incorporating the Software, as defined under Book XI of the Belgian Code of Economic Law.
+
+**1.7 "Authorized Use"**
+Use of the Software solely for Customer's internal business purposes and strictly within the scope permitted by the Active Contract.
+
+**1.8 "Authorized Deployment"**
+Any installation, environment, system, blockchain network, cluster, or runtime explicitly permitted under the Active Contract, whether cloud-based, on-premises, or hybrid.
+
+**1.9 "Competitive Use"**
+Any use of the Software or Derivative Works to develop, operate, market, or support a product or service that competes with Licensor's products or services, or that could reasonably substitute for them.
+
+---
+
+## 2. LICENSE GRANT
+
+**2.1 Conditional License Grant**
+Subject to continuous compliance with this License and the existence of an Active Contract, Licensor grants Customer a limited, non-exclusive, non-transferable, non-sublicensable, revocable license to:
+
+(a) access and review the Software;
+(b) copy the Software for internal use;
+(c) modify the Software and create Derivative Works;
+(d) deploy and run the Software and Derivative Works solely for Authorized Use and only in Authorized Deployments.
+
+**2.2 Forking**
+Customer may create private forks of the Software solely for Authorized Use. All such forks remain subject to this License.
+
+**2.3 No Implied Rights**
+No rights are granted except as expressly stated. All rights not expressly granted are reserved by Licensor.
+
+---
+
+## 3. RESTRICTIONS
+
+Customer shall not, directly or indirectly:
+
+(a) use the Software without an Active Contract;
+(b) deploy the Software outside Authorized Deployments;
+(c) provide the Software or any Derivative Work as a service, platform, or product to third parties, unless explicitly permitted in writing;
+(d) sublicense, distribute, sell, lease, or transfer the Software or any Derivative Work to any third party;
+(e) engage in any Competitive Use;
+(f) use the Software to benchmark, reverse-engineer, or analyze Licensor's products for competitive purposes;
+(g) publish, disclose, or make publicly available the Software or any fork thereof;
+(h) remove or obscure copyright, trademark, or proprietary notices.
+
+---
+
+## 4. OWNERSHIP
+
+**4.1 Licensor IP**
+Licensor retains all right, title, and interest in and to the Software.
+
+**4.2 Customer Modifications**
+Customer retains ownership of original modifications it creates; however, Customer may not use, execute, deploy, or distribute any Derivative Work that includes or depends on the Software except as permitted under an Active Contract.
+
+**4.3 Feedback and Contributions**
+Any feedback, suggestions, or contributions provided by Customer may be used by Licensor without restriction. To the extent such contributions constitute copyrightable works, Customer grants Licensor a perpetual, worldwide, royalty-free, irrevocable license to use, modify, and distribute them.
+
+---
+
+## 5. TERMINATION
+
+**5.1 Automatic Termination**
+This License automatically terminates upon termination or expiration of the Active Contract.
+
+**5.2 Effect of Termination**
+Upon termination, Customer must immediately:
+
+(a) cease all use and deployment of the Software and Derivative Works;
+(b) delete all running instances, binaries, containers, and deployments;
+(c) destroy or delete all copies of the Software, except that one archival copy of source code may be retained solely for legal or compliance purposes.
+
+No right to resume use or deployment survives termination.
+
+**5.3 Survival**
+Sections relating to ownership, restrictions, liability, governing law, and jurisdiction survive termination.
+
+---
+
+## 6. WARRANTY DISCLAIMER
+
+THE SOFTWARE IS PROVIDED "AS IS". TO THE MAXIMUM EXTENT PERMITTED BY BELGIAN LAW, LICENSOR DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+
+---
+
+## 7. LIMITATION OF LIABILITY
+
+To the maximum extent permitted by Belgian law, Licensor shall not be liable for any indirect, incidental, consequential, or special damages, including loss of profits, data, or business interruption, even if advised of the possibility.
+
+Nothing in this License limits liability that cannot be limited under mandatory Belgian law.
+
+---
+
+## 8. GOVERNING LAW AND JURISDICTION
+
+This License is governed by and construed in accordance with the laws of Belgium, excluding conflict-of-law rules.
+
+Any dispute arising out of or in connection with this License shall be subject to the exclusive jurisdiction of the courts of Brussels.
+
+---
+
+## 9. MISCELLANEOUS
+
+**9.1 Entire Agreement**
+This License, together with the applicable Commercial Agreement, constitutes the entire agreement regarding the Software.
+
+**9.2 Conflict**
+In case of conflict, the Commercial Agreement prevails.
+
+**9.3 Severability**
+If any provision is held invalid, the remaining provisions remain in full force.
+
+**9.4 No Waiver**
+Failure to enforce any provision does not constitute a waiver.
+
+---
 
-Access to the DALP source code, or escrow of it, can be agreed in a contract with SettleMint as a paid option.
+**END OF LICENSE**

package/README.md

@@ -8,72 +8,197 @@
   </p>
 </p>
 
+<p align="center">
+<a href="https://www.npmjs.com/package/@settlemint/dalp-cli" rel="nofollow"><img src="https://img.shields.io/npm/v/@settlemint/dalp-cli" alt="npm version"></a>
+<a href="https://www.npmjs.com/package/@settlemint/dalp-cli" rel="nofollow"><img src="https://img.shields.io/npm/dw/@settlemint/dalp-cli" alt="npm downloads"></a>
+</p>
+
+<div align="center">
+  <a href="https://settlemint.com">Website</a>
+  <span>&nbsp;&nbsp;&bull;&nbsp;&nbsp;</span>
+  <a href="https://www.npmjs.com/package/@settlemint/dalp-cli">NPM</a>
+  <span>&nbsp;&nbsp;&bull;&nbsp;&nbsp;</span>
+  <a href="mailto:support@settlemint.com">Support</a>
+  <br />
+</div>
+
 ## About
 
-kubectl-style CLI over the public promise-based `@settlemint/dalp-sdk`.
+The DALP CLI provides a command-line interface for interacting with the Digital Asset Lifecycle Platform. Manage security tokens, identities, compliance, and platform operations directly from the terminal — or let your AI agent do it for you.
 
-Command paths come from the **OpenAPI URL** (static segments) plus the HTTP verb:
+## Installation
 
-| HTTP   | URL                                  | CLI                                                  |
-| ------ | ------------------------------------ | ---------------------------------------------------- |
-| `GET`  | `/api/v2/tokens`                     | `dalp get tokens`                                    |
-| `GET`  | `/api/v2/tokens/{assetId}`           | `dalp get tokens <assetId>`                          |
-| `GET`  | `/api/v2/tokens/{assetId}/documents` | `dalp get tokens documents <tokenAddress>`           |
-| `POST` | `/api/v2/tokens/{assetId}/mints`     | `dalp create tokens mints <tokenAddress> --body '…'` |
+```bash
+# npm
+npm install -g @settlemint/dalp-cli
 
-The generator extracts OpenAPI text at **compile time** into
-`src/generated/openapi-surface.json`. This file drives help, args, options, enums,
-examples, and hints for agents (Incur `--llms` / MCP / skills).
-The file is gitignored; `bun run --cwd cli codegen` writes it, and every Turbo task that reads it depends on that codegen.
+# bun
+bun add -g @settlemint/dalp-cli
+```
 
-## Setup
+## Quick Start
 
 ```bash
-dalp config set apiUrl https://dalp.example.com
-dalp login                         # asks for your wallet PIN; set DALP_WALLET_CODE where no terminal can ask
-dalp org switch org_…
+# Authenticate (OAuth 2.0 device flow — no passwords in your terminal)
+dalp login
+
+# Show current user
 dalp whoami
+
+# List all tokens
+dalp tokens list --format json
 ```
 
-## Examples
+## Worked Examples
+
+End-to-end flows you can run as-is. Add `--format json` to any command for machine-readable output.
+
+### Authenticate and inspect the platform
 
 ```bash
-dalp get tokens --help
-dalp get tokens index --sort name --page '{"limit":25}'
-dalp get tokens documents index 0x…
-dalp create tokens mints 0x… --body '{"recipients":[…],"amounts":[…]}'
-# Mutations ask the platform to hold the response until settlement (TTY spinner + status).
-# Agents get streamed status events either way.
-dalp create tokens mints 0x… --body '…' --no-wait
+# Authenticate against a specific instance (or set DALP_URL)
+dalp login --url https://dalp.example.com
+
+# Confirm who you are and which organization is active
+dalp whoami
+
+# List deployed systems, then the tokens they hold
+dalp system list
+dalp tokens list --format json
 ```
 
-## Status UX (Incur best practices)
+Expected outcome: a stored API key in your keychain, your user and organization echoed back, and a token inventory in JSON.
 
-Long-running work uses `async *run` generators ([Incur Streaming](https://github.com/wevm/incur#streaming)):
+> SDK equivalent: `createDalpClient` with `dalp.token.list()` and `dalp.system.read()` — see the [`@settlemint/dalp-sdk` README](../sdk/README.md).
 
-- **Humans (TTY):** braille spinner on stderr with clear phase messages (`Preparing…`, `Submitting METHOD /url…`, `Waiting for settlement…`).
-- **Agents (`c.agent`):** structured yields `{ phase, message, status? }` with no spinner noise on stdout.
-- **Blockchain mutations:** the wait belongs to the platform, not the CLI. The default asks it to hold the response until the write settles; `--no-wait` asks it to answer immediately. Either way the command reports what came back, and a write that outlives the wait prints `Request accepted; the transaction is still settling` with the handle. Follow that handle with `dalp get transaction-requests stream <transactionId>`; the CLI does not poll it for you.
-- **SSE endpoints** (`…/stream`): each Server-Sent Event is yielded as a chunk. Use `--format jsonl` for NDJSON (`{"type":"chunk","data":…}`).
-- **Errors:** public `message` stays the headline; `why` / `fix` and mapped resource `links` become an Incur CTA (`meta.cta`) so agents get next commands without scraping free text.
-- **Success links:** JSON:API `links` (`next` / `prev` / related) map to suggested CLI commands when present.
+### Create an asset and verify it round-trip
 
 ```bash
-dalp get transaction-requests stream <transactionId>
-dalp get tokens create stream <transactionId>
-dalp get actions stream
-dalp get monitoring api request-logs stream
+# Create a bond token (type-specific fields go in --json)
+dalp tokens create --name "Bund 7Y" --symbol BUND7 --decimals 18 --type bond --country-code 276 --json '{"isin":"DE000BU27014"}'
+
+# Find it in the token list (filterable by search query)
+dalp tokens list --query BUND7
+
+# Read its details and holder list by contract address
+dalp tokens read <address>
+dalp tokens holders <address>
+```
+
+Expected outcome: a new bond token deployed through the platform, retrievable by address with an empty holder list.
+
+> SDK equivalent: the typed `dalp.token.*` namespace in [`@settlemint/dalp-sdk`](../sdk/README.md).
+
+### Register an investor identity and run KYC
+
+```bash
+# Create an on-chain identity for a wallet, then register it with a country code
+dalp identities create --wallet 0x1234...abcd
+dalp identities register --wallet 0x1234...abcd --country 276
+
+# Check the registration landed
+dalp identities registration-status 0x1234...abcd
+
+# Start a KYC submission for the user and send it for review
+dalp kyc version-create <userId>
+dalp kyc version-submit --version-id <versionId>
 ```
 
-## Architecture
+Expected outcome: a registered on-chain identity for the wallet and a KYC version in review.
+
+> SDK equivalent: `dalp.system.identity.*` and `dalp.user.kyc.*` in [`@settlemint/dalp-sdk`](../sdk/README.md).
+
+### Using the CLI from an AI agent
+
+Every command accepts `--format json` (also `yaml`, `md`, `jsonl`; the default is token-efficient TOON) and a `--json` shorthand, so output is always machine-parseable. Authentication is interactive by design: `dalp login` runs an OAuth 2.0 device flow in a browser, then persists an API key to the system keychain — subsequent commands, including agent-driven ones, run non-interactively against that stored credential. Instance and organization can be pinned via the `DALP_URL` and `DALP_ORG` environment variables.
+
+## AI Agent Integration
+
+The CLI is built from the ground up for AI agents. Every command is a typed, validated tool that agents can discover and call autonomously.
+
+### Model Context Protocol (MCP)
+
+Run the CLI as an MCP server, exposing every command as a tool with Zod-validated parameters, descriptions, and examples:
+
+```bash
+# Auto-register with your AI agent (Claude Code, Cursor, Codex, OpenClaw)
+dalp mcp add
+
+# Or run the MCP server directly
+dalp --mcp
+```
+
+### Skills
+
+Auto-generate skill files from command metadata for agent discovery:
+
+```bash
+# Install skill files for your agent
+dalp skills add
+
+# View as Markdown or JSON Schema
+dalp --llms
+dalp --schema
+```
+
+### Structured Output
+
+Every command supports `--format json` for machine-readable output, making it composable with shell tools and agent workflows:
+
+```bash
+# Progressive discovery: systems → tokens → holders
+dalp system list --format json
+dalp tokens list --format json
+dalp tokens holders <address> --format json
+```
 
-| Concern   | Implementation                                                                  |
-| --------- | ------------------------------------------------------------------------------- |
-| Framework | Incur + Zod                                                                     |
-| HTTP      | `createDalpClient` + route ids from `@settlemint/dalp-sdk/routes`               |
-| Docs      | Compile-time OpenAPI surface                                                    |
-| Auth      | Device login → API key for one organization; `org switch` accepts only that org |
+### Supported Agents
+
+Auto-detection and one-command setup for Claude Code, Codex Desktop, Cursor, and OpenClaw.
+
+## Commands
+
+| Command                   | Description                         |
+| ------------------------- | ----------------------------------- |
+| `login`                   | Authenticate with the DALP platform |
+| `logout`                  | End the current session             |
+| `whoami`                  | Show the current authenticated user |
+| `tokens`                  | Manage security tokens              |
+| `token-sales`             | Manage token sales                  |
+| `tokens documents`        | Manage token-related documents      |
+| `identity`                | Manage on-chain identities          |
+| `identity-recoveries`     | Recover lost identities             |
+| `kyc`                     | Manage KYC verification             |
+| `compliance-templates`    | Manage compliance templates         |
+| `asset-type-templates`    | Manage asset type templates         |
+| `user`                    | Manage platform users               |
+| `contacts`                | Manage contacts                     |
+| `account`                 | Manage accounts                     |
+| `admin`                   | Administrative operations           |
+| `auth`                    | Authentication configuration        |
+| `config`                  | CLI configuration                   |
+| `exchange-rates`          | View exchange rates                 |
+| `external-tokens`         | Manage external tokens              |
+| `fixed-yield-schedules`   | Manage fixed yield instruments      |
+| `monitoring`              | Platform monitoring                 |
+| `search-results`          | Search across the platform          |
+| `settings`                | Platform settings                   |
+| `system`                  | System administration               |
+| `blockchain-transactions` | View transactions                   |
+| `xvp-settlements`         | Cross-value-payment operations      |
+| `actions`                 | Manage actions                      |
+
+## Security
+
+- **OAuth 2.0 Device Authorization Grant** (RFC 8628) — no passwords in your terminal
+- Credentials stored in system keychain (macOS) or encrypted file (Linux/Windows)
+- API key auto-creation during login
+- Agents operate with your user permissions only
+
+## Configuration
+
+The CLI resolves configuration from (in order): CLI flags, environment variables, project config (`.dalprc.json`), and user config (`~/.config/dalp/`).
 
 ## License
 
-See `LICENSE`.
+This project is licensed under the **SettleMint Commercial Customer Source License**. See the LICENSE file included in the package for full terms.