Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Quản lý tài nguyên Dodo Payments của bạn, chạy truy vấn sử dụng AI đối với tài khoản của bạn, tạo phiên thanh toán, và kiểm tra webhooks — tất cả từ terminal. CLI đi kèm với một TUI tương tác, trợ lý AI tích hợp do MCP cung cấp và kiểm tra webhook ngoại tuyến.

Tính năng

  • TUI tương tác — khởi chạy dodo mà không có đối số để mở giao diện tương tác đầy đủ với bảng lệnh, lịch sử và thông báo trực tiếp.
  • Trợ lý AI tích hợp sẵn — hỏi câu hỏi hoặc thực hiện hành động bằng tiếng Anh đơn giản với /ai. Không cần thiết lập thêm, chạy dodopayments-mcp tại chỗ.
  • Bảo mật mặc định — API keys được lưu trữ trong kho bí mật của hệ điều hành của bạn (macOS Keychain, Windows Credential Vault, Linux libsecret). Không có cấu hình văn bản đơn giản trên đĩa.
  • Tự động cập nhật — CLI kiểm tra phiên bản mới khi khởi động và thông báo cho bạn trong ứng dụng. Chạy /update để nâng cấp tại chỗ.
  • Công cụ Webhook — lắng nghe các webhook trực tiếp hoặc kích hoạt tải trọng offline cho phát triển cục bộ.

Cài đặt

Cài đặt CLI trong một dòng trên macOS hoặc Linux:
curl -fsSL https://dodopayments.com/install.sh | sh

Cài đặt với npm hoặc Bun

Nếu bạn đã có Node hoặc Bun, việc cài đặt qua package-manager luôn tải phiên bản mới nhất:
npm install -g dodopayments-cli

Cài đặt thủ công (không cần Node / Bun)

Nếu bạn không muốn chạy mã nguồn từ xa tới sh, hãy tự tải về nhị phân.
1

Download the binary

Tải nhị phân cho nền tảng của bạn từ GitHub Release mới nhất.
Nền tảngNhị phân
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
2

Rename the binary to `dodo`

mv ./dodo-cli-* ./dodo && chmod +x ./dodo
3

Move it to a directory on your PATH

sudo mv ./dodo /usr/local/bin/
Trên Windows, di chuyển đến C:\Windows\System32 yêu cầu quyền quản trị viên.
4

(Optional) Verify the download

Mỗi bản phát hành công bố một SHA256SUMS.txt. Kiểm tra tải về của bạn với:
shasum -a 256 -c SHA256SUMS.txt

Xác thực

Trước khi sử dụng các lệnh yêu cầu xác thực, hãy đăng nhập bằng API key của bạn:
dodo login
Hoặc từ bên trong TUI tương tác:
/login
Lưu đồ đăng nhập sẽ:
  1. Mở trình duyệt của bạn tới trang API Keys của Dodo Payments.
  2. Nhắc bạn dán API Key của bạn.
  3. Yêu cầu bạn chọn một môi trường — Test Mode hoặc Live Mode.
  4. Lưu thông tin đăng nhập trong kho bí mật của hệ điều hành của bạn (Keychain trên macOS, Credential Vault trên Windows, libsecret trên Linux).
Vì thông tin đăng nhập được lưu trữ trong kho bí mật của hệ điều hành, bạn có thể được yêu cầu nhập mật khẩu thiết bị của bạn lần đầu tiên CLI đọc hoặc ghi thông tin đăng nhập. Nếu bạn nâng cấp từ phiên bản cũ hơn, bất kỳ API key văn bản thuần túy nào hiện có sẽ được di chuyển vào kho bí mật và tệp cũ sẽ được xóa tự động.

Chuyển đổi chế độ và đăng xuất

Bạn có thể giữ một khóa trong Test Mode và một khóa trong Live Mode được xác thực cùng một lúc. Để xóa thông tin đăng nhập:
dodo logout
Lưu đồ đăng xuất cho phép bạn chọn giữa Tất cả tài khoản, Test Mode, hoặc Live Mode một cách độc lập.

Sử dụng

Bạn có thể sử dụng CLI ở hai chế độ.

1. TUI tương tác (khuyến nghị)

Chạy dodo mà không có đối số để khởi chạy giao diện tương tác đầy đủ:
dodo
/ để mở bảng lệnh, hoặc chỉ cần bắt đầu gõ — bất kỳ thứ gì không phải lệnh dấu gạch chéo đều được gửi đến trợ lý AI.
LệnhMô tả
/helpHiển thị tham chiếu lệnh
/updateKiểm tra và cài đặt cập nhật CLI
/loginXác thực bằng API key
/logoutĐăng xuất khỏi một hoặc tất cả các môi trường
/clearXóa màn hình TUI
/exitThoát TUI (cũng: gõ exit, hoặc nhấn Esc hai lần)

2. Các lệnh con trực tiếp

Chạy lệnh trực tiếp mà không vào TUI:
dodo <category> <sub-command> [args...]
Ví dụ:
dodo payments list 1
dodo customers create
dodo wh trigger
Bảng tham chiếu dưới đây mô tả từng lệnh. Trong TUI, thêm / vào trước; trong chế độ trực tiếp, bỏ /.

Trợ lý AI

Hỏi câu hỏi hoặc thực hiện hành động bằng ngôn ngữ tự nhiên. Trợ lý sử dụng dodopayments-mcp chạy tại chỗ — không cần thiết lập thêm hoặc quy trình OAuth, và lưu lượng AI của bạn không rời khỏi máy của bạn ngoại trừ để nói chuyện với nhà cung cấp mô hình.
LệnhMô tả
/ai <query>Hỏi trợ lý AI một câu hỏi hoặc đưa ra một hướng dẫn
(bất kỳ văn bản không phải dấu gạch chéo)Được gửi đến trợ lý AI theo mặc định trong khi ở TUI
Ví dụ:
how much revenue did I make this week?
/ai create a new customer named Acme Inc.
/ai find my last failed payment
Trợ lý tôn trọng môi trường hoạt động của bạn (Test / Live), vì vậy nó chỉ hoạt động trên dữ liệu từ môi trường bạn đang đăng nhập vào.

Tham chiếu lệnh

Sản phẩm

Quản lý danh mục sản phẩm của bạn.
LệnhMô tả
dodo products list <page>Danh sách sản phẩm
dodo products createMở bảng điều khiển để tạo sản phẩm
dodo products info <id>Xem chi tiết cho một sản phẩm cụ thể

Thanh toán

Xem các giao dịch thanh toán.
LệnhMô tả
dodo payments list <page>Danh sách thanh toán
dodo payments info <id>Lấy thông tin về một thanh toán cụ thể

Khách hàng

Quản lý cơ sở khách hàng của bạn.
LệnhMô tả
dodo customers list <page>Danh sách khách hàng
dodo customers createTạo khách hàng mới
dodo customers update <id>Cập nhật một khách hàng hiện có

Giảm giá

Quản lý mã giảm giá và giảm giá.
LệnhMô tả
dodo discounts list <page>Danh sách giảm giá
dodo discounts createTạo giảm giá mới theo phần trăm
dodo discounts delete <id>Xóa giảm giá theo ID

Giấy phép

Quản lý giấy phép phần mềm.
LệnhMô tả
dodo licences list <page>Danh sách giấy phép

Addons

Quản lý addons sản phẩm.
LệnhMô tả
dodo addons list <page>Danh sách addons
dodo addons createMở bảng điều khiển để tạo addon
dodo addons info <id>Xem chi tiết cho một addon cụ thể

Hoàn tiền

Xem thông tin hoàn tiền.
LệnhMô tả
dodo refunds list <page>Danh sách hoàn tiền
dodo refunds info <id>Xem chi tiết cho một hoàn tiền cụ thể

Thanh toán

Tạo phiên thanh toán được lưu trữ.
LệnhMô tả
dodo checkout newTạo tương tác phiên thanh toán được lưu trữ và nhận liên kết thanh toán

Webhooks

CLI bao gồm hai công cụ mạnh mẽ để kiểm tra webhooks trong quá trình phát triển: một listener chuyển tiếp các webhook kiểm tra trực tiếp đến máy chủ cục bộ của bạn, và một trigger gửi tải trọng webhook giả đến bất kỳ điểm cuối nào.
LệnhMô tả
dodo wh listenLắng nghe các webhooks theo thời gian thực và chuyển tiếp chúng đến máy chủ phát triển cục bộ của bạn
dodo wh triggerKích hoạt sự kiện webhook kiểm tra tương tác — ngay cả khi đã đăng xuất

Lắng nghe các webhooks

Chuyển tiếp webhooks từ Dodo Payments trực tiếp đến máy chủ phát triển cục bộ của bạn theo thời gian thực.
dodo wh listen
1

Enter your local endpoint URL

Cung cấp URL cục bộ nơi bạn muốn nhận webhooks (ví dụ: http://localhost:3000/webhook).
2

Automatic setup

CLI tự động tạo một điểm cuối webhook trên tài khoản Dodo Payments của bạn nếu chưa có, sau đó mở kết nối WebSocket để nhận các sự kiện theo thời gian thực.
3

Receive and forward

Khi một sự kiện webhook bắn ra (từ một thanh toán thử nghiệm, thay đổi đăng ký, v.v.), CLI nhận, đăng nhập loại sự kiện và chuyển tiếp yêu cầu đầy đủ với tiêu đề và nội dung thân đến điểm cuối cục bộ của bạn. Phản hồi từ điểm cuối của bạn được ghi lại và gửi lại.
dodo wh listen yêu cầu một khóa API Test Mode. Khóa Live Mode không được hỗ trợ bởi lưu đồ lắng nghe.
Listener bảo lưu các tiêu đề webhook gốc (webhook-id, webhook-signature, webhook-timestamp) khi chuyển tiếp đến điểm cuối cục bộ của bạn, để bạn có thể kiểm tra logic xác minh chữ ký của mình.

Kích hoạt webhooks kiểm tra

Gửi tải trọng webhook giả mạo đến bất kỳ điểm cuối nào để kiểm tra nhanh mà không cần tạo các giao dịch thực tế.
dodo wh trigger
Lưu đồ /wh trigger hướng dẫn bạn qua:
  1. Thiết lập một điểm cuối URL đích
  2. Chọn một sự kiện cụ thể để kích hoạt từ menu tương tác
dodo wh trigger không yêu cầu đăng nhập. Nó hoạt động như một trình tạo tải webhook cục bộ/ngoại tuyến.
Các sự kiện được kích hoạt không được ký. Trong khi kiểm tra, vô hiệu hóa xác minh chữ ký webhook trên điểm cuối của bạn — ví dụ, sử dụng unsafe_unwrap() thay vì unwrap() trong bộ xử lý webhook của bạn chỉ khi kiểm tra.

Các sự kiện webhook hỗ trợ

Danh mụcSự kiện
Subscriptionactive, updated, on_hold, renewed, plan_changed, cancelled, failed, expired
Paymentsucceeded, failed, processing, cancelled
Refundsucceeded, failed
Disputeopened, expired, accepted, cancelled, challenged, won, lost
Licensecreated

Biến môi trường

BiếnMô tả
DODO_WH_TEST_SERVER_URLGhi đè URL máy chủ relay webhook mặc định được sử dụng bởi dodo wh listen

Cập nhật

CLI kiểm tra phiên bản mới hơn khi khởi động và đưa ra thông báo trong thanh trạng thái khi có sẵn. Để nâng cấp:
/update
Hoặc, chạy lại trình cài đặt để nâng cấp tại chỗ:
curl -fsSL https://dodopayments.com/install.sh | sh

Tài nguyên

GitHub Repository

Xem mã nguồn và các bản phát hành

npm Package

Xem trên npm registry

Hỗ trợ

Last modified on May 22, 2026