@telnyx/voice-agent-tester 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +42 -52
  3. package/package.json +1 -1
  4. package/src/index.js +1 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.2.1](https://github.com/team-telnyx/voice-agent-tester/compare/v0.2.0...v0.2.1) (2026-01-20)
4
+
5
+ ### Features
6
+
7
+ * update usage and docs ([70085c9](https://github.com/team-telnyx/voice-agent-tester/commit/70085c9dc2d6733fb01be6d432585c2306bfce1d))
8
+
3
9
  ## 0.2.0 (2026-01-16)
4
10
 
5
11
  ### Features
package/README.md CHANGED
@@ -1,91 +1,81 @@
1
- # Voice Agent Tester (Telnyx Fork)
1
+ # Voice Agent Tester
2
2
 
3
3
  [![CI](https://github.com/team-telnyx/voice-agent-tester/actions/workflows/ci.yml/badge.svg)](https://github.com/team-telnyx/voice-agent-tester/actions/workflows/ci.yml)
4
4
  [![npm version](https://img.shields.io/npm/v/@telnyx/voice-agent-tester.svg)](https://www.npmjs.com/package/@telnyx/voice-agent-tester)
5
5
 
6
- This is a [Telnyx](https://telnyx.com) fork of [livetok-ai/voice-agent-tester](https://github.com/livetok-ai/voice-agent-tester). For base documentation (installation, configuration, actions, etc.), see the [original README](https://github.com/livetok-ai/voice-agent-tester#readme).
6
+ A CLI tool for automated benchmarking and testing of voice AI agents. Supports Telnyx, ElevenLabs, and Vapi.
7
+
8
+ This is a [Telnyx](https://telnyx.com) fork of [livetok-ai/voice-agent-tester](https://github.com/livetok-ai/voice-agent-tester). For base documentation (configuration, actions, etc.), see the [original README](https://github.com/livetok-ai/voice-agent-tester#readme).
7
9
 
8
10
  ## Installation
9
11
 
10
12
  ```bash
11
- npm install @telnyx/voice-agent-tester
13
+ npm install -g @telnyx/voice-agent-tester
14
+ ```
15
+
16
+ ## Quick Start
17
+
18
+ ```bash
19
+ voice-agent-tester --help
12
20
  ```
13
21
 
14
- ## Fork Enhancements
22
+ ## CLI Options
15
23
 
16
- ### CLI Options
17
24
  | Option | Description |
18
25
  |--------|-------------|
19
- | `--assistant-id` | Assistant/agent ID for direct benchmarking (Telnyx, ElevenLabs, Vapi) |
20
- | `--api-key` | Telnyx API key for authentication and import operations |
21
- | `--provider` | Import from external provider (`vapi`, `elevenlabs`, `retell`) into Telnyx |
26
+ | `-a, --applications` | Application config paths (required) |
27
+ | `-s, --scenarios` | Scenario config paths (required) |
28
+ | `--assistant-id` | Telnyx assistant ID for direct benchmarking |
29
+ | `--agent-id` | ElevenLabs agent ID for direct benchmarking |
30
+ | `--branch-id` | ElevenLabs branch ID |
31
+ | `--share-key` | Vapi share key for embedded widget |
32
+ | `--api-key` | Telnyx API key for authentication |
33
+ | `--provider` | Import from external provider (`vapi`, `elevenlabs`, `retell`) |
22
34
  | `--provider-api-key` | External provider API key (required with `--provider`) |
23
- | `--provider-import-id` | Provider assistant/agent ID to import (required with `--provider`) |
24
- | `--params` | Additional URL template params (e.g., `--params branchId=xxx,shareKey=yyy`) |
35
+ | `--provider-import-id` | Provider assistant/agent ID to import |
36
+ | `--params` | Additional URL template params (e.g., `--params key=value`) |
25
37
  | `--debug` | Enable detailed timeout diagnostics with WebRTC stats |
26
-
27
- ### Multi-Provider Support
28
- - **Direct benchmarking**: Use `--assistant-id` with any provider's YAML config
29
- - **Provider import**: Import assistants from Vapi/ElevenLabs/Retell into Telnyx via `--provider`
30
- - **Auto-configuration**: Automatic integration secret management and web call enablement
31
-
32
- ### Debug & Diagnostics
33
- When `--debug` is enabled, timeout events include WebRTC RTP statistics (packets received, bytes transferred, jitter, packet loss).
38
+ | `--headless` | Run browser in headless mode (default: true) |
39
+ | `--repeat` | Number of repetitions per combination |
40
+ | `-v, --verbose` | Show browser console logs |
34
41
 
35
42
  ## Usage Examples
36
43
 
37
- ### Telnyx Assistant (Direct)
38
-
39
- Benchmark a Telnyx AI assistant directly using the Telnyx widget:
44
+ ### Telnyx Assistant
40
45
 
41
46
  ```bash
42
- npm run start -- \
43
- -a benchmarks/applications/telnyx.yaml \
44
- -s benchmarks/scenarios/appointment.yaml \
45
- --assistant-id <TELNYX_ASSISTANT_ID>
47
+ voice-agent-tester -a apps/telnyx.yaml -s scenarios/test.yaml --assistant-id <TELNYX_ASSISTANT_ID>
46
48
  ```
47
49
 
48
- ### ElevenLabs Agent (Direct)
49
-
50
- Benchmark an ElevenLabs conversational agent. Use `--params` for optional `branchId`:
50
+ ### ElevenLabs Agent
51
51
 
52
52
  ```bash
53
- npm run start -- \
54
- -a benchmarks/applications/elevenlabs.yaml \
55
- -s benchmarks/scenarios/appointment.yaml \
56
- --assistant-id <ELEVENLABS_AGENT_ID> \
57
- --params branchId=<BRANCH_ID>
53
+ voice-agent-tester -a apps/elevenlabs.yaml -s scenarios/test.yaml --agent-id <ELEVENLABS_AGENT_ID> --branch-id <BRANCH_ID>
58
54
  ```
59
55
 
60
- ### Vapi Assistant (Direct)
61
-
62
- Benchmark a Vapi assistant using their embedded widget. Requires `shareKey` via `--params`:
56
+ ### Vapi Assistant
63
57
 
64
58
  ```bash
65
- npm run start -- \
66
- -a benchmarks/applications/vapi.yaml \
67
- -s benchmarks/scenarios/appointment.yaml \
68
- --assistant-id <VAPI_ASSISTANT_ID> \
69
- --params shareKey=<SHARE_KEY>
59
+ voice-agent-tester -a apps/vapi.yaml -s scenarios/test.yaml --assistant-id <VAPI_ASSISTANT_ID> --share-key <SHARE_KEY>
70
60
  ```
71
61
 
72
62
  ### Import from Provider to Telnyx
73
63
 
74
- Import an assistant from an external provider (Vapi, ElevenLabs, Retell) into Telnyx and benchmark:
64
+ Import an assistant from Vapi/ElevenLabs/Retell into Telnyx and benchmark:
75
65
 
76
66
  ```bash
77
- npm run start -- \
78
- -a benchmarks/applications/telnyx.yaml \
79
- -s benchmarks/scenarios/appointment.yaml \
80
- --provider vapi \
81
- --api-key <TELNYX_API_KEY> \
82
- --provider-api-key <VAPI_API_KEY> \
83
- --provider-import-id <VAPI_ASSISTANT_ID>
67
+ voice-agent-tester -a apps/telnyx.yaml -s scenarios/test.yaml --provider vapi --api-key <TELNYX_API_KEY> --provider-api-key <VAPI_API_KEY> --provider-import-id <VAPI_ASSISTANT_ID>
84
68
  ```
85
69
 
86
- - `--api-key`: Your Telnyx API key (for creating the import)
87
- - `--provider-api-key`: The external provider's API key (for fetching the assistant)
88
- - `--provider-import-id`: The assistant ID from the provider to import
70
+ ## Multi-Provider Support
71
+
72
+ - **Direct benchmarking**: Use provider-specific options (`--assistant-id`, `--agent-id`, `--share-key`)
73
+ - **Provider import**: Import assistants from Vapi/ElevenLabs/Retell into Telnyx via `--provider`
74
+ - **Auto-configuration**: Automatic integration secret management and web call enablement
75
+
76
+ ## Debug & Diagnostics
77
+
78
+ When `--debug` is enabled, timeout events include WebRTC RTP statistics (packets received, bytes transferred, jitter, packet loss).
89
79
 
90
80
  ## License
91
81
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@telnyx/voice-agent-tester",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "A command-line tool to test voice agents using Puppeteer",
5
5
  "main": "src/index.js",
6
6
  "type": "module",
package/src/index.js CHANGED
@@ -555,6 +555,4 @@ async function main() {
555
555
  }
556
556
  }
557
557
 
558
- if (import.meta.url === `file://${process.argv[1]}`) {
559
- main();
560
- }
558
+ main();