# AxonX 文档导航

AxonX 是面向金融量化研究的 Agent Harness。插件提供算法，Task 定义研究步骤的输入与输出，框架管理执行、记录和产物。研究人员、外部 Agent 与脚本通过 Studio、CLI 或 MCP 使用同一套 Job 与工作区记录。

## 选择你的起点

| 目标                | 从哪里开始                                                                           | 完成后你能做什么                     |
| ------------------- | ------------------------------------------------------------------------------------ | ------------------------------------ |
| 第一次使用 AxonX    | [快速开始](https://flowllm-ai.github.io/AxonX/zh/getting-started/quickstart) → [Studio 入门](https://flowllm-ai.github.io/AxonX/zh/getting-started/studio) | 提交 demo、等待终态、检查参数与结果  |
| 开展量化研究        | [研究总览](https://flowllm-ai.github.io/AxonX/zh/research/overview) → [研究流程](https://flowllm-ai.github.io/AxonX/zh/research/workflow)                  | 准备数据，串联 ETL、训练、预测和回测 |
| 让外部 Agent 做研究 | [Agent 接入总览](https://flowllm-ai.github.io/AxonX/zh/agent/overview) → [外部 Agent](https://flowllm-ai.github.io/AxonX/zh/agent/external)                | 通过 Skill、CLI 或 MCP 操作研究服务  |
| 在 Studio 中对话    | [内置 Agent 配置](https://flowllm-ai.github.io/AxonX/zh/agent/configuration) → [内置 Agent 使用](https://flowllm-ai.github.io/AxonX/zh/agent/usage)        | 查询任务、排障、解释已有研究证据     |
| 部署或管理任务      | [运行总览](https://flowllm-ai.github.io/AxonX/zh/guides/overview) → [远程机器](https://flowllm-ai.github.io/AxonX/zh/guides/remote-machines)               | 跟踪执行、管理文件、连接目标服务     |
| 编写插件或接入代码  | [开发总览](https://flowllm-ai.github.io/AxonX/zh/development/overview) → [Task 契约](https://flowllm-ai.github.io/AxonX/zh/reference/task-contracts)       | 实现研究 Task，注册插件，调用服务    |

先了解项目定位和实验案例，可读[项目概览](https://flowllm-ai.github.io/AxonX/zh/getting-started/overview)。内置 demo 不需要行情或模型凭据；研究插件需要数据，内置 Agent 需要模型配置，外部 Agent 使用自身宿主的模型配置。

## 文档如何组织

### 开始使用：建立最小闭环

从[快速开始](https://flowllm-ai.github.io/AxonX/zh/getting-started/quickstart)完成一次真实执行，再用 [Studio](https://flowllm-ai.github.io/AxonX/zh/getting-started/studio)查看同一工作区。随后阅读[架构](https://flowllm-ai.github.io/AxonX/zh/concepts/architecture)、[Job 与 Task](https://flowllm-ai.github.io/AxonX/zh/concepts/jobs-and-tasks)、[任务生命周期](https://flowllm-ai.github.io/AxonX/zh/concepts/task-lifecycle)、[任务血缘](https://flowllm-ai.github.io/AxonX/zh/concepts/task-lineage)和[工作区](https://flowllm-ai.github.io/AxonX/zh/concepts/workspace)，理解提交、执行与持久记录之间的关系。

### 量化研究：从数据到可检查的结论

先从[研究总览](https://flowllm-ai.github.io/AxonX/zh/research/overview)选择目标。[研究流程](https://flowllm-ai.github.io/AxonX/zh/research/workflow)和 [Tushare 数据](https://flowllm-ai.github.io/AxonX/zh/research/tushare)负责数据准备与阶段执行；[结果解读](https://flowllm-ai.github.io/AxonX/zh/research/results)负责检查各阶段产物；[实验设计与确认](https://flowllm-ai.github.io/AxonX/zh/research/experiments)、[回测口径](https://flowllm-ai.github.io/AxonX/zh/research/backtest)和[策略比较](https://flowllm-ai.github.io/AxonX/zh/research/strategy-comparison)负责评估证据。

[插件管理](https://flowllm-ai.github.io/AxonX/zh/plugins/management)说明安装、发现和部署。[Alpha158](https://flowllm-ai.github.io/AxonX/zh/plugins/alpha158)是基础研究链，[Alpha158 Enhanced](https://flowllm-ai.github.io/AxonX/zh/plugins/alpha158-enhanced)提供增强特征、消融和独立确认的具体案例。算法参数与实验数值以插件文档为准。

### Agent：选择外部宿主或内置会话

[接入总览](https://flowllm-ai.github.io/AxonX/zh/agent/overview)说明两条路径的前置条件。[外部 Agent](https://flowllm-ai.github.io/AxonX/zh/agent/external)介绍 Skill 与 CLI 的研究操作，[MCP 接入](https://flowllm-ai.github.io/AxonX/zh/agent/mcp-integration)解释服务工具发现与响应；[内置配置](https://flowllm-ai.github.io/AxonX/zh/agent/configuration)和[内置使用](https://flowllm-ai.github.io/AxonX/zh/agent/usage)介绍 Studio 中的 Claude Agent SDK 会话。

### 运行与部署：维护服务和执行环境

[运行总览](https://flowllm-ai.github.io/AxonX/zh/guides/overview)串联服务准备与记录维护。日常操作包括[任务管理](https://flowllm-ai.github.io/AxonX/zh/guides/task-management)、[文件浏览](https://flowllm-ai.github.io/AxonX/zh/guides/workspace-files)和[任务快照同步](https://flowllm-ai.github.io/AxonX/zh/guides/task-sync)。部署先阅读[鉴权](https://flowllm-ai.github.io/AxonX/zh/guides/authentication)、[服务托管](https://flowllm-ai.github.io/AxonX/zh/guides/deployment)与[远程机器](https://flowllm-ai.github.io/AxonX/zh/guides/remote-machines)，按需设置 [HTTP 代理](https://flowllm-ai.github.io/AxonX/zh/guides/http-proxy)、[定时 Job](https://flowllm-ai.github.io/AxonX/zh/guides/scheduling)及[钉钉通知](https://flowllm-ai.github.io/AxonX/zh/research/notifications)。故障、备份和恢复见[运维指南](https://flowllm-ai.github.io/AxonX/zh/guides/operations)。

### 接口参考：查参数和响应

先在[参考总览](https://flowllm-ai.github.io/AxonX/zh/reference/overview)选择接口。命令语法见 [CLI](https://flowllm-ai.github.io/AxonX/zh/reference/cli)，程序调用见 [Python](https://flowllm-ai.github.io/AxonX/zh/reference/python)，连接与启动字段见[客户端配置](https://flowllm-ai.github.io/AxonX/zh/reference/client-configuration)和[服务端配置](https://flowllm-ai.github.io/AxonX/zh/reference/configuration)。

HTTP 协议从 [API 总览](https://flowllm-ai.github.io/AxonX/zh/api/overview)开始，按需查询[任务](https://flowllm-ai.github.io/AxonX/zh/api/tasks)、[事件](https://flowllm-ai.github.io/AxonX/zh/api/events)、[文件](https://flowllm-ai.github.io/AxonX/zh/api/workspace)、[机器](https://flowllm-ai.github.io/AxonX/zh/api/machines)、[插件与同步](https://flowllm-ai.github.io/AxonX/zh/api/plugins-sync)和 [Agent 会话](https://flowllm-ai.github.io/AxonX/zh/api/agent)。

### 开发扩展：实现能力并保持契约

先在[开发总览](https://flowllm-ai.github.io/AxonX/zh/development/overview)选择扩展层。[贡献指南](https://flowllm-ai.github.io/AxonX/zh/development/contributing)负责开发环境与检查要求，[开发与运行指南](https://flowllm-ai.github.io/AxonX/zh/dev_guide)负责 Task 开发和 CLI 实践，[框架扩展](https://flowllm-ai.github.io/AxonX/zh/development/framework-extensions)与 [Studio 开发](https://flowllm-ai.github.io/AxonX/zh/development/studio)负责各自扩展点。实现时查阅 [Task 契约](https://flowllm-ai.github.io/AxonX/zh/reference/task-contracts)、[插件协议](https://flowllm-ai.github.io/AxonX/zh/reference/plugin-manifest)和[研究产物协议](https://flowllm-ai.github.io/AxonX/zh/reference/research-artifacts)。

## 阅读约定

操作指南围绕具体目标组织；参考页给出字段、响应与边界；项目和插件 README 分别维护项目概览与算法说明。中英文使用相同页面路径，截图和图示共用英文资源。

示例凭据、地址和 Task ID 需要替换为实际值。以所连服务发现的 Job 与 Task Schema 为准；提交成功后仍需等待 Task 终态。同名重跑会替换已结束任务的目录，实验比较应保留不同身份的记录。

遇到问题先查[常见问题](https://flowllm-ai.github.io/AxonX/zh/faq)，再按[运维指南](https://flowllm-ai.github.io/AxonX/zh/guides/operations)定位服务、Job 或 Task 层的故障。