### Install and Run Node.js App

Source: https://github.com/deepgram/examples/blob/main/examples/190-daily-co-transcription-node/README.md

Follow these steps to set up the project. Copy the example environment file, add your API keys, install dependencies, and start the server.

```bash
cp .env.example .env
# Add your DEEPGRAM_API_KEY and DAILY_API_KEY to .env

npm install
npm start
```

--------------------------------

### Install and run the application

Source: https://github.com/deepgram/examples/blob/main/examples/070-vonage-voice-websocket-node/README.md

Commands to install dependencies and start the local server.

```bash
npm install
npm start
```

--------------------------------

### Install and run the application

Source: https://github.com/deepgram/examples/blob/main/examples/270-sveltekit-live-transcription-ts/README.md

Commands to install dependencies and start the development server.

```bash
npm install
npm run dev
```

--------------------------------

### Install and Run Deepgram Example

Source: https://github.com/deepgram/examples/blob/main/examples/010-getting-started-node/README.md

Install the necessary packages and start the Node.js script. To transcribe a different file, set the AUDIO_URL environment variable.

```bash
npm install
npm start
```

```bash
AUDIO_URL=https://example.com/my-audio.wav npm start
```

--------------------------------

### Install and Run Nuxt App

Source: https://github.com/deepgram/examples/blob/main/examples/240-nuxt-streaming-stt-tts-ts/README.md

Navigate to the project directory, copy the environment example, add your Deepgram API key, install dependencies, and start the development server.

```bash
cd examples/240-nuxt-streaming-stt-tts-ts
cp .env.example .env
# Add your DEEPGRAM_API_KEY to .env

npm install
npm run dev
# Open http://localhost:3000
```

--------------------------------

### Install and run the Expo project

Source: https://github.com/deepgram/examples/blob/main/examples/090-expo-live-transcription-js/README.md

Commands to install dependencies and start the development server.

```bash
npm install
npx expo start
```

--------------------------------

### Install and run the project

Source: https://github.com/deepgram/examples/blob/main/examples/420-signalwire-realtime-transcription-node/README.md

Commands to initialize the environment and start the Node.js server.

```bash
cp .env.example .env
# Fill in your credentials in .env

npm install
npm start
```

--------------------------------

### Install and Run Server

Source: https://github.com/deepgram/examples/blob/main/examples/460-webex-recording-transcription-node/README.md

Install dependencies and start the Node.js server. Ensure your Deepgram and Webex API credentials are set in the .env file.

```bash
cp .env.example .env
# Fill in your credentials in .env

pnpm install
pnpm start
```

--------------------------------

### Install and run the FastAPI application

Source: https://github.com/deepgram/examples/blob/main/examples/100-fastapi-audio-transcription-python/README.md

Commands to install project dependencies and start the development server.

```bash
pip install -r requirements.txt
uvicorn src.main:app --reload
```

--------------------------------

### Install and run the application

Source: https://github.com/deepgram/examples/blob/main/examples/051-nextjs-vercel-ai-sdk-streaming/README.md

Commands to configure environment variables and start the development server.

```bash
cp .env.example .env
# Add your DEEPGRAM_API_KEY to .env

npm install
npm run dev
```

--------------------------------

### Install and Run Project

Source: https://github.com/deepgram/examples/blob/main/examples/021-twilio-voice-agent-node/README.md

Install dependencies and start the Express server. Use ngrok to expose the server publicly for Twilio webhook configuration.

```bash
npm install
npm start
```

```bash
ngrok http 3000
```

--------------------------------

### Install and run the application

Source: https://github.com/deepgram/examples/blob/main/examples/430-telnyx-texml-stream-node/README.md

Commands to configure environment variables and start the Node.js server.

```bash
cp .env.example .env
# Fill in your API keys in .env

npm install
npm start
```

--------------------------------

### Install and run the application

Source: https://github.com/deepgram/examples/blob/main/examples/450-jitsi-deepgram-stt-node/README.md

Commands to configure environment variables and start the Node.js server.

```bash
cp .env.example .env
# Fill in DEEPGRAM_API_KEY and optionally JITSI_ROOM

npm install
npm start
# Open http://localhost:3000 in your browser
```

--------------------------------

### Install and Run the Node.js Bot

Source: https://github.com/deepgram/examples/blob/main/examples/470-microsoft-teams-transcription-bot-node/README.md

Install project dependencies and start the Express server. Use ngrok to expose the local server publicly for Teams integration.

```bash
pnpm install
pnpm start

ngrok http 3978
```

--------------------------------

### Install and Run NestJS App

Source: https://github.com/deepgram/examples/blob/main/examples/260-nestjs-websocket-stt/README.md

Installs dependencies, builds the NestJS application, and starts the server. Open `http://localhost:3000` in your browser to test.

```bash
npm install
npm run build
npm start
```

--------------------------------

### Install and Run Discord Bot

Source: https://github.com/deepgram/examples/blob/main/examples/060-discord-bot-node/README.md

Commands to install dependencies, register the slash command, and start the Discord bot. The slash command registration should be run once.

```bash
npm install

# Register the /transcribe slash command (run once)
npm run register

# Start the bot
npm start
```

--------------------------------

### Install and Run Proxy Server

Source: https://github.com/deepgram/examples/blob/main/examples/530-voice-agent-multi-provider-proxy-python/README.md

Instructions for setting up the environment, installing dependencies, and running the proxy server and demo agent. Ensure API keys are configured in the .env file.

```bash
cp .env.example .env
# Fill in your API keys in .env

pip install -r requirements.txt

# Start the proxy server
cd src && uvicorn proxy:app --port 8080

# In another terminal, run the demo Voice Agent
python src/demo_agent.py
```

--------------------------------

### Install and run the proxy server

Source: https://github.com/deepgram/examples/blob/main/examples/520-node-deepgram-proxy/README.md

Commands to configure environment variables and start the Node.js application.

```bash
cp .env.example .env
# Add your DEEPGRAM_API_KEY to .env

pnpm install
pnpm start
# Open http://localhost:3000
```

--------------------------------

### Install and Deploy Worker

Source: https://github.com/deepgram/examples/blob/main/examples/110-cloudflare-worker-transcription-js/README.md

Commands to install dependencies, start the local development server, and deploy to Cloudflare.

```bash
npm install

# Local development
wrangler dev

# Deploy to Cloudflare
wrangler deploy
```

--------------------------------

### Install and Run Django Channels Application

Source: https://github.com/deepgram/examples/blob/main/examples/220-django-channels-live-stt-python/README.md

Commands to set up the environment and start the development server for the Django Channels project.

```bash
cd examples/220-django-channels-live-stt-python

pip install -r requirements.txt

cp .env.example .env
# Edit .env and add your DEEPGRAM_API_KEY

python src/manage.py runserver
```

--------------------------------

### Install and Run Android App

Source: https://github.com/deepgram/examples/blob/main/examples/360-kotlin-android-live-transcription/README.md

Clone the example project, set your Deepgram API key, and build/install the application on a connected Android device using Gradle.

```bash
# Clone and open in Android Studio
cd examples/360-kotlin-android-live-transcription
# Set your API key
export DEEPGRAM_API_KEY="your-key-here"
# Build and install on connected device
./gradlew installDebug
```

--------------------------------

### Create New Example Directory Structure

Source: https://github.com/deepgram/examples/blob/main/CONTRIBUTING.md

This bash command creates the necessary directory structure for a new example, including source and test subdirectories. Replace NNN with the example number and slug with a descriptive name.

```bash
mkdir -p examples/{NNN}-{slug}/{src,tests}
```

--------------------------------

### Install and Run the Application

Source: https://github.com/deepgram/examples/blob/main/examples/500-semantic-kernel-voice-plugin-dotnet/README.md

Commands to configure environment variables and execute the .NET console application.

```bash
cp .env.example .env
# Fill in your API keys in .env

cd src
dotnet restore
dotnet run
```

--------------------------------

### Install and Run Flutter App

Source: https://github.com/deepgram/examples/blob/main/examples/150-flutter-voice-transcription-dart/README.md

Use these commands to get the project dependencies and run the Flutter application on your device or emulator.

```bash
flutter pub get
flutter run
```

--------------------------------

### Install and run the CLI

Source: https://github.com/deepgram/examples/blob/main/examples/140-audio-to-subtitles-python/README.md

Commands to install dependencies and execute the transcription tool with various options like URL input, diarization, and custom output paths.

```bash
pip install -r requirements.txt

# Transcribe a local file (outputs recording.srt by default)
export DEEPGRAM_API_KEY=your_key_here
python src/caption.py recording.mp3

# Transcribe from a URL, output as WebVTT
python src/caption.py --url https://dpgr.am/spacewalk.wav --format vtt

# Multi-speaker interview with speaker labels
python src/caption.py interview.wav --diarize

# Explicit output path
python src/caption.py podcast.mp3 --output episode-42.srt

# Use a specialized model for medical audio
python src/caption.py consultation.wav --model nova-3-medical
```

--------------------------------

### Test and Run Locally

Source: https://github.com/deepgram/examples/blob/main/examples/290-aws-lambda-python-transcription/README.md

Install dependencies and execute the local test suite.

```bash
pip install -r requirements.txt
python tests/test_example.py
```

--------------------------------

### Install and Run Bridge Server

Source: https://github.com/deepgram/examples/blob/main/examples/350-asterisk-freeswitch-deepgram-stt-python/README.md

Install dependencies, copy the environment file, and run the Python bridge server. The server defaults to listening on ws://0.0.0.0:8765.

```bash
cd examples/260-asterisk-freeswitch-deepgram-stt-python

pip install -r requirements.txt

cp .env.example .env
# Edit .env and add your DEEPGRAM_API_KEY

python src/bridge.py
```

--------------------------------

### Install and run the LangChain STT tool

Source: https://github.com/deepgram/examples/blob/main/examples/040-langchain-stt-tool-python/README.md

Commands to install project dependencies and execute the transcription tool in either standalone or agent mode.

```bash
pip install -r requirements.txt

# Standalone — transcribe an audio URL directly
python src/transcribe_tool.py https://dpgr.am/spacewalk.wav

# Agent mode — let the LLM decide when to transcribe
python src/transcribe_tool.py --agent "Transcribe https://dpgr.am/spacewalk.wav and summarise the key points"
```

--------------------------------

### Install and run the Telegram bot

Source: https://github.com/deepgram/examples/blob/main/examples/130-telegram-bot-python/README.md

Commands to install project dependencies and execute the bot script.

```bash
pip install -r requirements.txt
python src/bot.py
```

--------------------------------

### Install Dependencies and Run Audio Loader

Source: https://github.com/deepgram/examples/blob/main/examples/160-llamaindex-audio-loader-python/README.md

Install project dependencies using pip and run the audio loader script. The script can either print the transcript and metadata or enter a query mode to ask questions about the audio content.

```bash
pip install -r requirements.txt

# Load audio into Documents — prints transcript and metadata
python src/audio_loader.py https://dpgr.am/spacewalk.wav

# Query mode — ask a question about the audio content
python src/audio_loader.py --query "What was the main topic discussed?" https://dpgr.am/spacewalk.wav
```

--------------------------------

### Install and Run Voice Agent

Source: https://github.com/deepgram/examples/blob/main/examples/030-livekit-agents-python/README.md

Commands to install dependencies, download necessary model files, and execute the agent in console or development mode.

```bash
pip install -r requirements.txt

# Download VAD and turn detector model files (first time only)
python src/agent.py download-files

# Run in console mode (talk from your terminal)
python src/agent.py console

# Or run as a dev worker (connects to LiveKit server)
python src/agent.py dev
```

--------------------------------

### Create Pull Request for New Example

Source: https://github.com/deepgram/examples/blob/main/CONTRIBUTING.md

Use this gh CLI command to create a pull request for a new example. It sets the title and applies the 'type:example' label.

```bash
gh pr create --title "[Example] {NNN} — {description}" --label "type:example"
```

--------------------------------

### Install and Run Commands

Source: https://github.com/deepgram/examples/blob/main/examples/280-express-react-live-transcription-ts/README.md

Commands to set up and run the Express.js and React live transcription application. Includes cloning the repository, setting up environment variables, installing dependencies, and running in development or production modes.

```bash
# 1. Clone and enter the example directory
cd examples/280-express-react-live-transcription-ts

# 2. Copy env file and add your Deepgram API key
cp .env.example server/.env

# 3. Install dependencies
cd server && npm install && cd ../client && npm install && cd ..

# 4a. Development (two terminals)
cd server && npm run dev      # Express on :3000
cd client && npm run dev      # Vite on :5173 (proxies WS to :3000)

# 4b. Production
cd client && npm run build    # Build React into client/dist
cd ../server && npm run build && npm start  # Serves everything on :3000
```

--------------------------------

### Install and Run Electron App

Source: https://github.com/deepgram/examples/blob/main/examples/170-electron-live-transcription-node/README.md

Follow these steps to set up and run the Electron application. Ensure you have Node.js 18+ installed and your Deepgram API key configured in the .env file.

```bash
cp .env.example .env
# Add your DEEPGRAM_API_KEY to .env

npm install
npm start
```

--------------------------------

### Install and Run Deepgram Proxy Server

Source: https://github.com/deepgram/examples/blob/main/examples/521-deepgram-proxy-python-uv/README.md

Installs dependencies using UV and runs the FastAPI server with Uvicorn. Ensure your DEEPGRAM_API_KEY is set in the .env file.

```bash
cp .env.example .env
# Add your DEEPGRAM_API_KEY to .env

uv pip install -r requirements.txt
uv run uvicorn src.server:app --reload --port 3000
# Open http://localhost:3000
```

--------------------------------

### Install System Dependencies and Build OBS Plugin

Source: https://github.com/deepgram/examples/blob/main/examples/480-obs-captioning-plugin-c/README.md

Installs necessary system packages for building the OBS plugin on Debian/Ubuntu, then clones the repository and builds the plugin using CMake. Ensure you have the correct OBS Studio version and development headers.

```bash
# Install system dependencies (Debian/Ubuntu)
sudo apt-get install -y cmake gcc libobs-dev libwebsockets-dev libssl-dev

# Clone and build
cd examples/480-obs-captioning-plugin-c/src
cmake -B build
cmake --build build
```

--------------------------------

### Install and Run Tauri Application

Source: https://github.com/deepgram/examples/blob/main/examples/340-tauri-live-transcription-rust-ts/README.md

Commands to configure environment variables and initialize the development environment for the Tauri project.

```bash
cp .env.example .env
# Add your DEEPGRAM_API_KEY to .env

cd src
npm install
npm run tauri dev
```

--------------------------------

### Find Next Available Example Number

Source: https://github.com/deepgram/examples/blob/main/CONTRIBUTING.md

Use this bash command to find the next available number for a new example directory. It lists directories, sorts them numerically, and shows the last one.

```bash
ls examples/ | sort -n | tail -1
# Use that number + 10
```

--------------------------------

### Create New Feature Branch and Commit

Source: https://github.com/deepgram/examples/blob/main/CONTRIBUTING.md

These git commands create a new branch for the example, add the new example files, commit the changes, and prepare for creating a pull request.

```bash
git checkout -b example/{NNN}-{slug}
git add examples/{NNN}-{slug}/
git commit -m "feat(examples): add {description}"
```

--------------------------------

### Install and Run Project

Source: https://github.com/deepgram/examples/blob/main/examples/052-vercel-ai-sdk-agent-node/README.md

Follow these commands to set up and run the project. Ensure your Deepgram and OpenAI API keys are configured in the .env file.

```bash
cp .env.example .env
# Fill in your API keys in .env

pnpm install
pnpm start
```

--------------------------------

### Install and Configure Deepgram n8n Node

Source: https://github.com/deepgram/examples/blob/main/examples/230-n8n-deepgram-community-node-typescript/README.md

Commands to clone the repository, install dependencies, build the TypeScript source, and link the package to a local n8n installation.

```bash
# Clone and enter the example directory
cd examples/230-n8n-deepgram-community-node-typescript

# Install dependencies
npm install

# Build the TypeScript source
npm run build

# Link the package into your local n8n installation
cd ~/.n8n
mkdir -p custom
cd custom
npm init -y
npm install /path/to/examples/230-n8n-deepgram-community-node-typescript

# Start n8n — the Deepgram node will appear in the node list
n8n start
```

--------------------------------

### Install and Run Swift Package

Source: https://github.com/deepgram/examples/blob/main/examples/370-swift-ios-live-transcription/README.md

Instructions for opening the Swift package in Xcode. Ensure you have Xcode 15+ and an iOS 17 SDK.

```bash
cd examples/370-swift-ios-live-transcription
open Package.swift
```

--------------------------------

### Run the Gin Transcription Server

Source: https://github.com/deepgram/examples/blob/main/examples/510-gin-live-transcription-go/README.md

Commands to navigate to the project directory, set the API key, and start the Go server.

```bash
cd examples/510-gin-live-transcription-go
export DEEPGRAM_API_KEY=your_key_here
go run ./src/
```

--------------------------------

### Install and Run Pipecat Voice Bot

Source: https://github.com/deepgram/examples/blob/main/examples/080-pipecat-voice-pipeline-python/README.md

Commands to install dependencies and execute the bot in either local console mode or Daily WebRTC mode.

```bash
pip install -r requirements.txt

# Local console mode — uses your microphone and speakers
python src/pipeline.py

# Daily WebRTC mode — creates a room and prints the join URL
python src/pipeline.py --daily
```

--------------------------------

### Start and Stop Transcription Event Listeners

Source: https://github.com/deepgram/examples/blob/main/examples/450-jitsi-deepgram-stt-node/src/public/index.html

Attaches event listeners to start and stop buttons to control the Deepgram transcription process and Jitsi initialization.

```javascript
btnStart.addEventListener('click', startTranscription);
btnStop.addEventListener('click', stopTranscription);
initJitsi();
```

--------------------------------

### Install and Run Transcription Pipeline

Source: https://github.com/deepgram/examples/blob/main/examples/490-haystack-deepgram-stt-pipeline-python/README.md

Use these commands to set up your environment and run the transcription pipeline. Ensure your `DEEPGRAM_API_KEY` is added to the `.env` file. The script can transcribe single or multiple audio file URLs.

```bash
cp .env.example .env
# Add your DEEPGRAM_API_KEY to .env

pip install -r requirements.txt

# Transcribe a single audio file
python src/transcriber.py https://dpgr.am/spacewalk.wav

# Batch transcribe multiple files
python src/transcriber.py https://dpgr.am/spacewalk.wav https://dpgr.am/spacewalk.wav
```

--------------------------------

### Install and Run the CrewAI Voice Pipeline

Source: https://github.com/deepgram/examples/blob/main/examples/310-crewai-voice-agents-python/README.md

Commands to install project dependencies and execute the voice-enabled agent crew with either local files or remote audio URLs.

```bash
pip install -r requirements.txt

# Run with default sample audio (NASA spacewalk recording)
python src/crew.py

# Run with your own audio file or URL
python src/crew.py path/to/audio.wav
python src/crew.py https://example.com/audio.mp3
```