Project integration

Overview

The vapi init command intelligently integrates Vapi into your existing codebase. It automatically detects your framework, installs the appropriate SDK, and generates production-ready code examples tailored to your project structure.

In this guide, you’ll learn to:

• Initialize Vapi in any project
• Understand what files are generated
• Customize the initialization process
• Work with different frameworks

Quick start

Navigate to your project directory and run:

$
cd my-project
$
vapi init

The CLI will:

1. Detect your project type and framework
2. Install the appropriate Vapi SDK
3. Generate example components and API routes
4. Create environment configuration templates
5. Provide next steps specific to your setup

How it works

Framework detection

The CLI analyzes your project structure to identify:

• Package files: package.json, requirements.txt, go.mod, etc.
• Configuration files: Framework-specific configs
• Project structure: Directory patterns and file extensions
• Dependencies: Installed packages and libraries

What gets generated

Based on your framework, the CLI generates:

$
vapi init
$
# Detected: Next.js application

Supported frameworks

Frontend frameworks

Mobile frameworks

Backend frameworks

Advanced options

Specify target directory

Initialize in a specific directory:

$
vapi init /path/to/project

Skip SDK installation

Generate only example files without installing packages:

$
vapi init --skip-install

Force framework

Override auto-detection:

$
vapi init --framework react
$
vapi init --framework python

Custom templates

Use your own templates:

$
vapi init --template @myorg/vapi-templates

Environment setup

After initialization, configure your environment:

$
cp .env.example .env

$
VAPI_API_KEY=your-api-key-here

$
VAPI_WEBHOOK_URL=https://your-domain.com/api/vapi/webhook

Common patterns

Adding to monorepos

For monorepos, run init in the specific package:

$
cd packages/web-app
$
vapi init
$
$
cd ../api-server
$
vapi init

CI/CD integration

Add to your build process:

1
# GitHub Actions example
2
- name: Setup Vapi
3
  run: |
4
    curl -sSL https://vapi.ai/install.sh | bash
5
    vapi init --skip-install

Docker environments

Include in your Dockerfile:

1
# Install Vapi CLI
2
RUN curl -sSL https://vapi.ai/install.sh | bash
3
4
# Initialize project
5
RUN vapi init --skip-install

Troubleshooting

$
vapi init --framework react

$
# npm projects
$
sudo npm install
$
$
# Python projects
$
pip install --user vapi-server-sdk

$
vapi init --force

Next steps

After initializing your project:

• Test locally: Use vapi listen to test webhooks
• Create assistants: Build your first voice assistant
• Set up MCP: Enhance your IDE with Vapi intelligence

Example output:

$
$ vapi init
$
🔍 Analyzing project...
$
✓ Detected: Next.js 14 application
$
$
📦 Installing dependencies...
$
✓ Installed @vapi-ai/web@latest
$
✓ Installed @vapi-ai/server-sdk@latest
$
$
📝 Generating files...
$
✓ Created components/VapiButton.tsx
$
✓ Created app/api/vapi/webhook/route.ts
$
✓ Created lib/vapi-client.ts
$
✓ Created .env.example
$
$
🎉 Vapi initialized successfully!
$
$
Next steps:
$
1. Copy .env.example to .env
$
2. Add your VAPI_API_KEY
$
3. Run: npm run dev
$
4. Test the voice button at http://localhost:3000