关于 synology-file-station
Synology File Station 是通过 Python 命令行脚本执行 Synology 文件管理操作的技能。它从环境变量读取凭据,并输出结构化 JSON,便于接入自动化流水线。
主要功能
- 01浏览共享目录和文件
- 02搜索文件与目录
- 03创建、重命名、移动、复制或删除项目
- 04上传和下载文件
- 05解压归档并控制后台任务
- 06返回结构化 JSON 结果
适用场景
- 01自动执行 Synology 文件操作
- 02在 NAS 上搜索文件
- 03在流水线中传输文件
- 04限制变更命令可操作的路径
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ tiangong-ai/ agent-skills --skill synology-file-station安装后在 Claude Code 中输入/synology-file-station确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlassets/config.example.envreferences/commands.mdenv.mdscripts/synology_file_station.py详细介绍
Synology File Station
核心目标
- 通过一个 CLI 脚本执行 Synology File Station 的主要文件操作。
- 从环境变量读取连接凭据,而不是将密钥硬编码。
- 返回适用于自动化流水线的 JSON 输出。
工作流
- 准备环境变量(参见
references/env.md和assets/config.example.env)。 - 验证配置:
python3 scripts/synology_file_station.py check-config
- 可选:探测连接:
python3 scripts/synology_file_station.py check-config --probe
- 运行所需的文件操作命令(参见
references/commands.md)。
主要操作
- 读取/浏览:
info、list-shares、list、get-info - 搜索:
search-start、search-list、search-stop、search-clean - 目录/文件修改:
mkdir、rename、copy、move、delete - 传输:
upload、download - 归档工作流:
extract(compress暂时不可用) - 后台任务控制:
background-list、task-status、task-stop
环境约定
必需的环境变量:
SYNOLOGY_BASE_URLSYNOLOGY_USERNAMESYNOLOGY_PASSWORD
可选的环境变量:
SYNOLOGY_VERIFY_SSLSYNOLOGY_TIMEOUTSYNOLOGY_SESSIONSYNOLOGY_READONLY(默认为false;设为true可阻止修改命令)SYNOLOGY_MUTATION_ALLOW_PATHS(可选的修改路径允许列表)
输出约定
- 成功:包含
type=status和操作专属字段的 JSON 对象。 - 失败:包含
type=error和结构化错误元数据的 JSON 对象。 - 退出代码:
0:成功1:运行时/API 错误2:环境变量配置无效
参考文档
references/env.mdreferences/commands.md
资源
assets/config.example.env
脚本
scripts/synology_file_station.py
评论
支持 Markdown