# TokenScope

**Repository Path**: limcod/token-scope

## Basic Information

- **Project Name**: TokenScope
- **Description**: 主要功能有token的使用情况分析和使用量的计算
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-17
- **Last Updated**: 2026-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Token Scope

Token Scope 是一款专为开发者设计的 AI 编程工具使用追踪与成本分析仪表盘。作为一个自托管 solution，帮助您监控和优化 AI 编码助手（如 Claude Code、Copilot、Cursor）的使用成本。

## 功能特性

- **多工具支持**：兼容 Claude Code、Copilot、Cursor 等主流 AI 编程工具
- **实时监控**：实时追踪 Token 使用情况，支持 SSE 实时推送
- **成本分析**：自动计算各工具的使用成本，支持 USD/CNY 货币切换
- **可视化图表**：提供饼图、柱状图、仪表盘、趋势图等多种可视化组件
- **会话管理**：记录并分析 AI 对话会话，支持多项目分组
- **告警功能**：自定义成本阈值，支持告警通知
- **灵活配置**：支持自定义定价模型与工具配置

## 技术栈

- **前端框架**：Nuxt 3 + Vue 3
- **数据库**：SQLite (drizzle ORM)
- **图表库**：ECharts
- **样式**：CSS

## 快速开始

### 环境要求

- Node.js 18+
- pnpm / npm

### 安装依赖

```bash
pnpm install
```

### 配置环境

复制 `.env.example` 并重命名为 `.env`，根据需要配置：

```bash
cp .env.example .env
```

### 启动开发服务器

```bash
pnpm dev
```

访问 `http://localhost:3000` 即可进入应用。

### 生产构建

```bash
pnpm build
pnpm start
```

## 项目结构

```
├── components/          # Vue 组件
│   ├── charts/         # 图表组件
│   ├── dashboard/     # 仪表盘组件
│   ├── layout/        # 布局组件
│   └── shared/        # 共享组件
├── composables/        # Nuxt 组合式函数
├── data/               # 数据文件
├── layouts/           # 页面布局
├── lib/               # 工具函数与常量
├── middleware/        # Nuxt 中间件
├── pages/             # 页面路由
├── server/            # 服务端逻辑
│   ├── api/          # API 接口
│   ├── lib/          # 服务端工具库
│   │ ├── collectors/ # 日志收集器
│   │ └── pricing/    # 定价逻辑
│   └── plugins/      # 服务端插件
└── types/            # TypeScript 类型定义
```

## 支持的工具

| 工具 | 描述 |
|------|------|
| Claude Code | Anthropic Claude 编程助手 |
| Copilot | GitHub Copilot |
| Cursor | AI 驱动的代码编辑器 |

## 配置说明

### 定价配置

编辑 `data/pricing.json` 自定义各模型的定价：

```json
{
  "claude-code": {
    "models": {
      "claude-3-5-sonnet": {
        "input": 3.0,
        "output": 15.0
      }
    }
  }
}
```

### 应用设置

编辑 `data/settings.json` 配置应用参数：

```json
{
  "theme": "light",
  "currency": "USD",
  "exchangeRate": 1,
  "costAlert": {
    "enabled": true,
    "threshold": 100
  }
}
```

## API 接口

| 接口 | 方法 | 描述 |
|------|------|------|
| `/api/summary` | GET | 获取统计摘要 |
| `/api/sessions` | GET | 获取会话列表 |
| `/api/requests` | GET | 获取请求记录 |
| `/api/pricing` | GET | 获取定价信息 |
| `/api/settings` | GET/PUT | 获取/更新设置 |
| `/api/projects` | GET | 获取项目列表 |
| `/api/tools` | GET | 获取工具列表 |
| `/api/events` | GET | SSE 实时事件流 |

## 许可证

MIT License