Imported from banbox/bandoc (AGENTS.md). Install upstream with npx skills add banbox/bandoc. Copyright stays with the author.

BanBot 文档项目概述

项目整体概述

BanBot文档项目旨在为BanBot量化交易机器人的用户和开发者提供全面的中英文技术和使用参考。文档内容涵盖了从快速入门、安装部署到核心API、高级功能和开发指南等各个方面，帮助用户更好地理解和使用BanBot。

文件索引

zh-CN/ (中文文档)

• index.md: 中文文档首页，介绍BanBot的高性能、易用性、灵活性等特点。

zh-CN/advanced/ (高级功能)

• ai.md: 介绍如何结合AI/机器学习工具，通过gRPC实现高级交易策略。
• custom_cmd.md: 指导用户如何注册自定义终端命令，并介绍了内置的数据验证和报告生成工具命令。
• kline_tools.md: 介绍K线数据管理工具，包括下载、导入、导出、删除和纠正K线数据。

zh-CN/api/ (API文档)

• biz.md: 核心业务逻辑包，包含订单、钱包和交易管理器等。
• btime.md: 时间处理包，提供统一的时间接口，兼容回测与实盘模式。
• config.md: 配置管理包，负责加载和解析项目的所有配置，包括命令行参数和YAML文件。
• core.md: 核心类型包，定义了项目运行模式、环境、核心数据结构和全局变量。
• data.md: 数据处理包，提供数据提供者、数据喂食器和爬虫等功能，为回测和实盘提供统一的数据源。
• entry.md: 程序入口包，提供命令行接口的入口方法。
• exg.md: 交易所接口包，封装了与交易所交互的逻辑。
• goods.md: 交易对筛选包，提供了多种过滤器用于筛选和管理交易对。
• live.md: 实盘交易包，提供了实时交易相关的功能，包括定时任务、交易器和Web API。
• opt.md: 回测与优化包，提供了策略回测和超参数优化的功能。
• orm.md: 数据库交互包，提供了数据库访问和数据模型定义的功能。
• rpc.md: 远程过程调用包，用于消息通知和异常上报。
• strat.md: 交易策略包，定义了策略的核心结构和管理逻辑。
• utils.md: 通用工具包，提供文件、数学、字符串等多种辅助函数。
• web.md: Web服务包，提供了启动Web UI和监控面板的功能。

zh-CN/guide/ (使用指南)

• basic.md: 介绍BanBot的基本概念、术语、核心组件和执行逻辑。
• bot_usage.md: 指导如何使用编译后的bot可执行文件，涵盖了WebUI、回测、实盘交易和各种子命令的用法。
• configuration.md: 详细介绍了 banbot 的 yaml 配置文件结构和所有可用选项。
• faq.md: 提供了常见问题解答。
• hyperopt.md: 介绍了如何使用超参数优化功能。
• init_project.md: 指导用户如何初始化一个新的 BanBot 策略项目。
• install.md: 提供了安装 BanBot 运行环境的说明，包括 TimeScaleDB 和 Go。
• live_trading.md: 详细介绍了如何部署 BanBot 进行实盘交易，包括编译、配置和启动机器人。
• pair_filters.md: 介绍了所有可用的交易对过滤器及其配置。
• quick_local.md: 提供了在本地环境中快速配置和运行 BanBot 的分步指南。
• roll_btopt.md: 介绍了如何使用滚动回测功能。
• start.md: 介绍了banbot：主要特性、UI支持、支持交易所、Q&A等。
• strat_custom.md: 自定义策略：创建、实现、技术指标、自定义指标、K线预热、订阅其他时间周期K线、入场和离场、批量任务、止盈止损、高频数据订阅、http接口回调；