synology-file-station について
Synology File Stationは、PythonのコマンドラインスクリプトでSynology上のファイル操作を行うスキルです。環境変数から認証情報を読み込み、自動化パイプライン向けに構造化JSONを返します。
主な機能
- 01共有フォルダーとファイルの参照
- 02ファイルやディレクトリの検索
- 03作成、名前変更、移動、コピー、削除
- 04ファイルのアップロードとダウンロード
- 05アーカイブの展開とバックグラウンドタスク制御
- 06構造化JSON結果の出力
活用シーン
- 01Synologyのファイル操作の自動化
- 02NAS上のファイル検索
- 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
主な目的
- 1 つの 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 対応