Skip to content
Zirzir

Installation

Zirzir has two paths to getting started:

  1. SDK only (standalone) — install the SDK and talk directly to payment gateways
  2. Full stack (SDK + Server) — self-host the Zirzir server for webhook infrastructure, dashboards, and multi-project support, or use Zirzir Cloud to skip the ops

This page covers the SDK installation. For the full server setup, see the server documentation.

Requirements

Section titled “Requirements”
  • Node.js 18+ (for TypeScript/Node SDK)
  • Python 3.9+ (for Python SDK)
  • Go 1.21+ (for Go SDK)

TypeScript / Node.js

Section titled “TypeScript / Node.js”
Terminal window
# npm
npm install @zirzir/sdk


# yarn
yarn add @zirzir/sdk


# pnpm
pnpm add @zirzir/sdk

TypeScript Configuration

Section titled “TypeScript Configuration”

Zirzir is written in TypeScript and ships with full type definitions. No @types package needed.

Ensure your tsconfig.json has:

{
  "compilerOptions": {
    "moduleResolution": "node16",
    "strict": true
  }
}

Python

Section titled “Python”
Terminal window
pip install zirzir

Requirements

Section titled “Requirements”
zirzir>=0.1.0

Go

Section titled “Go”
Terminal window
go get github.com/recite-labs/zirzir-go

Verify Installation

Section titled “Verify Installation”

TypeScript

Section titled “TypeScript”
import { Zirzir } from '@zirzir/sdk'
console.log(Zirzir.version) // 0.1.0

Python

Section titled “Python”
import zirzir
print(zirzir.__version__)  # 0.1.0

Go

Section titled “Go”
package main


import (
    "fmt"
    "github.com/recite-labs/zirzir-go"
)


func main() {
    fmt.Println(zirzir.Version)
}

Next Steps

Section titled “Next Steps”