npm - token-speed-tester - Versions diffs - 1.0.0 → 1.2.2 - Mend

token-speed-tester 1.0.0 → 1.2.2

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 (5) hide show

package/LICENSE CHANGED Viewed

@@ -1,21 +1,21 @@
-MIT License
-Copyright (c) 2025
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+Copyright (c) 2025
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.en.md ADDED Viewed

@@ -0,0 +1,272 @@
+# Token Speed Tester
+> A CLI tool to measure and analyze LLM API token streaming performance
+[中文文档](README.md) |
+[![npm version](https://badge.fury.io/js/token-speed-tester.svg)](https://www.npmjs.com/package/token-speed-tester)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://github.com/Cansiny0320/token-speed-tester/actions/workflows/publish.yml/badge.svg)](https://github.com/Cansiny0320/token-speed-tester/actions)
+A powerful command-line tool for testing token output speed of LLM APIs. Supports **Anthropic** and **OpenAI** compatible APIs, providing detailed metrics including TTFT (Time to First Token), throughput, peak speed, and statistical analysis across multiple runs.
+## Features
+- **Dual Protocol Support**: Works with Anthropic Messages API and OpenAI Chat Completions API
+- **Streaming Performance**: Measures each token's arrival time with millisecond precision
+- **Comprehensive Metrics**:
+  - **TTFT** (Time to First Token): Latency before first token arrives
+  - **Average Speed**: Mean tokens per second
+  - **Peak Speed**: Fastest speed over a 10-token window
+  - **TPS Curve**: Tokens received per second throughout the stream
+- **Statistical Analysis**: Mean, min, max, and standard deviation across multiple test runs
+- **ASCII Visualization**: Beautiful terminal-based charts and tables
+- **Custom Endpoints**: Test third-party APIs compatible with OpenAI/Anthropic protocols
+## Installation
+### Global Installation (Recommended)
+```bash
+npm install -g token-speed-tester
+```
+### Using npx (No Installation)
+```bash
+npx token-speed-tester --api-key sk-xxx
+```
+### Local Installation
+```bash
+npm install token-speed-tester
+```
+## Usage
+### Basic Usage
+```bash
+# Test Anthropic API (default)
+token-speed-test --api-key sk-ant-xxx
+# Test OpenAI API
+token-speed-test --api-key sk-xxx --provider openai
+```
+### Advanced Options
+```bash
+# Custom model and multiple test runs
+token-speed-test \
+  --api-key sk-ant-xxx \
+  --provider anthropic \
+  --model claude-3-5-sonnet-20241022 \
+  --runs 5
+# Test with custom endpoint and prompt
+token-speed-test \
+  --api-key sk-xxx \
+  --provider openai \
+  --url https://api.example.com/v1 \
+  --model custom-model \
+  --prompt "Explain quantum computing" \
+  --max-tokens 2048 \
+  --runs 10
+```
+### Local Development
+```bash
+# Clone and install dependencies
+git clone https://github.com/Cansiny0320/token-speed-tester.git
+cd token-speed-tester
+npm install
+# Run directly with tsx
+npm run dev -- --api-key sk-ant-xxx
+# Or build and run
+npm run build
+node dist/index.js --api-key sk-ant-xxx
+```
+## Command Line Options
+| Option | Short | Description | Default |
+|--------|-------|-------------|---------|
+| `--api-key` | `-k` | API Key (required) | - |
+| `--provider` | `-p` | API type: `anthropic` or `openai` | `anthropic` |
+| `--model` | `-m` | Model name | Auto-selected by provider |
+| `--url` | `-u` | Custom API endpoint | Official endpoint |
+| `--runs` | `-r` | Number of test runs | `3` |
+| `--prompt` | | Test prompt | "写一篇关于 AI 的短文" |
+| `--max-tokens` | | Maximum output tokens | `1024` |
+### Default Models
+- **Anthropic**: `claude-3-5-sonnet-20241022`
+- **OpenAI**: `gpt-4o-mini`
+## Output Example
+```
+🚀 Token 速度测试工具
+──────────────────────────────────────────
+Provider: anthropic
+Model: claude-3-5-sonnet-20241022
+Max Tokens: 1024
+Runs: 3
+Prompt: 写一篇关于 AI 的短文
+──────────────────────────────────────────
+⏳ 正在运行测试...
+[运行 1]
+  TTFT: 523ms
+  总耗时: 3245ms
+  总 Token 数: 412
+  平均速度: 126.96 tokens/s
+  峰值速度: 156.32 tokens/s
+[运行 2]
+  TTFT: 487ms
+  总耗时: 3189ms
+  总 Token 数: 398
+  平均速度: 124.84 tokens/s
+  峰值速度: 158.41 tokens/s
+[运行 3]
+  TTFT: 501ms
+  总耗时: 3312ms
+  总 Token 数: 405
+  平均速度: 122.28 tokens/s
+  峰值速度: 154.23 tokens/s
+======================================================================
+Token 速度测试报告
+======================================================================
+统计汇总 (N=3)
+┌──────────────────────────────────────────────────────────────────────┐
+│ 指标             │       均值 │    最小值 │    最大值 │    标准差 │
+├──────────────────────────────────────────────────────────────────────┤
+│ TTFT (ms)       │    503.67 │   487.00 │   523.00 │    14.57 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 总耗时 (ms)      │   3248.67 │  3189.00 │  3312.00 │    51.92 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 总 Token 数     │    405.00 │  398.00 │  412.00 │     5.35 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 平均速度        │    124.69 │  122.28 │  126.96 │     1.88 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 峰值速度        │    156.32 │  154.23 │  158.41 │     1.82 │
+└──────────────────────────────────────────────────────────────────────┘
+Token 速度趋势图 (TPS)
+┌────────────────────────────────────────┐
+│ 120 ┤                         █         │
+│ 100 ┤                     █ █ █ █       │
+│  80 ┤                 █ █ █ █ █ █ █     │
+│  60 ┤             █ █ █ █ █ █ █ █ █ █   │
+│  40 ┤         █ █ █ █ █ █ █ █ █ █ █ █   │
+│  20 ┤     █ █ █ █ █ █ █ █ █ █ █ █ █ █   │
+│   0 └────────────────────────────────── │
+│     0s   1s   2s   3s   4s   5s   6s    │
+└────────────────────────────────────────┘
+TPS 分布
+0.0-12.0 │██████████████████████████████████████████████████ 45
+12.0-24.0 │██ 3
+24.0-36.0 │ 0
+36.0-48.0 │ 0
+48.0-60.0 │ 0
+60.0-72.0 │ 0
+72.0-84.0 │ 0
+84.0-96.0 │ 0
+96.0-108.0 │ 0
+108.0-120.0 │ 0
+✅ 测试完成!
+```
+## Metrics Explained
+| Metric | Description |
+|--------|-------------|
+| **TTFT** | Time to First Token - latency from request to first token arrival |
+| **Total Time** | Complete duration from request to stream completion |
+| **Total Tokens** | Number of output tokens received |
+| **Average Speed** | Mean tokens per second (totalTokens / totalTime × 1000) |
+| **Peak Speed** | Fastest speed measured over a sliding 10-token window |
+| **TPS Curve** | Tokens received per second throughout the streaming response |
+## Development
+### Running Tests
+```bash
+# Run tests
+npm test
+# Run tests with UI
+npm run test:ui
+# Generate coverage report
+npm run test:coverage
+```
+### Building
+```bash
+npm run build
+```
+### Release
+This project uses [semantic-release](https://github.com/semantic-release/semantic-release) for automated versioning and publishing.
+Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) specification:
+```bash
+# Patch release (1.0.0 -> 1.0.1)
+git commit -m "fix: fix some bug"
+# Minor release (1.0.0 -> 1.1.0)
+git commit -m "feat: add new feature"
+# Major release (1.0.0 -> 2.0.0)
+git commit -m "feat: add breaking change\n\nBREAKING CHANGE: deprecate old API"
+```
+After pushing to `master` branch, GitHub Actions will automatically:
+- Analyze commit types to determine version
+- Update CHANGELOG.md
+- Create Git tag
+- Publish to npm
+- Create GitHub Release
+## Test Coverage
+This project maintains high code coverage:
+| Coverage Type | Percentage |
+|---------------|------------|
+| Statements | 99.19% |
+| Branches | 94.73% |
+| Functions | 100% |
+## License
+MIT © [Cansiny0320](https://github.com/Cansiny0320)
+## Contributing
+Contributions are welcome! Please feel free to submit a Pull Request.
+## Links
+- [npm Package](https://www.npmjs.com/package/token-speed-tester)
+- [GitHub Repository](https://github.com/Cansiny0320/token-speed-tester)
+- [Issues](https://github.com/Cansiny0320/token-speed-tester/issues)
+- [Changelog](https://github.com/Cansiny0320/token-speed-tester/blob/master/CHANGELOG.md)

package/README.md CHANGED Viewed

@@ -1,215 +1,272 @@
-# Token Speed Tester
-A CLI tool to test LLM API token output speed for Anthropic and OpenAI compatible APIs.
-## Features
-- **Dual Protocol Support**: Works with both Anthropic Messages API and OpenAI Chat Completions API
-- **Streaming Performance**: Measures each token's arrival time with precision
-- **Comprehensive Metrics**: TTFT, average speed, peak speed, TPS curves
-- **Statistical Analysis**: Mean, min, max, and standard deviation across multiple test runs
-- **ASCII Visualization**: Beautiful terminal-based charts and tables
-- **Custom Endpoints**: Test third-party APIs that are compatible with OpenAI/Anthropic protocols
-## Installation
-### Global Installation
-```bash
-npm install -g token-speed-tester
-```
-### Local Installation
-```bash
-npm install token-speed-tester
-```
-## Usage
-### Basic Usage
-```bash
-# Test Anthropic API (default)
-token-speed-test --api-key sk-ant-xxx
-# Test OpenAI API
-token-speed-test --api-key sk-xxx --provider openai
-```
-### Advanced Options
-```bash
-# Custom model and multiple test runs
-token-speed-test \
-  --api-key sk-ant-xxx \
-  --provider anthropic \
-  --model claude-3-5-sonnet-20241022 \
-  --runs 5
-# Test with custom endpoint and prompt
-token-speed-test \
-  --api-key sk-xxx \
-  --provider openai \
-  --url https://api.example.com/v1 \
-  --model custom-model \
-  --prompt "Explain quantum computing" \
-  --max-tokens 2048 \
-  --runs 10
-```
-### Local Development
-```bash
-# Clone and install dependencies
-git clone https://github.com/Cansiny0320/token-speed-tester.git
-cd token-speed-tester
-npm install
-# Run directly with tsx
-npm run dev -- --api-key sk-ant-xxx
-# Or build and run
-npm run build
-node dist/index.js --api-key sk-ant-xxx
-```
-## Command Line Options
-| Option | Short | Description | Default |
-|--------|-------|-------------|---------|
-| `--api-key` | `-k` | API Key (required) | - |
-| `--provider` | `-p` | API type: `anthropic` or `openai` | `anthropic` |
-| `--model` | `-m` | Model name | Auto-selected by provider |
-| `--url` | `-u` | Custom API endpoint | Official endpoint |
-| `--runs` | `-r` | Number of test runs | `3` |
-| `--prompt` | | Test prompt | "写一篇关于 AI 的短文" |
-| `--max-tokens` | | Maximum output tokens | `1024` |
-### Default Models
-- **Anthropic**: `claude-3-5-sonnet-20241022`
-- **OpenAI**: `gpt-4o-mini`
-## Output Example
-```
-🚀 Token 速度测试工具
-──────────────────────────────────────────
-Provider: anthropic
-Model: claude-3-5-sonnet-20241022
-Max Tokens: 1024
-Runs: 3
-Prompt: 写一篇关于 AI 的短文
-──────────────────────────────────────────
-⏳ 正在运行测试...
-[运行 1]
-  TTFT: 523ms
-  总耗时: 3245ms
-  总 Token 数: 412
-  平均速度: 126.96 tokens/s
-  峰值速度: 156.32 tokens/s
-[运行 2]
-  TTFT: 487ms
-  总耗时: 3189ms
-  总 Token 数: 398
-  平均速度: 124.84 tokens/s
-  峰值速度: 158.41 tokens/s
-[运行 3]
-  TTFT: 501ms
-  总耗时: 3312ms
-  总 Token 数: 405
-  平均速度: 122.28 tokens/s
-  峰值速度: 154.23 tokens/s
-======================================================================
-Token 速度测试报告
-======================================================================
-统计汇总 (N=3)
-┌──────────────────────────────────────────────────────────────────────┐
-│ 指标             │       均值 │    最小值 │    最大值 │    标准差 │
-├──────────────────────────────────────────────────────────────────────┤
-│ TTFT (ms)       │    503.67 │   487.00 │   523.00 │    14.57 │
-├──────────────────────────────────────────────────────────────────────┤
-│ 总耗时 (ms)      │   3248.67 │  3189.00 │  3312.00 │    51.92 │
-├──────────────────────────────────────────────────────────────────────┤
-│ 总 Token 数     │    405.00 │  398.00 │  412.00 │     5.35 │
-├──────────────────────────────────────────────────────────────────────┤
-│ 平均速度        │    124.69 │  122.28 │  126.96 │     1.88 │
-├──────────────────────────────────────────────────────────────────────┤
-│ 峰值速度        │    156.32 │  154.23 │  158.41 │     1.82 │
-└──────────────────────────────────────────────────────────────────────┘
-Token 速度趋势图 (TPS)
-┌────────────────────────────────────────┐
-│ 120 ┤                         █         │
-│ 100 ┤                     █ █ █ █       │
-│  80 ┤                 █ █ █ █ █ █ █     │
-│  60 ┤             █ █ █ █ █ █ █ █ █ █   │
-│  40 ┤         █ █ █ █ █ █ █ █ █ █ █ █   │
-│  20 ┤     █ █ █ █ █ █ █ █ █ █ █ █ █ █   │
-│   0 └────────────────────────────────── │
-│     0s   1s   2s   3s   4s   5s   6s    │
-└────────────────────────────────────────┘
-TPS 分布
-0.0-12.0 │██████████████████████████████████████████████████ 45
-12.0-24.0 │██ 3
-24.0-36.0 │ 0
-36.0-48.0 │ 0
-48.0-60.0 │ 0
-60.0-72.0 │ 0
-72.0-84.0 │ 0
-84.0-96.0 │ 0
-96.0-108.0 │ 0
-108.0-120.0 │ 0
-✅ 测试完成!
-```
-## Metrics Explained
-- **TTFT (Time to First Token)**: Time from request start to first token arrival
-- **Total Time**: Total duration from request to completion
-- **Total Tokens**: Number of output tokens received
-- **Average Speed**: Mean tokens per second (totalTokens / totalTime)
-- **Peak Speed**: Fastest speed measured over a 10-token window
-- **TPS Curve**: Tokens received per second throughout the stream
-## Development
-### Running Tests
-```bash
-# Run tests
-npm test
-# Run tests with UI
-npm run test:ui
-# Generate coverage report
-npm run test:coverage
-```
-### Building
-```bash
-npm run build
-```
-### Test Coverage
-This project maintains 100% code coverage across all modules.
-## License
-MIT License - see [LICENSE](LICENSE) for details.
-## Contributing
-Contributions are welcome! Please feel free to submit a Pull Request.
+# Token 速度测试工具
+> 用于测量和分析 LLM API Token 流式输出性能的命令行工具
+[English](README.en.md) |
+[![npm 版本](https://badge.fury.io/js/token-speed-tester.svg)](https://www.npmjs.com/package/token-speed-tester)
+[![开源协议](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![测试](https://github.com/Cansiny0320/token-speed-tester/actions/workflows/publish.yml/badge.svg)](https://github.com/Cansiny0320/token-speed-tester/actions)
+一个强大的命令行工具，用于测试 LLM API 的 Token 输出速度。支持 **Anthropic** 和 **OpenAI** 兼容的 API，提供详细指标包括 TTFT（首字延迟）、吞吐量、峰值速度以及多次运行的统计分析。
+## 特性
+- **双协议支持**：兼容 Anthropic Messages API 和 OpenAI Chat Completions API
+- **流式性能测量**：以毫秒级精度记录每个 Token 的到达时间
+- **全面指标**：
+  - **TTFT**（首字延迟）：首个 Token 到达前的延迟
+  - **平均速度**：每秒平均 Token 数
+  - **峰值速度**：10 个 Token 滑动窗口内的最快速度
+  - **TPS 曲线**：整个流式响应中每秒接收的 Token 数
+- **统计分析**：多次测试运行的均值、最小值、最大值和标准差
+- **ASCII 可视化**：精美的终端图表和数据表格
+- **自定义端点**：测试兼容 OpenAI/Anthropic 协议的第三方 API
+## 安装
+### 全局安装（推荐）
+```bash
+npm install -g token-speed-tester
+```
+### 使用 npx（无需安装）
+```bash
+npx token-speed-tester --api-key sk-xxx
+```
+### 本地安装
+```bash
+npm install token-speed-tester
+```
+## 使用方法
+### 基本用法
+```bash
+# 测试 Anthropic API（默认）
+token-speed-test --api-key sk-ant-xxx
+# 测试 OpenAI API
+token-speed-test --api-key sk-xxx --provider openai
+```
+### 高级选项
+```bash
+# 自定义模型和多次测试
+token-speed-test \
+  --api-key sk-ant-xxx \
+  --provider anthropic \
+  --model claude-3-5-sonnet-20241022 \
+  --runs 5
+# 测试自定义端点和提示词
+token-speed-test \
+  --api-key sk-xxx \
+  --provider openai \
+  --url https://api.example.com/v1 \
+  --model custom-model \
+  --prompt "解释量子计算" \
+  --max-tokens 2048 \
+  --runs 10
+```
+### 本地开发
+```bash
+# 克隆并安装依赖
+git clone https://github.com/Cansiny0320/token-speed-tester.git
+cd token-speed-tester
+npm install
+# 使用 tsx 直接运行
+npm run dev -- --api-key sk-ant-xxx
+# 或构建后运行
+npm run build
+node dist/index.js --api-key sk-ant-xxx
+```
+## 命令行选项
+| 选项 | 简写 | 说明 | 默认值 |
+|------|------|------|--------|
+| `--api-key` | `-k` | API Key（必填） | - |
+| `--provider` | `-p` | API 类型：`anthropic` 或 `openai` | `anthropic` |
+| `--model` | `-m` | 模型名称 | 根据提供商自动选择 |
+| `--url` | `-u` | 自定义 API 端点 | 官方端点 |
+| `--runs` | `-r` | 测试次数 | `3` |
+| `--prompt` | | 测试提示词 | "写一篇关于 AI 的短文" |
+| `--max-tokens` | | 最大输出 Token 数 | `1024` |
+### 默认模型
+- **Anthropic**: `claude-3-5-sonnet-20241022`
+- **OpenAI**: `gpt-4o-mini`
+## 输出示例
+```
+🚀 Token 速度测试工具
+──────────────────────────────────────────
+Provider: anthropic
+Model: claude-3-5-sonnet-20241022
+Max Tokens: 1024
+Runs: 3
+Prompt: 写一篇关于 AI 的短文
+──────────────────────────────────────────
+⏳ 正在运行测试...
+[运行 1]
+  TTFT: 523ms
+  总耗时: 3245ms
+  总 Token 数: 412
+  平均速度: 126.96 tokens/s
+  峰值速度: 156.32 tokens/s
+[运行 2]
+  TTFT: 487ms
+  总耗时: 3189ms
+  总 Token 数: 398
+  平均速度: 124.84 tokens/s
+  峰值速度: 158.41 tokens/s
+[运行 3]
+  TTFT: 501ms
+  总耗时: 3312ms
+  总 Token 数: 405
+  平均速度: 122.28 tokens/s
+  峰值速度: 154.23 tokens/s
+======================================================================
+Token 速度测试报告
+======================================================================
+统计汇总 (N=3)
+┌──────────────────────────────────────────────────────────────────────┐
+│ 指标             │       均值 │    最小值 │    最大值 │    标准差 │
+├──────────────────────────────────────────────────────────────────────┤
+│ TTFT (ms)       │    503.67 │   487.00 │   523.00 │    14.57 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 总耗时 (ms)      │   3248.67 │  3189.00 │  3312.00 │    51.92 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 总 Token 数     │    405.00 │  398.00 │  412.00 │     5.35 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 平均速度        │    124.69 │  122.28 │  126.96 │     1.88 │
+├──────────────────────────────────────────────────────────────────────┤
+│ 峰值速度        │    156.32 │  154.23 │  158.41 │     1.82 │
+└──────────────────────────────────────────────────────────────────────┘
+Token 速度趋势图 (TPS)
+┌────────────────────────────────────────┐
+│ 120 ┤                         █         │
+│ 100 ┤                     █ █ █ █       │
+│  80 ┤                 █ █ █ █ █ █ █     │
+│  60 ┤             █ █ █ █ █ █ █ █ █ █   │
+│  40 ┤         █ █ █ █ █ █ █ █ █ █ █ █   │
+│  20 ┤     █ █ █ █ █ █ █ █ █ █ █ █ █ █   │
+│   0 └────────────────────────────────── │
+│     0s   1s   2s   3s   4s   5s   6s    │
+└────────────────────────────────────────┘
+TPS 分布
+0.0-12.0 │██████████████████████████████████████████████████ 45
+12.0-24.0 │██ 3
+24.0-36.0 │ 0
+36.0-48.0 │ 0
+48.0-60.0 │ 0
+60.0-72.0 │ 0
+72.0-84.0 │ 0
+84.0-96.0 │ 0
+96.0-108.0 │ 0
+108.0-120.0 │ 0
+✅ 测试完成!
+```
+## 指标说明
+| 指标 | 说明 |
+|------|------|
+| **TTFT** | 首字延迟 - 从请求到首个 Token 到达的时间 |
+| **总耗时** | 从请求到流式响应完成的完整时长 |
+| **总 Token 数** | 接收到的输出 Token 数量 |
+| **平均速度** | 每秒平均 Token 数（totalTokens / totalTime × 1000） |
+| **峰值速度** | 10 个 Token 滑动窗口内测量的最快速度 |
+| **TPS 曲线** | 整个流式响应中每秒接收的 Token 数 |
+## 开发
+### 运行测试
+```bash
+# 运行测试
+npm test
+# 使用 UI 运行测试
+npm run test:ui
+# 生成覆盖率报告
+npm run test:coverage
+```
+### 构建
+```bash
+npm run build
+```
+### 发布
+本项目使用 [semantic-release](https://github.com/semantic-release/semantic-release) 自动管理版本和发布。
+提交信息遵循 [约定式提交](https://www.conventionalcommits.org/zh-hans/) 规范：
+```bash
+# 补丁版本 (1.0.0 -> 1.0.1)
+git commit -m "fix: 修复某个问题"
+# 次要版本 (1.0.0 -> 1.1.0)
+git commit -m "feat: 添加新功能"
+# 主要版本 (1.0.0 -> 2.0.0)
+git commit -m "feat: 添加破坏性变更\n\nBREAKING CHANGE: 废弃旧 API"
+```
+推送到 `master` 分支后，GitHub Actions 会自动：
+- 分析 commit 类型确定版本号
+- 更新 CHANGELOG.md
+- 创建 Git tag
+- 发布到 npm
+- 创建 GitHub Release
+## 测试覆盖率
+本项目保持高代码覆盖率：
+| 覆盖率类型 | 百分比 |
+|---------------|------------|
+| 语句覆盖率 | 99.19% |
+| 分支覆盖率 | 94.73% |
+| 函数覆盖率 | 100% |
+## 开源协议
+MIT © [Cansiny0320](https://github.com/Cansiny0320)
+## 贡献
+欢迎贡献！请随时提交 Pull Request。
+## 相关链接
+- [npm 包](https://www.npmjs.com/package/token-speed-tester)
+- [GitHub 仓库](https://github.com/Cansiny0320/token-speed-tester)
+- [问题反馈](https://github.com/Cansiny0320/token-speed-tester/issues)
+- [更新日志](https://github.com/Cansiny0320/token-speed-tester/blob/master/CHANGELOG.md)

package/dist/index.js CHANGED Viewed

File without changes

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "token-speed-tester",
-  "version": "1.0.0",
+  "version": "1.2.2",
   "description": "A CLI tool to test LLM API token output speed",
   "type": "module",
   "main": "dist/index.js",
@@ -10,6 +10,7 @@
   "files": [
     "dist",
     "README.md",
+    "README.en.md",
     "LICENSE"
   ],
   "scripts": {
@@ -54,6 +55,9 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^13.1.3",
     "@types/node": "^22.10.6",
     "@vitest/coverage-v8": "^2.1.8",
     "@vitest/ui": "^2.1.8",
@@ -62,6 +66,7 @@
     "eslint-plugin-prettier": "^5.5.4",
     "parser": "^0.1.4",
     "prettier": "^3.7.4",
+    "semantic-release": "^25.0.2",
     "tsup": "^8.5.1",
     "tsx": "^4.19.2",
     "typescript": "^5.7.3",