mirror of
https://github.com/elevenlabs/skills.git
synced 2026-09-14 20:46:33 +08:00
Add npm CLI install option and remove LiveKit pinning guidance (#120)
* Add npm as an install option for the ElevenLabs CLI The CLI is now published on npm as @elevenlabs/cli. List `npm install -g @elevenlabs/cli` as the first install option in every skill's installation guide and in the README, alongside the existing Homebrew, Scoop, and shell-installer methods. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Remove LiveKit client pinning guidance from skills The livekit-client version pin is now handled within the ElevenLabs SDK, so the temporary package.json override workaround sections are obsolete. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -89,20 +89,6 @@ elevenlabs agents create \
|
||||
|
||||
## Starting Conversations
|
||||
|
||||
### Temporary LiveKit WebSocket Pin
|
||||
|
||||
Until the ElevenLabs LiveKit server supports `/rtc/v1`, browser clients using WebRTC can fail or stall during the underlying LiveKit WebSocket handshake with `livekit-client` versions newer than `2.16.1`. For React, Next.js, Electron, or other `@elevenlabs/client` / `@elevenlabs/react` integrations that use `connectionType: "webrtc"` or hit `wss://livekit.rtc.elevenlabs.io/rtc/v1`, add this temporary pin to `package.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"overrides": {
|
||||
"livekit-client": "2.16.1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Use the pin when the app logs `/rtc/v1` 404s, `v1 RTC path not found`, or `could not establish pc connection` during session startup. This is a LiveKit server compatibility workaround for WebRTC sessions, not the ElevenLabs `connectionType: "websocket"` transport. Remove it after the upstream LiveKit server or SDK issue is fixed.
|
||||
|
||||
**Authenticated WebRTC:** Request a session token from your backend. The response includes both
|
||||
the token and the conversation ID:
|
||||
```python
|
||||
|
||||
@@ -91,20 +91,6 @@ npm install @elevenlabs/client@latest # Vanilla JavaScript in the browser
|
||||
npm install @elevenlabs/react@latest # React on the web
|
||||
```
|
||||
|
||||
### Temporary LiveKit WebSocket pin
|
||||
|
||||
There is a known LiveKit server compatibility issue where WebRTC startup may hit the underlying LiveKit WebSocket path `/rtc/v1` and return 404, causing delays or failed sessions in React, Next.js, Electron, and other browser clients. Until the upstream issue is resolved, pin `livekit-client` to `2.16.1` when using `connectionType: "webrtc"` or when logs mention `wss://livekit.rtc.elevenlabs.io/rtc/v1`:
|
||||
|
||||
```json
|
||||
{
|
||||
"overrides": {
|
||||
"livekit-client": "2.16.1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This belongs in the app's `package.json`. Apply it when logs include `/rtc/v1` 404s, `v1 RTC path not found`, or `could not establish pc connection`. Remove the override once the ElevenLabs LiveKit server or SDK no longer requires the workaround.
|
||||
|
||||
**Import changes:**
|
||||
```javascript
|
||||
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
|
||||
|
||||
@@ -187,16 +187,6 @@ export function VoiceControls() {
|
||||
}
|
||||
```
|
||||
|
||||
If a WebRTC browser session stalls or logs `/rtc/v1` 404s, `v1 RTC path not found`, or `could not establish pc connection`, pin `livekit-client` to `2.16.1` in the app's `package.json` until the upstream LiveKit compatibility issue is resolved:
|
||||
|
||||
```json
|
||||
{
|
||||
"overrides": {
|
||||
"livekit-client": "2.16.1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
- [Installation Guide](references/installation.md)
|
||||
|
||||
@@ -41,20 +41,6 @@ npm install @elevenlabs/react
|
||||
npm install @elevenlabs/client
|
||||
```
|
||||
|
||||
### Temporary LiveKit WebRTC Pin
|
||||
|
||||
There is a known LiveKit server compatibility issue where WebRTC startup may hit the underlying LiveKit WebSocket path `/rtc/v1` and return 404, causing delays or failed sessions in React, Next.js, Electron, and other browser clients. Until the upstream issue is resolved, pin `livekit-client` to `2.16.1` when logs mention `/rtc/v1`, `v1 RTC path not found`, or `could not establish pc connection`:
|
||||
|
||||
```json
|
||||
{
|
||||
"overrides": {
|
||||
"livekit-client": "2.16.1"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This belongs in the app's `package.json`. Remove the override once the ElevenLabs LiveKit server or SDK no longer requires the workaround.
|
||||
|
||||
Always use `@elevenlabs/elevenlabs-js`, `@elevenlabs/react`, or `@elevenlabs/client`. Do not use the deprecated `elevenlabs` npm package.
|
||||
|
||||
## Python
|
||||
|
||||
Reference in New Issue
Block a user