# @f5-sales-demo/xcsh-stats 中文文档

规范地址：https://npmcn.com/package/%40f5-sales-demo/xcsh-stats/

版本：23\.10\.13
npm 元数据更新时间：2026-11-13T03:57:28.814Z
中文译文更新时间：2026-11-14T07:33:27.762Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40f5-sales-demo/xcsh-stats
原文对照：https://npmcn.com/package/%40f5-sales-demo/xcsh-stats/?lang=original
项目主页：https://github.com/f5-sales-demo/xcsh
源码仓库：https://github.com/f5-sales-demo/xcsh

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：94.1 kB，24 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：9 个
- 首次发布：2026-06-26T15:15:34.345Z
- 最新版本发布：2026-11-13T03:57:28.450Z
- 近 30 天下载量：7793（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：450（近 12 个月 450 个）

## 中文简介

Pi AI 使用统计的本地可观察性仪表板

## 安装

```sh
npm install @f5-sales-demo/xcsh-stats
```

也可以使用：`pnpm add @f5-sales-demo/xcsh-stats`、`yarn add @f5-sales-demo/xcsh-stats`、`bun add @f5-sales-demo/xcsh-stats`

## README

# @f5-sales-demo/xcsh-stats 页面存档备份,存于互联网档案馆

AI使用统计的本地可观察仪表板.

## 特征

-   **会话日志解析**:从 `~/.xcsh/agent/sessions/`
-   **SQLite 聚合**: 使用高效数据存储和查询 `bun:sqlite`
-   **网络仪表板**: 图.js的实时可视化计量
-   **递增同步**: 只处理新/已修改的日志条目

## 跟踪到的量子

| 度量衡 | 计算 |
| --- | --- |
| 键/秒 | `output_tokens / (duration / 1000)` |
| 缓存率 | `cache_read / (input + cache_read) * 100` |
| 错误率 | `count(stopReason=error) / total_calls * 100` |
| 费用共计 | 总计 `usage.cost.total` |
| Avg 纬度 | 平均值 `duration` |
| TTFT 电话 | 平均值 `ttft` (时间到第一令牌) |

## 使用量

### 通过 CLI

```bash
# Start dashboard server (default: http://localhost:3847)
xcsh stats

# Custom port
xcsh stats --port 8080

# Print summary to console
xcsh stats --summary

# Output as JSON (for scripting)
xcsh stats --json
```

### 程序化

```typescript
import { getDashboardStats, syncAllSessions } from "@f5-sales-demo/xcsh-stats";

// Sync session logs to database
const { processed, files } = await syncAllSessions();

// Get aggregated stats
const stats = await getDashboardStats();
console.log(stats.overall.totalCost);
console.log(stats.byModel[0].avgTokensPerSecond);
```

## API 终点

| 终点 | 说明 |
| --- | --- |
| `GET /api/stats` | 总体统计数据及所有细目 |
| `GET /api/stats/models` | 按模式统计 |
| `GET /api/stats/folders` | 每个文件夹/项目统计 |
| `GET /api/stats/timeseries` | 小时时间序列数据 |
| `GET /api/sync` | 触发同步并返回计数 |

## 数据存储

-   **会话日志**数字 : `~/.xcsh/agent/sessions/` (JSONL档案)
-   **数据库**数字 : `~/.xcsh/stats.db` (SQLite) (英语)

## 盘子

网络仪表板提供:

-   总的衡量卡(要求、成本、缓存率、出错率、持续时间、信使)
-   显示请求和长期错误的时间序列图表
-   按模型分列的表格
-   每个文件夹的细分表
-   每30秒自动刷新一次

## 许可证

麻省理工学院

## 常见问题

### @f5-sales-demo/xcsh-stats 是什么？

Pi AI 使用统计的本地可观察性仪表板

### 如何安装 @f5-sales-demo/xcsh-stats？

在项目目录运行 npm install @f5-sales-demo/xcsh-stats，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 xcsh-stats，可以用 npx xcsh-stats 直接运行。

### @f5-sales-demo/xcsh-stats 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @f5-sales-demo/xcsh-stats 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @f5-sales-demo/xcsh-stats 可以商用吗？

@f5-sales-demo/xcsh-stats 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @f5-sales-demo/xcsh-stats 的下载量有多少？

根据 npm 官方下载统计，@f5-sales-demo/xcsh-stats 在 2026/10/14 – 2026/11/12 这 30 天内被下载 7,793 次，日均约 260 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @f5-sales-demo/xcsh-stats 还在维护吗？

最新版本 23\.10\.13 发布于 2026/11/13（1 天前）；至今共发布 450 个版本，其中过去 12 个月发布了 450 个；首次发布于 2026/06/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。