From de01a55aa2b1fe61dc6063493d28c65a66a1d6b2 Mon Sep 17 00:00:00 2001
From: IamFurina <emotionui@qq.com>
Date: Thu, 17 Jul 2025 18:37:34 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=8F=8A=E6=97=B6=E6=9B=B4=E6=96=B0?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=86=85=E5=AE=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .env                |   4 +-
 README.MD           |   4 +-
 public/docs/home.md | 350 ++------------------------------------------
 3 files changed, 18 insertions(+), 340 deletions(-)

diff --git a/.env b/.env
index b977252..da4e6b9 100644
--- a/.env
+++ b/.env
@@ -19,10 +19,10 @@ FOLLOW_SOURCE_ORDER = true
 NETEASE_COOKIE = ""
 # JOOX cookie
 # 格式：JOOX_COOKIE="wmid=<your_wmid>; session_key=<your_session_key>"
-JOOX_COOKIE	= ""
+JOOX_COOKIE = ""
 # 咪咕 cookie
 # 格式：MIGU_COOKIE="<your_aversionid>"
-MIGU_COOKIE	= ""
+MIGU_COOKIE = ""
 # qq cookie
 # 格式：QQ_COOKIE="uin=<your_uin>; qm_keyst=<your_qm_keyst>"
 QQ_COOKIE = ""
diff --git a/README.MD b/README.MD
index fd81096..a8504f9 100644
--- a/README.MD
+++ b/README.MD
@@ -18,7 +18,7 @@
 ```bash
 git clone https://github.com/NeteaseCloudMusicApiReborn/api.git
 cd api
-pnpm install
+pnpm i
 ```
 
 ### 启动服务
@@ -87,7 +87,7 @@ banner({ type: 0 }).then((res) => console.log(res))
 ## 单元测试
 
 ```bash
-npm test
+pnpm test
 ```
 
 ## 主要功能特性
diff --git a/public/docs/home.md b/public/docs/home.md
index bbde81d..75aa662 100644
--- a/public/docs/home.md
+++ b/public/docs/home.md
@@ -14,329 +14,12 @@
 
 跨站请求伪造 (CSRF), 伪造请求头 , 调用官方 API
 
-## 功能特性
-
-1. 登录
-2. 刷新登录
-3. 发送验证码
-4. 校验验证码
-5. 注册(修改密码)
-6. 获取用户信息 , 歌单，收藏，mv, dj 数量
-7. 获取用户歌单
-8. 获取用户电台
-9. 获取用户关注列表
-10. 获取用户粉丝列表
-11. 获取用户动态
-12. 获取用户播放记录
-13. 获取精品歌单
-14. 获取歌单详情
-15. 搜索
-16. 搜索建议
-17. 获取歌词
-18. 歌曲评论
-19. 收藏单曲到歌单
-20. 专辑评论
-21. 歌单评论
-22. mv 评论
-23. 电台节目评论
-24. banner
-25. 获取歌曲详情
-26. 获取专辑内容
-27. 获取歌手单曲
-28. 获取歌手 mv
-29. 获取歌手专辑
-30. 获取歌手描述
-31. 获取相似歌手
-32. 获取相似歌单
-33. 相似 mv
-34. 获取相似音乐
-35. 获取最近 5 个听了这首歌的用户
-36. 获取每日推荐歌单
-37. 获取每日推荐歌曲
-38. 私人 FM
-39. 签到
-40. 喜欢音乐
-41. 垃圾桶
-42. 歌单 ( 网友精选碟 )
-43. 新碟上架
-44. 热门歌手
-45. 最新 mv
-46. 推荐 mv
-47. 推荐歌单
-48. 推荐新音乐
-49. 推荐电台
-50. 推荐节目
-51. 独家放送
-52. mv 排行
-53. 获取 mv 数据
-54. 播放 mv/视频
-55. 排行榜
-56. 歌手榜
-57. 云盘
-58. 电台 - 推荐
-59. 电台 - 分类
-60. 电台 - 分类推荐
-61. 电台 - 订阅
-62. 电台 - 详情
-63. 电台 - 节目
-64. 给评论点赞
-65. 获取动态列表
-66. 热搜列表(简略)
-67. 发送私信
-68. 发送私信歌单
-69. 新建歌单
-70. 收藏/取消收藏歌单
-71. 歌单分类
-72. 收藏的歌手列表
-73. 订阅的电台列表
-74. 相关歌单
-75. 付费精选接口
-76. 音乐是否可用检查接口
-77. 登录状态
-78. 获取视频播放地址
-79. 发送/删除评论
-80. 热门评论
-81. 视频评论
-82. 退出登录
-83. 所有榜单
-84. 所有榜单内容摘要
-85. 收藏视频
-86. 收藏 MV
-87. 视频详情
-88. 相关视频
-89. 关注用户
-90. 新歌速递
-91. 喜欢音乐列表(无序)
-92. 收藏的 MV 列表
-93. 获取最新专辑
-94. 听歌打卡
-95. 获取视频标签/分类下的视频
-96. 已收藏专辑列表
-97. 获取动态评论
-98. 歌单收藏者列表
-99. 云盘歌曲删除
-100. 热门话题
-101. 电台 - 推荐类型
-102. 电台 - 非热门类型
-103. 电台 - 今日优选
-104. 心动模式/智能播放
-105. 转发动态
-106. 删除动态
-107. 分享歌曲、歌单、mv、电台、电台节目到动态
-108. 通知-私信
-109. 通知-评论
-110. 通知-@我
-111. 通知-通知
-112. 设置
-113. 云盘数据详情
-114. 私信内容
-115. 我的数字专辑
-116. batch 批量请求接口
-117. 获取视频标签列表
-118. 全部 mv
-119. 网易出品 mv
-120. 收藏/取消收藏专辑
-121. 专辑动态信息
-122. 热搜列表(详细)
-123. 更换绑定手机
-124. 检测手机号码是否已注册
-125. 初始化昵称
-126. 更新歌单描述
-127. 更新歌单名
-128. 更新歌单标签
-129. 默认搜索关键词
-130. 删除歌单
-131. 电台 banner
-132. 用户电台
-133. 热门电台
-134. 电台 - 节目详情
-135. 电台 - 节目榜
-136. 电台 - 新晋电台榜/热门电台榜
-137. 类别热门电台
-138. 云村热评(官方下架,暂不能用)
-139. 电台 24 小时节目榜
-140. 电台 24 小时主播榜
-141. 电台最热主播榜
-142. 电台主播新人榜
-143. 电台付费精品榜
-144. 歌手热门 50 首歌曲
-145. 购买数字专辑
-146. 获取 mv 点赞转发评论数数据
-147. 获取视频点赞转发评论数数据
-148. 调整歌单顺序
-149. 调整歌曲顺序
-150. 独家放送列表
-151. 获取推荐视频
-152. 获取视频分类列表
-153. 获取全部视频列表接口
-154. 获取历史日推可用日期列表
-155. 获取历史日推详细数据
-156. 国家编码列表
-157. 首页-发现
-158. 首页-发现-圆形图标入口列表
-159. 全部新碟
-160. 数字专辑-新碟上架
-161. 数字专辑&数字单曲-榜单
-162. 数字专辑-语种风格馆
-163. 数字专辑详情
-164. 更新头像
-165. 歌单封面上传
-166. 楼层评论
-167. 歌手全部歌曲
-168. 精品歌单标签列表
-169. 用户等级信息
-170. 电台个性推荐
-171. 用户绑定信息
-172. 用户绑定手机
-173. 新版评论
-174. 点赞过的视频
-175. 收藏视频到视频歌单
-176. 删除视频歌单里的视频
-177. 最近播放的视频
-178. 音乐日历
-179. 电台订阅者列表
-180. 云贝签到信息
-181. 云贝签到
-182. 云贝所有任务
-183. 云贝 todo 任务
-184. 云贝今日签到信息
-185. 云贝完成任务
-186. 云贝收入
-187. 云贝支出
-188. 云贝账户信息
-189. 账号信息
-190. 最近联系人
-191. 私信音乐
-192. 抱一抱评论
-193. 评论抱一抱列表
-194. 收藏的专栏
-195. 关注歌手新歌
-196. 关注歌手新 MV
-197. 歌手详情
-198. 云盘上传
-199. 二维码登录
-200. 话题详情
-201. 话题详情热门动态
-202. 歌单详情动态
-203. 绑定手机
-204. 一起听状态
-205. 用户历史评论
-206. 云盘歌曲信息匹配纠正
-207. 云贝推歌
-208. 云贝推歌历史记录
-209. 已购单曲
-210. 获取 mlog 播放地址
-211. 将 mlog id 转为视频 id
-212. vip 成长值
-213. vip 成长值获取记录
-214. vip 任务
-215. 领取 vip 成长值
-216. 歌手粉丝
-217. 数字专辑详情
-218. 数字专辑销量
-219. 音乐人数据概况
-220. 音乐人播放趋势
-221. 音乐人任务
-222. 账号云豆数
-223. 领取云豆
-224. 获取 VIP 信息
-225. 音乐人签到
-226. 获取客户端歌曲下载 url
-227. 获取歌单所有歌曲
-228. 乐签信息
-229. 获取歌手视频
-230. 最近播放-歌曲
-231. 最近播放-视频
-232. 最近播放-声音
-233. 最近播放-歌单
-234. 最近播放-专辑
-235. 最近播放-播客
-236. 签到进度
-237. 重复昵称检测
-238. 歌手粉丝数量
-239. 音乐人任务(新)
-240. 内部版本接口
-241. 歌单更新播放量
-242. 黑胶时光机
-243. 音乐百科 - 简要信息
-244. 乐谱列表
-245. 乐谱内容
-246. 曲风列表
-247. 曲风偏好
-248. 曲风详情
-249. 曲风-歌曲
-250. 曲风-专辑
-251. 曲风-歌单
-252. 曲风-歌手
-253. 私信和通知接口
-254. 回忆坐标
-255. 播客搜索
-256. 播客声音上传
-257. 验证接口-二维码生成
-258. 验证接口-二维码检测
-259. 听歌识曲
-260. 根据nickname获取userid接口
-261. 播客声音列表
-262. 专辑简要百科信息
-263. 歌曲简要百科信息
-264. 歌手简要百科信息
-265. mv简要百科信息
-266. 搜索歌手
-267. 用户贡献内容
-268. 用户贡献条目、积分、云贝数量
-269. 年度听歌报告
-270. 播客声音搜索
-271. 播客声音排序
-272. 播客列表详情
-273. 本地歌曲文件匹配网易云歌曲信息
-274. 歌曲音质详情
-275. 歌曲红心数量
-276. 私人 FM 模式选择
-277. 播客删除
-278. 电台排行榜获取
-279. 获取声音歌词
-280. 获取专辑歌曲的音质
-281. 歌手动态信息
-282. 最近听歌列表
-283. 云盘导入歌曲
-284. 获取客户端歌曲下载链接 - 新版
-285. 当前账号关注的用户/歌手
-286. 会员下载歌曲记录
-287. 会员本月下载歌曲记录
-288. 已购买单曲
-289. 歌曲是否喜爱
-290. 用户是否互相关注
-291. 歌曲动态封面
-292. 用户徽章
-293. 用户状态
-294. 用户状态 - 支持设置的状态
-295. 用户状态 - 相同状态的用户
-296. 用户状态 - 编辑
-297. 听歌足迹 - 年度听歌足迹
-298. 听歌足迹 - 今日收听
-299. 听歌足迹 - 总收听时长
-300. 听歌足迹 - 本周/本月收听时长
-301. 听歌足迹 - 周/月/年收听报告
-302. 歌单导入 - 元数据/文字/链接导入
-303. 歌单导入 - 任务状态
-304. 副歌时间
-305. 相关歌单推荐
-306. 歌词摘录 - 歌词摘录信息
-307. 歌词摘录 - 我的歌词本
-308. 歌词摘录 - 添加/修改摘录歌词
-309. 歌词摘录 - 删除摘录歌词
-310. 广播电台 - 分类/地区信息
-311. 广播电台 - 我的收藏
-312. 广播电台 - 电台信息
-313. 广播电台 - 全部电台
-314. 广播电台 - 收藏/取消收藏电台
-
 ## 安装
 
 ```shell
-$ git clone git@gitlab.com:Binaryify/NeteaseCloudMusicApi.git
-$ cd NeteaseCloudMusicApi
-$ npm install
+$ git clone https://github.com/Neteasecloudmusicapireborn/api.git
+$ cd api
+$ pnpm i
 ```
 
 ## 运行
@@ -372,13 +55,12 @@ $ set HOST=127.0.0.1 && node app.js
 ### npx 方式运行
 支持 npx 方式运行,会自动安装依赖和运行
 ```
-npx NeteaseCloudMusicApi
+npx @neteaseapireborn/api@版本号
 ```
-如果需要更新,可使用 `npx NeteaseCloudMusicApi@版本号` 方式运行
 
 或者运行
 ```
-npx NeteaseCloudMusicApi@latest
+npx @neteaseapireborn/api@latest
 
 ```
 此命令每次执行都会使用最新版
@@ -391,7 +73,7 @@ v4.0.8 加入了 Vercel 配置文件,可以直接在 Vercel 下部署了,不需
 
 ### 操作方法
 
-1. [fork](https://gitlab.com/Binaryify/neteasecloudmusicapi/-/forks/new) 此项目
+1. [fork](https://github.com/neteasecloudmusicapireborn/api/fork) 此项目
 2. 在 Vercel 官网点击 `New Project`
 3. 点击 `Import Git Repository` 并选择你 fork 的此项目并点击`import`
 4. 点击 `PERSONAL ACCOUNT` 的 `select`
@@ -402,7 +84,7 @@ v4.0.8 加入了 Vercel 配置文件,可以直接在 Vercel 下部署了,不需
 ## 腾讯云 serverless 部署
 因 `Vercel` 在国内访问太慢(不绑定自己的域名的情况下),在此提供腾讯云 serverless 部署方法
 ### 操作方法
-1. [fork](https://gitlab.com/Binaryify/neteasecloudmusicapi/-/forks/new)  此项目
+1. [fork](https://github.com/neteasecloudmusicapireborn/api/fork)  此项目
 2. 在腾讯云serverless应用管理页面( https://console.cloud.tencent.com/sls ),点击`新建应用`
 3. 顶部`创建方式`选择 `Web 应用`
 4. 选择 `Express框架`,点击底部`下一步按钮`
@@ -440,7 +122,7 @@ v3.3.0 后支持使用 PAC 代理,如 `?proxy=http://192.168.0.1/proxy.pac`
 v3.31.0 后支持 Node.js 调用,导入的方法为`module`内的文件名,返回内容包含`status`和`body`,`status`为状态码,`body`为请求返回内容,参考`module_example` 文件夹下的 `test.js`
 
 ```js
-const { login_cellphone, user_cloud } = require('NeteaseCloudMusicApi')
+const { login_cellphone, user_cloud } = require('@neteaseapireborn/api')
 async function main() {
   try {
     const result = await login_cellphone({
@@ -463,7 +145,7 @@ main()
 
 ```ts
 // test.ts
-import { banner } from 'NeteaseCloudMusicApi'
+import { banner } from '@neteaseapireborn/api'
 banner({ type: 0 }).then((res) => {
   console.log(res)
 })
@@ -503,7 +185,7 @@ docker run -d -p 3000:3000 -e http_proxy= -e https_proxy= -e no_proxy= -e HTTP_P
 > 以下是自行 build docker 镜像方式
 
 ```
-$ git clone https://gitlab.com/Binaryify/neteasecloudmusicapi.git && cd NeteaseCloudMusicApi
+$ git clone https://github.com/neteasecloudmusicapireborn/api.git && cd api
 
 $ sudo docker build . -t netease-music-api
 
@@ -870,7 +552,7 @@ signature：用户签名
 
 ### 更新头像
 
-说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片 formData(name 为'imgFile'),可更新头像(参考: https://gitlab.com/Binaryify/NeteaseCloudMusicApi/blob/main/public/avatar_update.html  ),支持命令行调用,参考module_example目录下`avatar_upload.js`
+说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片 formData(name 为'imgFile'),可更新头像(参考: https://github.com/neteasecloudmusicapireborn/api/blob/main/public/avatar_update.html  ),支持命令行调用,参考module_example目录下`avatar_upload.js`
 
 **可选参数 :**
 
@@ -987,7 +669,7 @@ tags: 歌单标签
 
 ### 歌单封面上传
 
-说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片 formData(name 为'imgFile'),可更新歌单封面(参考:https://gitlab.com/Binaryify/NeteaseCloudMusicApi/blob/main/public/playlist_cover_update.html)
+说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传图片 formData(name 为'imgFile'),可更新歌单封面(参考:https://github.com/neteasecloudmusicapireborn/api/blob/main/public/playlist_cover_update.html)
 
 **必选参数 :**  
 `id`: 歌单 id 3143833470
@@ -3079,7 +2761,7 @@ type : 地区
 
 说明 : 登录后调用此接口,使用`'Content-Type': 'multipart/form-data'`上传 mp3 formData(name 为'songFile'),可上传歌曲到云盘
 
-参考: https://gitlab.com/Binaryify/NeteaseCloudMusicApi/blob/main/public/cloud.html
+参考: https://github.com/neteasecloudmusicapireborn/api/blob/main/public/cloud.html
 
 访问地址: http://localhost:3000/cloud.html)
 
@@ -3744,7 +3426,7 @@ type='1009' 获取其 id, 如`/search?keywords= 代码时间 &type=1009`
 
 主机模式:
 
-代码可参考: https://gitlab.com/Binaryify/NeteaseCloudMusicApi/blob/main/public/listen_together_host.html
+代码可参考: https://github.com/neteasecloudmusicapireborn/api/blob/main/public/listen_together_host.html
 
 访问地址: http://localhost:3000/listen_together_host.html
 
@@ -5155,7 +4837,3 @@ let data = encodeURIComponent(
 ## 关于此文档
 
 此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成 docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。
-
-## License
-
-[The MIT License (MIT)](https://gitlab.com/Binaryify/NeteaseCloudMusicApi/blob/main/LICENSE)