Developer-first CLI tool for PayMongo integration development with local webhook forwarding, payment testing, and team collaboration features. See USER_GUIDE.md for comprehensive documentation.
npm install paymongo-cli> A developer-first CLI for PayMongo integration with local webhook forwarding.
PayMongo CLI is the official-feel command-line tool designed to streamline your development process with PayMongo. It solves the biggest pain point in payment integration: testing webhooks locally.
---
- Local Webhook Forwarding: Seamlessly receive PayMongo webhooks on your localhost using integrated ngrok tunneling.
- Zero-Config Setup: Get started in seconds with paymongo init.
- Payment Testing: Create and monitor payment intents and payments directly from your terminal.
- Real-time Monitoring: Watch webhook events as they happen with formatted terminal logs.
- Privacy-First Analytics: Optional local webhook event tracking to improve your development workflow (opt-in only).
- Team Collaboration: Sync configurations across your team using GitHub integration.
- Bulk Operations: Import/export payments and webhooks for easy migration between environments.
- Rate Limiting Protection: Built-in API abuse prevention with configurable limits and automatic backoff.
- Secure Management: Encrypted storage for your API keys.
---
- Node.js: v20.0.0 or higher
- ngrok account: Required for webhook forwarding (free tier works great!)
``bash`
npm install -g paymongo-cli
To use the dev server with webhook forwarding, you need an ngrok authtoken:
1. Sign up at ngrok.com
2. Copy your authtoken from the ngrok dashboard
3. Configure it in the CLI:
`bash`
paymongo config set ngrok.authtoken YOUR_AUTHTOKEN
---
`bash`
mkdir my-paymongo-app
cd my-paymongo-app
paymongo init
This command sets up a tunnel and starts forwarding webhooks to your local app.
`bash`
paymongo dev --port 3000
In another terminal, simulate a successful payment:
`bash`
paymongo trigger --event payment.paid
---
PayMongo CLI includes built-in rate limiting to prevent accidental API abuse and protect your test credits. Rate limits are automatically enforced with:
- Default Limits: 100 requests/minute in test environment, 50 in live
- Endpoint-Specific Limits: Stricter limits for expensive operations like webhook creation
- Automatic Backoff: Failed requests are automatically retried with exponential backoff
- Configurable Settings: Customize limits via paymongo config rate-limit
`bashEnable rate limiting
paymongo config rate-limit enable
$3
Use
with any command to temporarily disable rate limiting:``bash
paymongo payments list --no-rate-limit
---Analytics (Optional)
PayMongo CLI can optionally track webhook events to provide insights into your development workflow. All analytics data is stored locally and never transmitted to external servers.
$3
- Opt-in Only: Analytics is disabled by default and must be explicitly enabled
- Local Storage: All data remains on your machine
- No External Transmission: Data is never sent to PayMongo or third parties
- Full Control: Disable anytime and clear all stored data
$3
`bash
Enable webhook event tracking
paymongo config analytics enableView current analytics status
paymongo config analytics statusDisable analytics (default)
paymongo config analytics disable
``$3
When enabled, the CLI tracks:
- Webhook Events: Successful and failed webhook deliveries
- Event Types: Payment events, source events, and more
- Response Times: Processing performance metrics
- Error Analysis: Failed webhook reasons and patterns
Analytics data helps you:
- Monitor webhook reliability during development
- Identify integration issues early
- Optimize your webhook handling code
- Track testing patterns and event frequencies
---
Commands Reference
| Command | Description |
| :--------------------------- | :------------------------------------------------------ |
|
| Initialize a new project and set up credentials. |
| paymongo dev | Start local development server with webhook forwarding. |
| paymongo payments | Manage payments and payment intents. |
| paymongo webhooks | List, create, and manage PayMongo webhooks with filtering by status and event type. |
| paymongo config | View and modify CLI configuration. |
| paymongo config analytics | Configure webhook analytics settings. |
| paymongo config rate-limit | Configure rate limiting settings. |
| paymongo team | Sync configurations with your team via GitHub. |
| paymongo trigger | Simulate webhook events locally for testing. |> Use
paymongo ---
- Installation Guide - Platform-specific setup instructions.
- User Guide - Detailed step-by-step instructions.
- API Reference - Complete command and option reference.
- Troubleshooting - Solutions to common issues.
- Contributing - Help improve the PayMongo CLI.
---
PayMongo CLI is crafted to empower Filipino developers building the next generation of fintech solutions.
This project is licensed under the MIT License - see the LICENSE file for details.