dodopayments-cli 2.2.0 → 3.0.0

package/README.md

@@ -12,7 +12,7 @@
     <img src="https://img.shields.io/discord/1305511580854779984?label=Discord&logo=discord&color=5865F2" alt="Discord" />
   </a>
   <a href="LICENSE">
-    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT" />
+    <img src="https://img.shields.io/badge/license-GPL--3.0-blue.svg" alt="License: GPL-3.0" />
   </a>
 </p>
 
@@ -20,21 +20,34 @@
   <a href="#installation">Installation</a> •
   <a href="#authentication">Authentication</a> •
   <a href="#usage">Usage</a> •
+  <a href="#ai-assistant">AI</a> •
   <a href="#webhooks">Webhooks</a> •
   <a href="#contributing">Contributing</a>
 </p>
 
 ---
 
-Manage your [Dodo Payments](https://dodopayments.com/) resources and test webhooks directly from the terminal. Built for developers who prefer the command line.
+Manage your [Dodo Payments](https://dodopayments.com/) resources, test webhooks, and run AI-powered queries against your account — all from the terminal.
+
+<p align="center">
+  <img src="./.github/assets/cli-preview.png" alt="Dodo Payments CLI preview" width="100%" />
+</p>
+
+## Features
+
+- **Interactive TUI** — launch `dodo` with no arguments to open the full interactive interface with command palette, history, and live notifications.
+- **AI assistant built in** — ask questions or take actions in plain English with `/ai`. No extra setup, runs `dodopayments-mcp` locally.
+- **Secure by default** — API keys are stored in your OS secret store (macOS Keychain, Windows Credential Vault, Linux libsecret). No plaintext config on disk.
+- **Auto update** — the CLI checks for new versions and notifies you in-app. Run `/update` to upgrade in place.
+- **Webhook tooling** — listen for live webhooks or trigger payloads offline for local development.
 
 ## Installation
 
-We provide various ways to install the CLI:
+We provide multiple ways to install the CLI.
 
-> **Note:** If you have Node or Bun installed, it's highly recommended to use that installation method.
+> **Note:** If you already have Node or Bun installed, the package-manager installs are the simplest path and always pull the latest version.
 
-### Using npm (Recommended)
+### Using npm
 
 ```bash
 npm install -g dodopayments-cli
@@ -46,144 +59,241 @@ npm install -g dodopayments-cli
 bun install -g dodopayments-cli
 ```
 
-### Manual Installation
+### Manual installation (no Node / Bun required)
 
-1. Download the latest release from [GitHub Releases](https://github.com/dodopayments/dodopayments-cli/releases) that matches your system.
+1. Download the binary for your platform from the latest [GitHub Release](https://github.com/dodopayments/dodopayments-cli/releases).
 
-2. Extract the downloaded file to a directory of your choice.
+   | Platform | Binary |
+   | --- | --- |
+   | macOS (Apple Silicon) | `dodo-cli-darwin-arm64` |
+   | macOS (Intel) | `dodo-cli-darwin-x64` |
+   | Linux (x86_64) | `dodo-cli-linux-x64` |
+   | Linux (arm64) | `dodo-cli-linux-arm64` |
+   | Windows (x86_64) | `dodo-cli-windows-x64.exe` |
 
-3. Rename the binary file to `dodo`:
-   - **Linux/macOS:** `mv ./dodopayments-cli-* ./dodo`
-   - **Windows:** `ren .\dodopayments-cli-* .\dodo`
+2. Rename the binary to `dodo`:
+   - **Linux / macOS:** `mv ./dodo-cli-* ./dodo && chmod +x ./dodo`
+   - **Windows:** `ren .\dodo-cli-windows-x64.exe .\dodo.exe`
 
-4. Move the binary to a directory in your system's PATH:
-   - **Linux/macOS:** `sudo mv ./dodo /usr/local/bin/`
-   - **Windows:** `move .\dodo C:\Windows\System32\dodo` (requires admin mode)
+3. Move it to a directory on your `PATH`:
+   - **Linux / macOS:** `sudo mv ./dodo /usr/local/bin/`
+   - **Windows:** `move .\dodo.exe C:\Windows\System32\dodo.exe` (requires admin)
+
+4. (Optional) Verify the download against `SHA256SUMS.txt` published with each release:
+   ```bash
+   shasum -a 256 -c SHA256SUMS.txt
+   ```
 
 ## Authentication
 
-Before using the CLI, you must authenticate:
+Before using authenticated commands you need to log in:
 
 ```bash
 dodo login
 ```
 
-This command will:
-1. Open your browser to the Dodo Payments API Keys page
-2. Prompt you to enter your API Key
-3. Ask you to select the environment (**Test Mode** or **Live Mode**)
-4. Store your credentials locally to `~/.dodopayments/api-key`
+…or, from inside the interactive TUI:
+
+```
+/login
+```
+
+The login flow will:
+
+1. Open your browser to the Dodo Payments API Keys page.
+2. Prompt you to paste your API Key.
+3. Ask you to select an environment — **Test Mode** or **Live Mode**.
+4. Store the credentials in your OS secret store (Keychain on macOS, Credential Vault on Windows, libsecret on Linux).
+
+> **Heads up:** Because we use the OS secret store, you may be prompted for your **device password** the first time the CLI reads or writes credentials. If you're upgrading from an older version, any existing plaintext API key will be **migrated to the secret store and the legacy file deleted** automatically.
+
+### Switching modes / logging out
+
+You can keep one **Test Mode** and one **Live Mode** key authenticated at the same time. To clear credentials, use:
+
+```bash
+dodo logout
+# or, in the TUI
+/logout
+```
 
-Note: Upto 1 Test Mode & 1 Live Mode can be used at the same time
+The logout flow lets you choose between **All accounts**, **Test Mode**, or **Live Mode** independently.
 
 ## Usage
 
-The general syntax is:
+You can use the CLI in two modes:
+
+### 1. Interactive TUI (recommended)
+
+Just run:
 
 ```bash
-dodo <category> <sub-command>
+dodo
 ```
 
-### Products
+This launches the full interactive interface. Type `/` to open the command palette, or just start typing — anything that isn't a slash command is sent to the AI assistant.
+
+Use:
+- `/help` to see all commands.
+- `/exit` (or press `Esc` twice) to quit.
+- `/clear` to clear the screen.
+- `/update` to upgrade to the latest version when one is available.
+
+### 2. Direct subcommands
+
+You can also run commands directly without entering the TUI:
+
+```bash
+dodo <category> <sub-command> [args...]
+```
+
+For example:
+
+```bash
+dodo payments list 1
+dodo customers create
+dodo wh trigger
+```
+
+The reference tables below show every command. In the TUI, prefix them with `/`; in direct mode, drop the `/`.
+
+---
 
-Manage your products catalog.
+### AI Assistant
+
+Ask questions or take actions in natural language. The assistant uses `dodopayments-mcp` running locally — no additional setup or OAuth flow required, and your AI traffic doesn't leave your machine except to talk to the model provider.
 
 | Command | Description |
-|---------|-------------|
-| `dodo products list` | List all products |
-| `dodo products create` | Open dashboard to create a product |
-| `dodo products info` | View details for a specific product |
+| --- | --- |
+| `/ai <query>` | Ask the AI assistant a question or give it an instruction |
+| _(any non-slash text)_ | Sent to the AI assistant by default while in the TUI |
 
-### Payments
+Examples:
+
+```
+how much revenue did I make this week?
+/ai create a new customer named Acme Inc.
+/ai find my last failed payment
+```
 
-View payment transactions.
+The assistant respects your active environment (Test / Live).
+
+### Products
 
 | Command | Description |
-|---------|-------------|
-| `dodo payments list` | List all payments |
-| `dodo payments info` | Get information about a specific payment |
+| --- | --- |
+| `/products list <page>` | List products |
+| `/products create` | Open the dashboard to create a product |
+| `/products info <id>` | View details for a specific product |
 
-### Customers
+### Payments
 
-Manage your customer base.
+| Command | Description |
+| --- | --- |
+| `/payments list <page>` | List payments |
+| `/payments info <id>` | Get information about a specific payment |
+
+### Customers
 
 | Command | Description |
-|---------|-------------|
-| `dodo customers list` | List all customers |
-| `dodo customers create` | Create a new customer profile |
-| `dodo customers update` | Update an existing customer's details |
+| --- | --- |
+| `/customers list <page>` | List customers |
+| `/customers create` | Create a new customer |
+| `/customers update <id>` | Update an existing customer |
 
 ### Discounts
 
-Manage coupons and discounts.
-
 | Command | Description |
-|---------|-------------|
-| `dodo discounts list` | List all discounts |
-| `dodo discounts create` | Create a new percentage-based discount |
-| `dodo discounts delete` | Remove a discount by ID |
+| --- | --- |
+| `/discounts list <page>` | List discounts |
+| `/discounts create` | Create a new percentage-based discount |
+| `/discounts delete <id>` | Remove a discount by ID |
 
 ### Licenses
 
-Manage software licenses.
-
 | Command | Description |
-|---------|-------------|
-| `dodo licences list` | List all licenses |
+| --- | --- |
+| `/licences list <page>` | List licenses |
 
 ### Addons
 
-Manage your add-ons.
-
 | Command | Description |
-|---------|-------------|
-| `dodo addons list` | List all addons |
-| `dodo addons create` | Open dashboard to create an addon |
-| `dodo addons info` | View details for a specific addon |
+| --- | --- |
+| `/addons list <page>` | List addons |
+| `/addons create` | Open the dashboard to create an addon |
+| `/addons info <id>` | View details for a specific addon |
 
 ### Refunds
 
-Manage your refunds.
+| Command | Description |
+| --- | --- |
+| `/refunds list <page>` | List refunds |
+| `/refunds info <id>` | View details for a specific refund |
+
+### Checkout
 
 | Command | Description |
-|---------|-------------|
-| `dodo refund list` | List all refunds |
-| `dodo refund info` | View details for a specific refund |
+| --- | --- |
+| `/checkout new` | Interactively create a hosted checkout session and get a payment link |
 
 ### Webhooks
 
 Manage and test webhooks directly from the CLI.
 
 | Command | Description |
-|---------|-------------|
-| `dodo wh listen` | Listen for webhooks from Dodo Payments in real time and forward them to your local dev server |
-| `dodo wh trigger` | Trigger a test webhook event interactively |
+| --- | --- |
+| `/wh listen` | Listen for webhooks in real time and forward them to your local dev server |
+| `/wh trigger` | Trigger a test webhook event interactively — even while logged out |
 
-> **Note:** The webhook triggering doesn't support signing requests yet. Please disable webhook signature verification while triggering. A simple way to do this is using `unsafe_unwrap()` instead of `unwrap()` in the webhook endpoint **during testing only**.
+The `/wh trigger` flow guides you through:
 
-> **Note:** The webhook listening tool will only work with a test mode API key. If you use a live mode API key, it won't work.
-
-This interactive tool guides you through:
 1. Setting a destination **endpoint URL**
-3. Selecting a specific **Event** to trigger
+2. Selecting a specific **event** to trigger
+
+> **Note:** `/wh trigger` does **not** require login. It works as a local/offline webhook payload generator.
+
+> **Note:** Triggered events are **not signed** yet. While testing, disable webhook signature verification on your endpoint — for example, use `unsafe_unwrap()` instead of `unwrap()` in your webhook handler **during testing only**.
+
+> **Note:** `/wh listen` requires a **Test Mode** API key. Live Mode keys are not supported by the listen flow.
 
 ### Supported Webhook Events
 
 | Category | Events |
-|----------|--------|
+| --- | --- |
 | **Subscription** | `active`, `updated`, `on_hold`, `renewed`, `plan_changed`, `cancelled`, `failed`, `expired` |
 | **Payment** | `success`, `failed`, `processing`, `cancelled` |
 | **Refund** | `success`, `failed` |
 | **Dispute** | `opened`, `expired`, `accepted`, `cancelled`, `challenged`, `won`, `lost` |
 | **License** | `created` |
 
+### Session commands
+
+| Command | Description |
+| --- | --- |
+| `/help` | Show the command reference |
+| `/update` | Check for and install a CLI update |
+| `/login` | Authenticate with an API key |
+| `/logout` | Sign out of one or all environments |
+| `/clear` | Clear the TUI screen |
+| `/exit` | Exit the TUI (also: type `exit`, or press `Esc` twice) |
+
+## Updates
+
+The CLI checks for a newer version on startup and surfaces a notification in the status bar when one is available. To upgrade:
+
+```
+/update
+```
+
+Or, if you installed via a package manager, the usual `npm i -g dodopayments-cli` / `bun i -g dodopayments-cli` will also work.
+
 ## Contributing
 
-We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated.
+We welcome contributions from the community — whether you're fixing bugs, adding new features, or improving docs.
 
 Please read our [Contributing Guide](./CONTRIBUTING.md) to get started. We also have a [Code of Conduct](./CODE_OF_CONDUCT.md) that we expect all contributors to follow.
 
-### Ways to Contribute
+### Ways to contribute
 
 - Report bugs and suggest features
 - Improve documentation
@@ -193,13 +303,28 @@ Please read our [Contributing Guide](./CONTRIBUTING.md) to get started. We also
 
 ## Support
 
-- [Discord Community](https://discord.gg/bYqAp4ayYh) - Get help and discuss with the community
-- [GitHub Issues](https://github.com/dodopayments/dodopayments-cli/issues) - Report bugs or request features
-- [Documentation](https://docs.dodopayments.com) - Learn more about Dodo Payments
+- [Discord Community](https://discord.gg/bYqAp4ayYh) — chat with the team and other users
+- [GitHub Issues](https://github.com/dodopayments/dodopayments-cli/issues) — report bugs or request features
+- [Documentation](https://docs.dodopayments.com) — learn more about Dodo Payments
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+This project is licensed under the **GNU General Public License v3.0 or later** — see the [LICENSE](./LICENSE) file for the full text.
+
+```
+Dodo Payments CLI — manage Dodo Payments resources from the terminal.
+Copyright (C) 2025  Dodo Payments
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+```
 
 ---
 

package/SECURITY.md

@@ -6,7 +6,7 @@ We actively support the following versions with security updates:
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.1.x   | :white_check_mark: |
+| 3.x   | :white_check_mark: |
 
 ## Reporting a Vulnerability
 
@@ -50,13 +50,6 @@ Please include the following information in your report:
 
 When using Dodo Payments CLI, please follow these security best practices:
 
-### API Keys
-
-- **Never share your API keys** with anyone
-- **Use test mode keys** for development and testing
-- **Rotate keys** if you suspect they may have been compromised
-- The CLI stores your API key locally at `~/.dodopayments/api-key` - ensure this file has appropriate permissions
-
 ### Running the CLI
 
 - **Download only from official sources**: npm, GitHub releases, or bun
@@ -75,9 +68,7 @@ The CLI stores the following data locally:
 
 | Data | Location | Purpose |
 |------|----------|---------|
-| API Key | `~/.dodopayments/api-key` | Authentication |
-
-Ensure your home directory has appropriate access controls to protect this sensitive data.
+| API Key | OS secret store (Credential Vault, Keychain, etc.) | Authentication |
 
 ## Vulnerability Disclosure Policy
 

package/build-binaries.ts

@@ -1,4 +1,5 @@
 import { rename, rm } from "node:fs/promises";
+import solidPlugin from "@opentui/solid/bun-plugin";
 
 const targets: any = [
     "bun-darwin-x64",
@@ -17,6 +18,7 @@ for (const target of targets) {
         entrypoints: ["./src/index.ts"],
         outdir: tempDir,
         target: "bun",
+        plugins: [solidPlugin],
         compile: {
             // `as any` cause Bun doesn't provide type of exact platforms
             target: target as any,

package/bunfig.toml

@@ -0,0 +1 @@
+preload = ["@opentui/solid/preload"]