Install the Razorpay CLI

Install the Razorpay CLI on macOS, Linux or Windows to interact with Razorpay APIs from your terminal.

The Razorpay CLI lets you interact with Razorpay APIs directly from your terminal. Use it to test integrations, trigger events, manage resources and automate workflows in your CI/CD pipelines. The source code is available on GitHub.

To install the Razorpay CLI, you must complete the following actions:

1. Download and Install the Binary
2. Configure Your API Credentials

Step 1: Download and Install the Binary

Quick Install (macOS and Linux)

Run the install script to automatically detect your OS and architecture, download the latest binary, and install it to ~/.local/bin:

Bash

curl -fsSL https://razorpay.com/cli/latest/install.sh | bash

Homebrew (macOS)

Bash

brew install razorpay/razorpay-cli/razorpay

Scoop (Windows)

PowerShell

scoop bucket add razorpay https://github.com/razorpay/scoop-razorpay-cli.git

PowerShell

scoop install razorpay

Select the tab for your operating system and follow the steps.

macOS

1. Download the binary.

   Download the binary that matches your CPU architecture.

Architecture	Download
Apple Silicon	razorpay_mac-os_arm64.tar.gz
Intel	razorpay_mac-os_x86_64.tar.gz

Or download using curl:

Apple Silicon:

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_mac-os_arm64.tar.gz | tar -xz

Intel:

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_mac-os_x86_64.tar.gz | tar -xz

2. Extract the archive.

Bash

tar -xvf razorpay_mac-os_<arch>.tar.gz

3. Make the binary executable and remove the macOS quarantine attribute.

Bash

chmod +x ./razorpay
xattr -d com.apple.quarantine ./razorpay

4. Move the binary to your execution path.

Bash

sudo mv razorpay /usr/local/bin/

5. Verify the installation.

Bash

razorpay --version

Linux

1. Download the binary.

   Download the binary that matches your architecture and preferred package format.

Architecture	Format	Download
x86-64	tar.gz	razorpay_linux_x86_64.tar.gz
ARM64	tar.gz	razorpay_linux_arm64.tar.gz
x86-64	deb	razorpay_linux_amd64.deb
ARM64	deb	razorpay_linux_arm64.deb
x86-64	rpm	razorpay_linux_amd64.rpm
ARM64	rpm	razorpay_linux_arm64.rpm

Or download using curl:

x86-64 (tar.gz):

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_linux_x86_64.tar.gz | tar -xz

ARM64 (tar.gz):

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_linux_arm64.tar.gz | tar -xz

x86-64 (deb):

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_linux_amd64.deb -o /tmp/razorpay.deb \
&& sudo dpkg -i /tmp/razorpay.deb

ARM64 (deb):

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_linux_arm64.deb -o /tmp/razorpay.deb \
&& sudo dpkg -i /tmp/razorpay.deb

x86-64 (rpm):

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_linux_amd64.rpm -o /tmp/razorpay.rpm \
&& sudo rpm -i /tmp/razorpay.rpm

ARM64 (rpm):

Bash

curl -fsSL https://razorpay.com/cli/latest/razorpay_linux_arm64.rpm -o /tmp/razorpay.rpm \
&& sudo rpm -i /tmp/razorpay.rpm

2. Install based on the format you downloaded.

   For tar.gz:

Bash

tar -xvf razorpay_linux_<arch>.tar.gz
sudo mv razorpay /usr/local/bin/

For deb (Debian and Ubuntu):

Bash

sudo dpkg -i razorpay_linux_<arch>.deb

For rpm (RHEL, Fedora and Amazon Linux):

Bash

sudo rpm -i razorpay_linux_<arch>.rpm

3. Verify the installation.

Bash

razorpay --version

Windows

1. Download the binary.

   Download the binary that matches your architecture.

Architecture	Download
x86-64	razorpay_windows_x86_64.zip
x86 (32-bit)	razorpay_windows_i386.zip

Or download using curl in PowerShell:

x86-64:

PowerShell

curl.exe -fsSL -o razorpay_windows_x86_64.zip https://razorpay.com/cli/latest/razorpay_windows_x86_64.zip

x86 (32-bit):

PowerShell

curl.exe -fsSL -o razorpay_windows_i386.zip https://razorpay.com/cli/latest/razorpay_windows_i386.zip

2. Extract the archive.

   Open PowerShell in the folder where you downloaded the file and run:

PowerShell

Expand-Archive razorpay_windows_<arch>.zip -DestinationPath .

3. Add the binary to your Path environment variable.

   1. Open System Properties → Environment Variables.
   2. Under System variables, select Path → Edit → New.
   3. Add the folder path where razorpay.exe is located.
   4. Click OK to save the changes.

4. Verify the installation.

   Open a new terminal and run:

Bash

razorpay --version

Step 2: Configure Your API Credentials

After installing the CLI, configure it with your API credentials to start making requests. Generate your keys from the Razorpay Dashboard.

You can configure credentials in two ways:

Option 1: Pass credentials directly in the command

Bash

razorpay configure --key-id rzp_test_xxxxxxxxxxxx --key-secret xxxxxxxxxxxxxxxxxxxx

Option 2: Use the interactive prompt

Run the command without arguments and enter your credentials when prompted:

Bash

razorpay configure

Bash

Razorpay Key ID [None]: rzp_test_xxxxxxxxxxxx
Razorpay Key Secret [None]: xxxxxxxxxxxxxxxxxxxx

Test Mode and Live Mode

The CLI supports both Test Mode and Live Mode keys. Use Test Mode keys (prefixed with rzp_test_) while building and testing your integration.

Verify Your Setup

Once configured, run razorpay --version to confirm the CLI is installed and ready to use.

Related Information

• Authentication
• Sandbox Setup
• API Reference Guide