# tradex

**Repository Path**: nnquant/tradex

## Basic Information

- **Project Name**: tradex
- **Description**: 基于 Claude Code CLI 开发的面向量化研究与交易基建的实验性项目。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2025-11-10
- **Last Updated**: 2025-12-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Python, 量化交易, 智能体

## README

Tradex
======
基于 Claude Code CLI 开发的面向量化研究与交易基建的实验性项目。

# 安装指南

一键安装（推荐）
----------------

1. 获取 Tradex 仓库（例如 `git clone https://github.com/nnquant/tradex.git` 或下载压缩包）并进入根目录。
2. 以管理员权限打开 PowerShell 或 CMD，定位到仓库根目录。
3. 运行脚本：

```powershell
.\install.cmd
```

脚本按照最少输出的原则完成以下任务：

1. 安装 Node.js / npm（优先 `winget install -e --id OpenJS.NodeJS.LTS`，失败则回落至 npmmirror 安装包）。
2. 按需把 npm registry 设置为 `https://registry.npmmirror.com`，安装/检测 `@anthropic-ai/claude-code` CLI。
3. 安装 `uv`，并在选择加速的情况下把 `uv pip` 的 index 指向清华镜像。
4. 执行 `uv sync` 还原 Python 依赖。
5. 自动运行 `uv run tradex config`，引导你创建/校验 `tradex.config.toml`。

配置向导顺利结束后，终端会提示命令 `uv run tradex` 以启动主应用。若脚本无法把 `%APPDATA%\npm` 等目录加入 PATH，请根据提示手动处理。

手动安装
--------

如需完全手动操作，可参考以下步骤（建议使用管理员窗口）：

### 1. 安装 Git 并克隆仓库

```powershell
winget install -e --id Git.Git
git clone https://github.com/nnquant/tradex.git
cd tradex
```

### 2. 安装 Node.js 与 npm

- 推荐命令：`winget install -e --id OpenJS.NodeJS.LTS`
- 如需离线，可从 [npmmirror Node 镜像](https://npmmirror.com/mirrors/node/) 下载对应版本 MSI。
- 安装完成后执行：

```powershell
npm config set registry https://registry.npmmirror.com
```

这样后续的全局 npm 安装都会走国内镜像。

### 3. 安装 Claude Code CLI

Claude Code 提供本地 Agent CLI，是 `claude_agent_sdk` 的运行依赖。

```powershell
npm install -g @anthropic-ai/claude-code
claude --version
```

若 `claude` 未被识别，请确认 `%APPDATA%\npm` 或自定义 npm 全局 bin 目录已写入 PATH。可通过 `npm config get prefix` 查询实际安装路径。

### 4. 安装 uv

`uv` 是项目统一的 Python 包/环境管理器：

```powershell
powershell -NoLogo -NoProfile -ExecutionPolicy Bypass -Command "Invoke-WebRequest https://astral.sh/uv/install.ps1 -UseBasicParsing | Invoke-Expression"
uv pip config set --global index-url https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple
```

若使用自定义镜像，请将 `index-url` 替换成你的内部源。

### 5. 同步 Python 依赖

在仓库根目录执行：

```powershell
uv sync
```

该命令会根据 `uv.lock` 精确还原虚拟环境，确保算法和工具链具有可复现性。

### 6. CLI 验证与配置

- `node -v` / `npm -v` 显示版本；
- `claude --version` 至少为 2.0.0；
- `uv --version` 正常输出；
- `uv run tradex config` 打开配置助手，完成后即可通过 `uv run tradex` 启动主应用。

开始使用
--------

1. 运行配置向导  
   ```shell
   uv run tradex config
   ```  
   配置助手会引导你选择或创建 `tradex.config.toml`，并逐项填写模型、权限、扩展等字段；如需多份配置，可在向导内自定义文件名。

2. 启动主应用  
   ```shell
   uv run tradex
   ```  
   默认读取仓库根目录下的配置文件，若向导中保存为其它名称，可加 `--config path/to/xxx.toml` 切换。首次运行请观察终端日志，确认模型连通性、扩展加载状态及账户接口是否正常。