Skip to main content
The Cashfree Agent Skills CLI adds Cashfree Payments product knowledge directly into your AI coding assistant. It generates product-specific skill files — markdown documents containing API references, code examples, webhook guides, and integration best practices — and places them in the standard skills directory for your chosen assistant.

​
Supported products

Each product has its own dedicated skill file with complete integration documentation:
ProductCommand argumentSkill file created
Payment Gateway (PG)pgAPI references, checkout integration, webhook handling, SDK examples.
Secure IDsecure-idBank verification, PAN, GSTIN, Aadhaar, DigiLocker, Video KYC.
SubscriptionssubscriptionsPlans, recurring payments, subscription lifecycle management.
Cross Bordercross-borderInternational payment collection, multi-currency support.
PayoutspayoutsFund transfers to bank accounts, UPI, cards, and wallets.

​
Installation

Run the following command in your project root, specifying the product you want to add: 
npx @cashfreepayments/agent-skills add <product>
For example, to add Payment Gateway skills: 
npx @cashfreepayments/agent-skills add pg
This interactive CLI guides you through selecting your preferred AI coding assistants.

​
Supported assistants

The tool supports a wide range of modern AI coding environments:
AssistantSkills directorySkill file path
Cursor.cursor/skills/cashfree/.cursor/skills/cashfree/<product>.md
Claude Code.claude/skills/cashfree/.claude/skills/cashfree/<product>.md
VS Code Copilot.github/skills/cashfree/.github/skills/cashfree/<product>.md
GitHub Copilot CLI.github/skills/cashfree/.github/skills/cashfree/<product>.md
Gemini CLI.gemini/skills/cashfree/.gemini/skills/cashfree/<product>.md
Antigravity.agent/skills/cashfree/.agent/skills/cashfree/<product>.md
OpenCode.opencode/skills/cashfree/.opencode/skills/cashfree/<product>.md
OpenAI Codex CLI.codex/skills/cashfree/.codex/skills/cashfree/<product>.md

​
Usage examples

1

Interactive setup

The easiest way to get started is to run the tool interactively:
npx @cashfreepayments/agent-skills add pg
2

Configure your AI coding assistant

Select the assistant you wish to use for the Payment Gateway (PG) integration:
  • Cursor
  • Claude Code
  • OpenCode
  • VS Code Copilot
  • Gemini CLI
  • Antigravity
  • GitHub Copilot CLI
  • OpenAI Codex CLI
3

Non-interactive / CI setup

You can also run the tool in non-interactive mode by passing arguments:
npx @cashfreepayments/agent-skills add pg --frameworks cursor,vscode-copilot
4

Add multiple products

You can run the command multiple times to add skills for different products:
npx @cashfreepayments/agent-skills add pg --frameworks cursor
npx @cashfreepayments/agent-skills add payouts --frameworks cursor
npx @cashfreepayments/agent-skills add subscriptions --frameworks cursor
This creates separate skill files for each product under .cursor/skills/cashfree/.

​
What it does

When you run the command, it:
  1. Creates the skills directory (for example, .cursor/skills/cashfree/) in the standard location expected by your assistant.
  2. Generates a product-specific skill file (for example, pg.md) containing complete API documentation, code examples in multiple languages, webhook integration guides, and security best practices.
The skill file is a self-contained markdown document that your AI assistant can reference when answering questions. Once added, you can ask your AI assistant questions like:
  • “How do I create a payment order with Cashfree?”
  • “What is the API for checking payment status?”
  • “Show me a code example for UPI intent flow.”
  • “How do I verify webhook signatures?”
The assistant uses the embedded skill file to provide accurate, detailed answers with code examples.

​
Available products

​
Payment Gateway (pg)

Complete PG integration guide including:
  • Create Order API with SDKs (Node.js, Python, Java, Go).
  • Frontend Checkout SDK (Web, Android, iOS, Flutter, React Native).
  • Webhook events, payload structure, and signature verification.
  • Payment status handling and security checklist.

​
Secure ID (secure-id)

Identity verification APIs including:
  • Bank account verification.
  • PAN and GSTIN verification.
  • Aadhaar-based verification via DigiLocker.
  • Video KYC and biometric verification.

​
Subscriptions (subscriptions)

Recurring payments integration including:
  • Plan creation and management.
  • Subscription lifecycle APIs.
  • Payment schedule handling.

​
Cross Border (cross-border)

International payment collection including:
  • Cross-border order creation.
  • Multi-currency support.
  • Settlement to overseas bank accounts.

​
Payouts (payouts)

Fund transfer integration including:
  • Transfers to bank accounts, UPI, cards, and wallets.
  • V1 (Bearer token) and V2 (Direct auth) APIs.
  • Beneficiary management and transfer status.

​
Resources

Explore additional resources to help you get started with the Cashfree Agent Skills.

GitHub Repository

View the source code, report issues, and contribute to the toolkit.

npm Package

View the package on npm for installation and version details.

​
Troubleshooting

  • Restart: Most AI assistants require a restart to pick up new skill files.
  • Verify file: Check that the skill file (for example, .cursor/skills/cashfree/pg.md) was created in your project root.
  • Check directory: Ensure the skills/cashfree/ directory exists under the correct base directory for your assistant.
If you see EACCES errors when running the command, try running it with sudo or check your npm permissions, although npx usually handles this automatically.
Make sure you are using one of the valid product names: pg, secure-id, subscriptions, cross-border, or payouts.