Documentation
¶
Overview ¶
Copyright © 2024 sunerpy <nkuzhangshn@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Directories
¶
| Path | Synopsis |
|---|---|
|
apitoken
Package apitoken 管理 API 令牌(路线图 M12):给 App、MCP、qB 兼容入口与 Servarr 兼容入口用,网页登录仍然只认 session。
|
Package apitoken 管理 API 令牌(路线图 M12):给 App、MCP、qB 兼容入口与 Servarr 兼容入口用,网页登录仍然只认 session。 |
|
assistant
Package assistant 是 pt-tools 内置的 AI 助手(路线图 M19):经 OpenAI 兼容的 Chat Completions 接口(官方 openai-go) 调大模型,工具是每次运行在进程内连上的 MCP 服务(internal/mcp 的同一套工具,经 App API v1 执行)。
|
Package assistant 是 pt-tools 内置的 AI 助手(路线图 M19):经 OpenAI 兼容的 Chat Completions 接口(官方 openai-go) 调大模型,工具是每次运行在进程内连上的 MCP 服务(internal/mcp 的同一套工具,经 App API v1 执行)。 |
|
backup
Package backup 做 pt-tools 数据的备份与恢复(媒体中心方案 M0)。
|
Package backup 做 pt-tools 数据的备份与恢复(媒体中心方案 M0)。 |
|
cloakdriver
Package cloakdriver provides Go bindings for CloakBrowser-Manager REST API and CDP automation.
|
Package cloakdriver provides Go bindings for CloakBrowser-Manager REST API and CDP automation. |
|
cloakdriver/gazelle
Package gazelle implements the Gazelle-schema CloakBrowser driver (T13).
|
Package gazelle implements the Gazelle-schema CloakBrowser driver (T13). |
|
cloakdriver/mtorrent
Package mtorrent implements the mTorrent (M-Team) CloakBrowser driver.
|
Package mtorrent implements the mTorrent (M-Team) CloakBrowser driver. |
|
cloakdriver/nexusphp
Package nexusphp implements the NexusPHP-schema CloakBrowser driver.
|
Package nexusphp implements the NexusPHP-schema CloakBrowser driver. |
|
cloakdriver/transport
Package transport 把 CloakBrowser 的各架构驱动接成登录探测的后备通道(sitelogin.Transport)。
|
Package transport 把 CloakBrowser 的各架构驱动接成登录探测的后备通道(sitelogin.Transport)。 |
|
cloakdriver/unit3d
Package unit3d implements the Unit3D-schema CloakBrowser driver.
|
Package unit3d implements the Unit3D-schema CloakBrowser driver. |
|
cookiecloud
Package cookiecloud 从自建的 CookieCloud 服务取回加密的 Cookie,在本地解密,按站点地址挑出 pt-tools 已配置站点的 Cookie。
|
Package cookiecloud 从自建的 CookieCloud 服务取回加密的 Cookie,在本地解密,按站点地址挑出 pt-tools 已配置站点的 Cookie。 |
|
dlassistant
Package dlassistant 是下载器助手:给缺站点标签的种子补标签、批量替换 tracker 地址、找出 tracker 报告 未注册或不存在的失效种子。
|
Package dlassistant 是下载器助手:给缺站点标签的种子补标签、批量替换 tracker 地址、找出 tracker 报告 未注册或不存在的失效种子。 |
|
extension
Package extension implements the pending-actions queue for browser extension polling.
|
Package extension implements the pending-actions queue for browser extension polling. |
|
filter
Package filter provides pattern matching and filtering functionality for RSS items.
|
Package filter provides pattern matching and filtering functionality for RSS items. |
|
freewatch
Package freewatch 是「等免费再下」(媒体中心 M2b):记下一个现在不免费的种子要推到哪里,后台定时读它现在的优惠, 免费了才推送(照常过免费门禁、磁盘与站点容量闸门,免费结束时暂停),等到期了还没免费就放弃。
|
Package freewatch 是「等免费再下」(媒体中心 M2b):记下一个现在不免费的种子要推到哪里,后台定时读它现在的优惠, 免费了才推送(照常过免费门禁、磁盘与站点容量闸门,免费结束时暂停),等到期了还没免费就放弃。 |
|
fsutil
Package fsutil 读本机磁盘的剩余空间(媒体中心 M8 的首页存储与系统体检)。
|
Package fsutil 读本机磁盘的剩余空间(媒体中心 M8 的首页存储与系统体检)。 |
|
health
Package health 是系统体检(媒体中心 M8):一次检查 TMDB、站点、下载器、媒体服务器、路径映射、媒体库、磁盘、NAS、时间、备份与密钥, 每项给出状态、说明与怎么修。
|
Package health 是系统体检(媒体中心 M8):一次检查 TMDB、站点、下载器、媒体服务器、路径映射、媒体库、磁盘、NAS、时间、备份与密钥, 每项给出状态、说明与怎么修。 |
|
home
Package home 是首页(媒体中心 M8):同时取各块的数据,一块出错不影响别的;另算待处理、存储与状态行。
|
Package home 是首页(媒体中心 M8):同时取各块的数据,一块出错不影响别的;另算待处理、存储与状态行。 |
|
iyuu
Package iyuu 是 IYUU 辅种接口的客户端。
|
Package iyuu 是 IYUU 辅种接口的客户端。 |
|
maintenance
MIT License Copyright (c) 2025 pt-tools
|
MIT License Copyright (c) 2025 pt-tools |
|
mcp
Package mcp 是 pt-tools 的 MCP(Model Context Protocol)服务(路线图 M14):工具定义、权限检查与写操作的审计。
|
Package mcp 是 pt-tools 的 MCP(Model Context Protocol)服务(路线图 M14):工具定义、权限检查与写操作的审计。 |
|
media/bangumi
Package bangumi 从 Bangumi(bgm.tv)取动画的中文简介、评分与每一集的中文标题(刮削时补充 TMDB 的数据),以及探索页的番剧日历。
|
Package bangumi 从 Bangumi(bgm.tv)取动画的中文简介、评分与每一集的中文标题(刮削时补充 TMDB 的数据),以及探索页的番剧日历。 |
|
media/cachectl
Package cachectl 是媒体数据来源(TMDB、豆瓣、Bangumi、Fanart.tv、OMDb)的响应缓存共用的开关: 显式重新刮削时不读缓存,直接问来源要现在的数据(取到的照样写进缓存,替换旧的)。
|
Package cachectl 是媒体数据来源(TMDB、豆瓣、Bangumi、Fanart.tv、OMDb)的响应缓存共用的开关: 显式重新刮削时不读缓存,直接问来源要现在的数据(取到的照样写进缓存,替换旧的)。 |
|
media/csf
Package csf 是 ChineseSubFinder(自动下载中文字幕的工具)的外部接口客户端:整理出新视频以后交给它下载字幕。
|
Package csf 是 ChineseSubFinder(自动下载中文字幕的工具)的外部接口客户端:整理出新视频以后交给它下载字幕。 |
|
media/douban
Package douban 从豆瓣取电影与剧集(一季)的简介和评分,刮削时补充 TMDB 的数据。
|
Package douban 从豆瓣取电影与剧集(一季)的简介和评分,刮削时补充 TMDB 的数据。 |
|
media/epgroup
Package epgroup 按 TMDB 的剧集组换算季与集。
|
Package epgroup 按 TMDB 的剧集组换算季与集。 |
|
media/fanart
Package fanart 从 Fanart.tv 取电影与剧集的图片:高清 Logo、clearart、横幅、横版海报、碟片、海报、背景与季海报。
|
Package fanart 从 Fanart.tv 取电影与剧集的图片:高清 Logo、clearart、横幅、横版海报、碟片、海报、背景与季海报。 |
|
media/meta
Package meta 解析 PT 种子的标题与副标题:中英文名、年份、类型、季与集(含范围、「全 N 集」「第 1-10 集」)、 分辨率、来源、编码、HDR、音轨、制作组、版本,以及中字、国语、粤语等标记。
|
Package meta 解析 PT 种子的标题与副标题:中英文名、年份、类型、季与集(含范围、「全 N 集」「第 1-10 集」)、 分辨率、来源、编码、HDR、音轨、制作组、版本,以及中字、国语、粤语等标记。 |
|
media/metadata
Package metadata 是刮削用的元数据:与来源无关的电影、剧集、季、集与图片,各个来源(TMDB、豆瓣、Bangumi、 Fanart.tv、OMDb)的适配,以及按媒体库的设置把几个来源的数据合在一起(每一项记下来自哪个来源)。
|
Package metadata 是刮削用的元数据:与来源无关的电影、剧集、季、集与图片,各个来源(TMDB、豆瓣、Bangumi、 Fanart.tv、OMDb)的适配,以及按媒体库的设置把几个来源的数据合在一起(每一项记下来自哪个来源)。 |
|
media/omdb
Package omdb 从 OMDb(omdbapi.com)按 IMDb 编号取评分与分级:IMDb 评分与人数、烂番茄、Metacritic。
|
Package omdb 从 OMDb(omdbapi.com)按 IMDb 编号取评分与分级:IMDb 评分与人数、烂番茄、Metacritic。 |
|
media/organize
Package organize 是整理入库服务:种子下载完成后识别出电影或剧集,按媒体库的模板与整理方式放进库里, 写 NFO 与图片,通知媒体服务器扫描,发入库通知。
|
Package organize 是整理入库服务:种子下载完成后识别出电影或剧集,按媒体库的模板与整理方式放进库里, 写 NFO 与图片,通知媒体服务器扫描,发入库通知。 |
|
media/recognize
Package recognize 是媒体识别服务:套用识别词、解析标题,再到 TMDB 找对应的条目 (有 IMDb 编号时直接查找,否则按中英文名和年份搜索打分),支持按 TMDB 编号手动纠正。
|
Package recognize 是媒体识别服务:套用识别词、解析标题,再到 TMDB 找对应的条目 (有 IMDb 编号时直接查找,否则按中英文名和年份搜索打分),支持按 TMDB 编号手动纠正。 |
|
media/scrape
Package scrape 为整理进媒体库的电影与剧集写 Kodi 格式的 NFO(Emby、Jellyfin、Plex 的 NFO 插件都认), 并下载海报、背景、Logo 等图片。
|
Package scrape 为整理进媒体库的电影与剧集写 Kodi 格式的 NFO(Emby、Jellyfin、Plex 的 NFO 插件都认), 并下载海报、背景、Logo 等图片。 |
|
media/server
Package server 是媒体服务器的客户端:Emby、Jellyfin 与 Plex。
|
Package server 是媒体服务器的客户端:Emby、Jellyfin 与 Plex。 |
|
media/serverindex
Package serverindex 是媒体服务器索引:把服务器里的电影、剧与集全量同步进 media_server_items(拉全以后在一个事务里写, 没拉到的打删除标记、90 天后删行),同步时对 pt-tools 整理过、服务器里没有了的写待处理问题(media_issues 的 server_removed),并提供查询:条目在哪台服务器里、一季的哪些集在服务器里、算作已入库的集、问题列表。
|
Package serverindex 是媒体服务器索引:把服务器里的电影、剧与集全量同步进 media_server_items(拉全以后在一个事务里写, 没拉到的打删除标记、90 天后删行),同步时对 pt-tools 整理过、服务器里没有了的写待处理问题(media_issues 的 server_removed),并提供查询:条目在哪台服务器里、一季的哪些集在服务器里、算作已入库的集、问题列表。 |
|
media/subscribe
Package subscribe 是订阅:按电影或剧集的一季找资源(RSS 拉到的种子与定时主动搜索),按质量档案挑、推送到下载器, 剧集按 TMDB 的分集找缺的集;洗版时接着找更好的版本,入库后替换旧文件;豆瓣想看定时建订阅。
|
Package subscribe 是订阅:按电影或剧集的一季找资源(RSS 拉到的种子与定时主动搜索),按质量档案挑、推送到下载器, 剧集按 TMDB 的分集找缺的集;洗版时接着找更好的版本,入库后替换旧文件;豆瓣想看定时建订阅。 |
|
media/tmdb
Package tmdb 是 TMDB v3 接口的客户端:搜索电影与剧集、按 IMDb 编号查找、取详情。
|
Package tmdb 是 TMDB v3 接口的客户端:搜索电影与剧集、按 IMDb 编号查找、取详情。 |
|
media/transfer
Package transfer 是整理入库的文件操作:从种子的文件里挑出要整理的视频与字幕、按模板算出库里的路径, 再用硬链接、复制、软链接或移动放进媒体库。
|
Package transfer 是整理入库的文件操作:从种子的文件里挑出要整理的视频与字幕、按模板算出库里的路径, 再用硬链接、复制、软链接或移动放进媒体库。 |
|
media/words
Package words 套用识别词:解析标题之前屏蔽或替换文字,解析之后按规则偏移集数。
|
Package words 套用识别词:解析标题之前屏蔽或替换文字,解析之后按规则偏移集数。 |
|
nas
Package nas 是首页「NAS 概览」与设置页「NAS 监控」的数据层(首页 NAS 概览 H2):来源类型的注册表、地址与传输规则、 证书钉住、本机来源与采集器。
|
Package nas 是首页「NAS 概览」与设置页「NAS 监控」的数据层(首页 NAS 概览 H2):来源类型的注册表、地址与传输规则、 证书钉住、本机来源与采集器。 |
|
notify/adapter/bark
Package bark 是 Bark(iOS 推送)出站通道:POST {server}/push,JSON 里带 device_key;返回 code 为 200 才算成功。
|
Package bark 是 Bark(iOS 推送)出站通道:POST {server}/push,JSON 里带 device_key;返回 code 为 200 才算成功。 |
|
notify/adapter/dingtalk
Package dingtalk 是钉钉群自定义机器人出站通道。
|
Package dingtalk 是钉钉群自定义机器人出站通道。 |
|
notify/adapter/feishu
Package feishu 是飞书(Lark)群自定义机器人出站通道。
|
Package feishu 是飞书(Lark)群自定义机器人出站通道。 |
|
notify/adapter/ntfy
Package ntfy 是 ntfy 出站通道:按 JSON 发布,POST 到服务器根地址 {topic, title, message, priority, click}; 可选 access token(Bearer)或用户名密码(Basic)。
|
Package ntfy 是 ntfy 出站通道:按 JSON 发布,POST 到服务器根地址 {topic, title, message, priority, click}; 可选 access token(Bearer)或用户名密码(Basic)。 |
|
notify/adapter/outbound
Package outbound 是只出站的通知适配器(Bark、Server 酱、ntfy、钉钉、飞书、企业微信群机器人)共用的发送工具。
|
Package outbound 是只出站的通知适配器(Bark、Server 酱、ntfy、钉钉、飞书、企业微信群机器人)共用的发送工具。 |
|
notify/adapter/serverchan
Package serverchan 是 Server 酱出站通道。
|
Package serverchan 是 Server 酱出站通道。 |
|
notify/adapter/telegram
Package telegram implements the notify.Channel adapter for Telegram bots using mymmrac/telego with long-polling.
|
Package telegram implements the notify.Channel adapter for Telegram bots using mymmrac/telego with long-polling. |
|
notify/tmpl
Package tmpl 是通知的模板引擎:Go 的 text/template,加上一组受控的函数与防护。
|
Package tmpl 是通知的模板引擎:Go 的 text/template,加上一组受控的函数与防护。 |
|
redact
Package redact 遮住要交给外部的文本里可能带的凭证:App API 的错误信息、AI 助手存下来与发给各入口的会话内容。
|
Package redact 遮住要交给外部的文本里可能带的凭证:App API 的错误信息、AI 助手存下来与发给各入口的会话内容。 |
|
remote
Package remote 是远程访问(路线图 M15)的协议与主机端:手机 App 扫码配对以后,经直连 WebSocket 或 relay 调用这台 pt-tools 的 App API v1。
|
Package remote 是远程访问(路线图 M15)的协议与主机端:手机 App 扫码配对以后,经直连 WebSocket 或 relay 调用这台 pt-tools 的 App API v1。 |
|
remote/relayserver
Package relayserver 是 relay 的 Go 自建版(路线图 M16):只做转发,看不到明文。
|
Package relayserver 是 relay 的 Go 自建版(路线图 M16):只做转发,看不到明文。 |
|
remote/relaytest
Package relaytest 是 relay 的一致性测试(黑盒):Go 自建版与 Cloudflare 版跑同一套用例, 对着一个已经起好的 relay(ws:// 或 wss:// 地址)连主机与客户端,只看线上的行为。
|
Package relaytest 是 relay 的一致性测试(黑盒):Go 自建版与 Cloudflare 版跑同一套用例, 对着一个已经起好的 relay(ws:// 或 wss:// 地址)连主机与客户端,只看线上的行为。 |
|
remote/testhost
command
Command testhost 是手机 App(apps/mobile)互通测试用的主机:真正的 internal/remote 主机端(直连入口与 relay 客户端), App API 换成固定的回应,加一台进程内的 Go relay(relayserver)。
|
Command testhost 是手机 App(apps/mobile)互通测试用的主机:真正的 internal/remote 主机端(直连入口与 relay 客户端), App API 换成固定的回应,加一台进程内的 Go relay(relayserver)。 |
|
reseed
Package reseed 实现 IYUU 辅种:把下载器里已经下完的种子的 info hash 交给 IYUU 查询,找出其他站点上数据相同的种子, 从站点下载种子文件、核对 info hash 与文件列表后,暂停加入同一台下载器(保存路径用原种子的),校验到 100% 才开始做种。
|
Package reseed 实现 IYUU 辅种:把下载器里已经下完的种子的 info hash 交给 IYUU 查询,找出其他站点上数据相同的种子, 从站点下载种子文件、核对 info hash 与文件列表后,暂停加入同一台下载器(保存路径用原种子的),校验到 100% 才开始做种。 |
|
schedule
Package schedule 算定时的下次时间:每天、每隔几天、每周、每月、cron 表达式与一次(追剧的主动搜索与定时 AI 任务共用)。
|
Package schedule 算定时的下次时间:每天、每隔几天、每周、每月、cron 表达式与一次(追剧的主动搜索与定时 AI 任务共用)。 |
|
transfer
Package transfer 实现转移做种:把下载器里已经下完的种子搬到另一个下载器继续做种,数据不动。
|
Package transfer 实现转移做种:把下载器里已经下完的种子搬到另一个下载器继续做种,数据不动。 |
|
site
|
|
|
v2
Package v2 provides caching utilities for performance optimization
|
Package v2 provides caching utilities for performance optimization |
|
thirdpart
|
|
|
httpclient
Package httpclient 提供基于 github.com/sunerpy/requests 的 HTTP 客户端连接池管理
|
Package httpclient 提供基于 github.com/sunerpy/requests 的 HTTP 客户端连接池管理 |
|
Package web provides HTTP server and API handlers
|
Package web provides HTTP server and API handlers |
|
middleware
Package middleware 放请求主体(路线图 M12):谁发起的请求、有哪些权限范围。
|
Package middleware 放请求主体(路线图 M12):谁发起的请求、有哪些权限范围。 |
|
qbitcompat
Package qbitcompat 是 qB 兼容入口(路线图 M13):在单独的端口上实现 qBittorrent WebUI API v2 的一个子集, 让 MoviePilot、IYUU、autobrr、Sonarr/Radarr 这类只认 qB 的工具把 pt-tools 当成下载器。
|
Package qbitcompat 是 qB 兼容入口(路线图 M13):在单独的端口上实现 qBittorrent WebUI API v2 的一个子集, 让 MoviePilot、IYUU、autobrr、Sonarr/Radarr 这类只认 qB 的工具把 pt-tools 当成下载器。 |
|
servarr
Package servarr 是 Servarr 兼容入口(媒体中心 M10):在主端口的 /servarr/radarr/api/v3/* 与 /servarr/sonarr/api/v3/* 上实现 Radarr v3 与 Sonarr v3 API 的一个子集,让 Seerr 把 pt-tools 当成 Radarr、Sonarr 用:Seerr 里的请求变成 pt-tools 的 电影订阅与追剧,订阅的状态与库里的情况回给 Seerr。
|
Package servarr 是 Servarr 兼容入口(媒体中心 M10):在主端口的 /servarr/radarr/api/v3/* 与 /servarr/sonarr/api/v3/* 上实现 Radarr v3 与 Sonarr v3 API 的一个子集,让 Seerr 把 pt-tools 当成 Radarr、Sonarr 用:Seerr 里的请求变成 pt-tools 的 电影订阅与追剧,订阅的状态与库里的情况回给 Seerr。 |