Skip to content

zhushanwen321/local-akshare-skills-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AKShare 本地文档库 & Claude Code Skill

本仓库提供 AKShare API 的本地化文档查询能力,帮助开发者在 Claude Code 中快速查询 AKShare 接口使用方法。

项目简介

AKShare 是一个开源的财经数据接口库,涵盖了股票、期货、债券、基金、宏观经济等 999 个财经数据接口。本仓库将 AKShare 官方文档提取到本地,并提供 Claude Code Skill,让开发者能够在开发过程中快速查询接口使用方法。

目录结构

local-akshare-skills-docs/
├── SKILL.md                    # Claude Code skill 定义
├── README.md                   # 本文件
├── scripts/
│   ├── update_docs.sh          # 一键更新入口
│   ├── fetch_docs.py           # 文档提取与拆分脚本
│   └── generate_index.py       # 索引生成脚本
└── docs/
    ├── local_index.md           # 自动生成的接口索引
    ├── akshare_api_pitfalls.md  # API 踩坑文档
    ├── stock/                   # 股票数据(~440 接口)
    ├── futures/                 # 期货数据
    ├── bond/                    # 债券数据
    └── ...(共 21 个分类,999 个接口)

安装方法

将本项目克隆到 Claude Code 的 skills 目录:

# 确保 skills 目录存在
mkdir -p ~/.claude/skills

# 克隆本项目
git clone <repository-url> ~/.claude/skills/akshare-doc-query

# 或者复制已有项目
cp -r /path/to/local-akshare-skills-docs ~/.claude/skills/akshare-doc-query

使用方法

在 Claude Code 中有两种使用方式:

方式 1:通过 Skill 命令

/akshare-doc-query 如何获取贵州茅台的实时股价?

方式 2:直接提问

Claude Code 会自动识别与 AKShare 相关的问题并查询本地文档。

akshare 中如何获取沪深300的历史数据?

更新文档

当 AKShare 更新后,可以重新提取文档:

# 进入项目目录
cd ~/.claude/skills/akshare-doc-query

# 执行更新脚本
bash scripts/update_docs.sh --repo-path=/path/to/akshare

与 AKShare 官方的关系

本仓库是一个独立的本地文档工具,与 AKShare 官方仓库无直接关联。所有文档内容均提取自 AKShare 官方文档,遵循原项目的开源协议。

常见问题

Q: 为什么需要本地文档?

A: 本地文档可以提供更快的查询速度,并且可以在离线环境下使用。同时,通过 Claude Code Skill 集成,可以在开发过程中无缝查询文档。

Q: 文档更新频率如何?

A: 建议在 AKShare 发布新版本后更新一次本地文档。

Q: 遇到接口问题怎么办?

A: 首先查看 docs/akshare_api_pitfalls.md 中的常见问题,然后查询具体接口文档。如果问题仍未解决,可以访问 AKShare 官方仓库提 issue。

相关链接

About

AKShare 本地文档库 & Claude Code Skill — 999 个 API 接口文档,支持一键生成

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors