Skip to main content
The CLI provides two ways to get started: add ZendFi to a project you already have, or create a brand new project from a template.

​
zendfi init

Adds ZendFi to your current project with automatic framework detection, SDK installation, and file generation. 
zendfi init [options]

​
Options

FlagDescriptionDefault
--framework <name>Override framework detectionAuto-detected
--skip-installSkip @zendfi/sdk installationfalse
-y, --yesSkip all confirmation promptsfalse

​
What It Does

1

Detect your framework

The CLI inspects your package.json and project structure to identify your framework:
FrameworkDetection Method
Next.js (App Router)next dependency + app/ directory + version >= 13
Next.js (Pages Router)next dependency without App Router
Express.jsexpress dependency
Reactreact dependency without next
Vue.jsvue dependency
SvelteKit@sveltejs/kit dependency
Node.jsFallback for any package.json project
It also detects your package manager from lock files (bun.lockb, pnpm-lock.yaml, yarn.lock, or npm) and checks for TypeScript support.
2

Install the SDK

Runs the appropriate install command for your package manager:
# npm
npm install @zendfi/sdk

# yarn
yarn add @zendfi/sdk

# pnpm
pnpm add @zendfi/sdk

# bun
bun add @zendfi/sdk
Skip this step with --skip-install if you want to handle installation yourself.
3

Generate project files

Creates framework-specific files tailored to your project:Next.js (App Router):
FilePurpose
lib/zendfi.tsPre-configured ZendFi client instance
app/api/webhooks/zendfi/route.tsWebhook handler route
.env.localEnvironment variables template
Next.js (Pages Router):
FilePurpose
lib/zendfi.tsPre-configured ZendFi client instance
pages/api/webhooks/zendfi.tsWebhook handler API route
.env.localEnvironment variables template
Express.js:
FilePurpose
src/lib/zendfi.tsPre-configured ZendFi client instance
src/routes/webhooks.tsWebhook handler route
.envEnvironment variables template
Other frameworks:
FilePurpose
src/lib/zendfi.tsPre-configured ZendFi client instance
src/webhooks.tsWebhook handler
.envEnvironment variables template
Existing files are never overwritten. If a file already exists, the CLI skips it and lets you know.
4

Display next steps

Shows framework-specific code examples for creating your first payment and wiring up webhooks.

​
Example

$ cd my-nextjs-app
$ zendfi init

Initializing ZendFi in your project...

✓ Detected: Next.js (App Router)

  Project Information:
  Framework:       Next.js (App Router)
  Version:         14.0.0
  TypeScript:      Yes
  Package Manager: npm

? Continue with ZendFi setup? Yes
✓ Installed @zendfi/sdk
✓ Created lib/zendfi.ts
✓ Created app/api/webhooks/zendfi/route.ts
✓ Created .env.local

ZendFi setup complete!

Next steps:

  1. Add your API key to .env.local
  2. Create a payment in your app
  3. Implement webhook handlers
  4. Test your integration

​
Non-Interactive Mode

For CI/CD pipelines or scripts, use the -y flag to skip all prompts: 
zendfi init -y --skip-install

​
create-zendfi-app

Create a complete ZendFi project from a pre-built template. This is a standalone package that wraps the create command with an interactive wizard. 
npx create-zendfi-app [project-name] [options]

​
Options

FlagDescriptionDefault
--template <name>Template to useInteractive selection
--env <environment>Environment (development or production)development
-y, --yesSkip confirmation promptsfalse
--skip-installSkip dependency installationfalse
--skip-gitSkip git initializationfalse

​
Templates

A full-featured online store built with Next.js 14 App Router.Features:
  • Product catalog page
  • Shopping cart
  • Checkout with ZendFi payment integration
  • Order confirmation page
  • Webhook handler for payment events
  • Embedded admin dashboard
npx create-zendfi-app my-store --template nextjs-ecommerce
A subscription-based SaaS application with Next.js 14 App Router.Features:
  • Subscription plans page
  • User authentication
  • Customer portal
  • Webhook handler for subscription events
  • Usage tracking
  • Payment history
npx create-zendfi-app my-saas --template nextjs-saas
A backend API server with pre-configured payment endpoints.Features:
  • Payment creation endpoint
  • Webhook handler
  • CORS configuration
  • Environment variable setup
  • TypeScript support
npx create-zendfi-app my-api --template express-api

​
Scaffolding Flow

​
Template Variables

Templates support these placeholder variables that are replaced during scaffolding:
VariableReplaced With
{{PROJECT_NAME}}Your chosen project name
{{API_KEY}}Your API key (if provided during setup)
{{WEBHOOK_SECRET}}Your webhook secret (if provided)
{{ENVIRONMENT}}Selected environment (development or production)

​
Example

$ npx create-zendfi-app my-store

 Project Configuration:
  Name:            my-store
  Template:        Next.js E-commerce
  Framework:       Next.js 14 (App Router)
  Environment:     development
  Package Manager: npm

? Continue with this configuration? Yes
✓ Project directory created
✓ Project scaffolded successfully!
✓ API key saved to .env file
✓ Dependencies installed
✓ Git initialized

  Your ZendFi project is ready!

  cd my-store
  npm run dev

​
Package Manager Detection

Both zendfi init and create-zendfi-app automatically detect your preferred package manager:
Lock FilePackage Manager
bun.lockbbun
pnpm-lock.yamlpnpm
yarn.lockyarn
(none)npm
Detection checks for lock files in order of priority, with npm as the fallback.