SKILL.md
$27
Read the individual rule files for specific tasks and constraints:
- rules/setup.md - Mandatory initialization code for all scripts.
- rules/core.md - Core operations: Saving, Exporting, and Draft management.
- rules/cli.md - CLI contracts and machine-readable output conventions.
- rules/media.md - Importing assets & AI Video Analysis Optimization (30m/360p).
- rules/text.md - Adding Subtitles, Text, and Captions.
- rules/keyframes.md - Advanced: Adding Keyframe animations.
- rules/effects.md - Searching for and applying Filters, Effects, and Transitions.
- rules/recording.md - New: Screen Recording & Smart Zoom automation.
- rules/web-vfx.md - Advanced: Web-to-Video generation.
- rules/generative.md - Chain of Thought for generative editing.
- rules/audio-voice.md - New: TTS Voiceover & BGM sourcing.
🎯 Agent Quick Routing
- 云端视频 + 云端音乐:
rules/media.md+rules/audio-voice.md->examples/cloud_video_music_tts_demo.py
- 旁白与字幕对齐:
rules/text.md+rules/audio-voice.md->examples/cloud_video_music_tts_demo.py
- 录屏与智能变焦:
rules/recording.md->tools/recording/recorder.py
- 批量导出/无头导出:
rules/core.md+rules/cli.md->examples/robust_auto_export.py
- 影视解说生成:
rules/generative.md->scripts/movie_commentary_builder.py
📖 经典示例 (Examples)
Refer to these for complete workflows:
- examples/my_first_vlog.py - A complete vlog creation demo with background music and animated text.
- examples/simple_clip_demo.py - Quick-start tutorial for basic cutting and track management.
- examples/compound_clip_demo.py - New: Professional nested project (Compound Clip) automation.
- examples/cloud_video_music_tts_demo.py - Cloud video + cloud BGM + TTS/subtitle alignment.
- examples/web_to_video_intro_demo.py - Web-to-Video intro demo (HTML animation -> timeline clip).
- examples/robust_auto_export.py - Stable export workflow and failure handling.
- examples/auto_exposure_align_demo.py - CV-assisted exposure alignment workflow.
- examples/video_transcribe_and_match.py - Advanced: AI-driven workflow (Transcribe Video -> Match B-Roll via AI semantics -> Assemble Draft).
🧠 提示词与集成工具 (Prompts & Integrated Tools)
Use these templates and scripts for complex tasks:
- Asset Search: Find filters, transitions, and animations by Chinese/English name:
python <SKILL_ROOT>/scripts/asset_search.py "复古" -c filters
- Movie Commentary Builder: Generate 60s commentary videos from a storyboard JSON:
python <SKILL_ROOT>/scripts/movie_commentary_builder.py --video "video.mp4" --json "storyboard.json"
- Sync Native Assets: Import your favorited/played BGM from JianYing App to the Skill:
python <SKILL_ROOT>/scripts/sync_jy_assets.py
- README to Tutorial: Convert a project's README.md into a full installation tutorial video script:
- Read prompt:
prompts/readme_to_tutorial.md
- Inject content into
{{README_CONTENT}}variable
- Screen Recorder & Smart Zoom: Record your screen and auto-apply zoom keyframes:
python <SKILL_ROOT>/tools/recording/recorder.py
# Or apply zoom to existing video:
python <SKILL_ROOT>/scripts/jy_wrapper.py apply-zoom --name "Project" --video "v.mp4" --json "e.json"
- Auto Exporter: Headless export of a draft to MP4/SRT:
python <SKILL_ROOT>/scripts/auto_exporter.py "DraftName" "output.mp4" --res 1080 --fps 60
# For SRT only:
python <SKILL_ROOT>/scripts/jy_wrapper.py export-srt --name "DraftName"
- Template Clone & Replacer: 安全克隆模板并批量替换物料 (防止损坏原模板):
# 克隆模板生成新项目
python <SKILL_ROOT>/scripts/jy_wrapper.py clone --template "酒店模板" --name "客户A_副本"
- API Validator: Run a quick diagnostic of your environment:
python <SKILL_ROOT>/scripts/api_validator.py
🚀 快速开始示例
import os
import sys
# 1. 环境初始化 (必须同步到脚本开头)
current_dir = os.path.dirname(os.path.abspath(__file__))
env_root = os.getenv("JY_SKILL_ROOT", "").strip()
# 探测 Skill 路径 (支持 Antigravity, Trae, Claude 等)
skill_root = next((p for p in [
env_root,
os.path.join(current_dir, ".agent", "skills", "jianying-editor"),
os.path.join(current_dir, ".trae", "skills", "jianying-editor"),
os.path.join(current_dir, ".claude", "skills", "jianying-editor"),
os.path.join(current_dir, "skills", "jianying-editor"),
os.path.abspath(".agent/skills/jianying-editor"),
os.path.abspath(".trae/skills/jianying-editor"),
os.path.abspath(".claude/skills/jianying-editor"),
os.path.dirname(current_dir) # 如果在 examples/ 目录下
] if p and os.path.exists(os.path.join(p, "scripts", "jy_wrapper.py"))), None)
if not skill_root: raise ImportError("Could not find jianying-editor skill root.")
sys.path.insert(0, os.path.join(skill_root, "scripts"))
from jy_wrapper import JyProject
if __name__ == "__main__":
project = JyProject("My Video Project")
assets_dir = os.path.join(skill_root, "assets")
# 2. 导入视频与配乐
project.add_media_safe(os.path.join(assets_dir, "video.mp4"), "0s")
project.add_media_safe(os.path.join(assets_dir, "audio.mp3"), "0s", track_name="Audio")
# 3. 添加带动画的标题
project.add_text_simple("剪映自动化开启", start_time="1s", duration="3s", anim_in="复古打字机")
project.save()
🛠️ 初始化与项目规范 (Initialization & Project Rules)
在初始化 JyProject 时,请务必根据主视频素材的比例设置分辨率。默认值为横屏 (1920x1080)。
🚨 脚本存放位置规范
禁止在 Skill 安装目录下创建你的业务剪辑脚本。
- 正确做法:将你的剪辑 Python 脚本放在项目的根目录。
- 原因:Skill 目录应该只包含工具集源码,便于后续
git pull升级。业务代码混入会导致版本管理混乱。