@f5-sales-demo/xcsh-stats

中文文档
23.10.13发布于 2026/11/13MITTypeScriptES Module构建来源已验证近 30 天下载 7793

Local observability dashboard for pi AI usage statistics

原始使用文档
文档目录9 节
  1. Features
  2. Metrics Tracked
  3. Usage
  4. Via CLI
  5. Programmatic
  6. API Endpoints
  7. Data Storage
  8. Dashboard
  9. License

@f5-sales-demo/xcsh-stats

Local observability dashboard for AI usage statistics.

Features

  • Session log parsing: Reads JSONL session logs from ~/.xcsh/agent/sessions/
  • SQLite aggregation: Efficient stats storage and querying using bun:sqlite
  • Web dashboard: Real-time metrics visualization with Chart.js
  • Incremental sync: Only processes new/modified log entries

Metrics Tracked

MetricCalculation
Tokens/soutput_tokens / (duration / 1000)
Cache Ratecache_read / (input + cache_read) * 100
Error Ratecount(stopReason=error) / total_calls * 100
Total CostSum of usage.cost.total
Avg LatencyMean of duration
TTFTMean of ttft (time to first token)

Usage

Via CLI

# 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

Programmatic

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 Endpoints

EndpointDescription
GET /api/statsOverall stats with all breakdowns
GET /api/stats/modelsPer-model statistics
GET /api/stats/foldersPer-folder/project statistics
GET /api/stats/timeseriesHourly time series data
GET /api/syncTrigger sync and return counts

Data Storage

  • Session logs: ~/.xcsh/agent/sessions/ (JSONL files)
  • Stats database: ~/.xcsh/stats.db (SQLite)

Dashboard

The web dashboard provides:

  • Overall metrics cards (requests, cost, cache rate, error rate, duration, tokens/s)
  • Time series chart showing requests and errors over time
  • Per-model breakdown table
  • Per-folder breakdown table
  • Auto-refresh every 30 seconds

License

MIT

版本与发布记录

@f5-sales-demo/xcsh-stats 共发布 450 个版本,首次发布于 2026/06/26;过去 12 个月发布了 450 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
23.10.13latest2026/11/131 天前
23.10.122026/11/113 天前
23.10.112026/11/113 天前
23.10.82026/11/0410 天前
23.10.72026/10/3114 天前
23.10.62026/10/3114 天前

其他发布通道:backfill → 23.3.4。

关于 @f5-sales-demo/xcsh-stats 的常见问题

@f5-sales-demo/xcsh-stats 是什么?

Local observability dashboard for pi AI usage statistics

如何安装 @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 和提交记录判断。