← Files ElevenLabsARCHIVED FILE
skills/speech-to-text/references/installation.md
2.68 KB · Sep 30, 2026 · 22:53 UTC
# Installation
## CLI (Recommended)
Install the ElevenLabs CLI:
```bash
# npm (any platform with Node.js)
npm install -g @elevenlabs/cli
```
```bash
# macOS / Linux (Homebrew)
brew install elevenlabs/tap/elevenlabs
```
```powershell
# Windows (Scoop)
scoop bucket add elevenlabs https://github.com/elevenlabs/scoop-bucket
scoop install elevenlabs
```
```bash
# Shell installer (macOS / Linux)
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/elevenlabs/cli/releases/latest/download/elevenlabs-cli-installer.sh | sh
```
Authenticate with either method:
```bash
# Option 1: Environment variable (picked up automatically)
export ELEVENLABS_API_KEY="your-api-key"
# Option 2: OAuth login (stores credentials in the OS keyring)
elevenlabs auth login
```
## JavaScript / TypeScript
```bash
npm install @elevenlabs/elevenlabs-js@latest
```
> **Important:** Always use `@elevenlabs/elevenlabs-js`. The old `elevenlabs` npm package (v1.x) is deprecated and should not be used.
```javascript
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
// Option 1: Environment variable (recommended)
// Set ELEVENLABS_API_KEY in your environment
const client = new ElevenLabsClient();
// Option 2: Pass directly
const client = new ElevenLabsClient({ apiKey: "your-api-key" });
```
### Migrating from deprecated packages
If you have old packages installed, remove them:
```bash
# Remove deprecated packages
npm uninstall elevenlabs
# Install the current packages
npm install @elevenlabs/elevenlabs-js@latest
# For client-side/browser usage, also install:
npm install @elevenlabs/client@latest # Browser client
npm install @elevenlabs/react@latest # React hooks
```
**Import changes:**
```javascript
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
import { Scribe } from "@elevenlabs/client";
import { useScribe } from "@elevenlabs/react";
```
## Python
```bash
pip install --upgrade elevenlabs
```
```python
from elevenlabs import ElevenLabs
# Option 1: Environment variable (recommended)
# Set ELEVENLABS_API_KEY in your environment
client = ElevenLabs()
# Option 2: Pass directly
client = ElevenLabs(api_key="your-api-key")
```
## CLI Usage
The CLI reads `ELEVENLABS_API_KEY` automatically — no key flags or headers needed:
```bash
elevenlabs speech-to-text convert --file audio.mp3 --model-id scribe_v2
```
## Getting an API Key
1. Sign up at [elevenlabs.io](https://elevenlabs.io)
2. Go to [API Keys](https://elevenlabs.io/app/settings/api-keys)
3. Click **Create API Key**
4. Copy and store securely
Or use the `setup-api-key` skill for guided setup.
## Environment Variables
| Variable | Description |
|----------|-------------|
| `ELEVENLABS_API_KEY` | Your ElevenLabs API key (required) |
SHA-256: 95ced4021a8cca97249d584baabbb427c94d43c3e7364815cf15e263f54d8c2a