JianYing Editor Skill
Use this skill when the user wants to automate video editing, generate drafts, or manipulate media assets in JianYing Pro.
Agent execution playbook: docs/agent-playbook.md
Minimal command SOP: docs/minimal-command-sop.md
Natural language usage guide: usage.md
Draft inspector CLI:
python <SKILL_ROOT>/scripts/draft_inspector.py list --limit 20
python <SKILL_ROOT>/scripts/draft_inspector.py summary --name "DraftName"
python <SKILL_ROOT>/scripts/draft_inspector.py show --name "DraftName" --kind content --json
For generic editing requests, always follow the "Quick Edit Runtime Template" and "Acceptance Checklist" in that playbook.
🚨 Critical Developer Rules
- Script Location: Do not create editing scripts inside the Skill's own directory. All clip logic implementation code (
.pyscripts) must be placed in the root directory of the user's current project (or a subdirectory likescripts/), to keep the Skill library pure and portable. - Version and Architecture:
- Dual Platform Support: Fully supports MacOS (path detection/screen recording) and Windows.
- Auto-healing: Supports v5.9+ (
draft_info.json). If a draft is corrupted or has version conflicts, initializeJyProjectwithoverwrite=Trueto trigger automatic repair.
- Music Selection:
- For simple demos, use default music. For real projects, prioritize searching and recommending relevant tracks from
data/cloud_music_library.csv, or filter by keyword based on the video theme (e.g., "technology", "warmth"). - Ask the user: "I found a few cloud-based tracks that match the theme. Would you like to try them? (e.g.,
Illuminate- tech vibe)".
- For simple demos, use default music. For real projects, prioritize searching and recommending relevant tracks from
📚 Rules
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
- Cloud video + cloud music:
rules/media.md+rules/audio-voice.md->examples/cloud_video_music_tts_demo.py - Smart TTS & subtitles (Script-to-Video):
rules/text.md+rules/audio-voice.md-> core APIadd_narrated_subtitles - Voiceover & subtitle alignment:
rules/text.md+rules/audio-voice.md->examples/cloud_video_music_tts_demo.py - Screen recording & smart zoom:
rules/recording.md->tools/recording/recorder.py - Batch/headless export:
rules/core.md+rules/cli.md->examples/robust_auto_export.py - Movie commentary generation:
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/Styles from JianYing App to the Skill:
python <SKILL_ROOT>/scripts/sync_jy_assets.py # Index cloud materials from your existing drafts python <SKILL_ROOT>/scripts/build_cloud_music_library.py python <SKILL_ROOT>/scripts/build_cloud_text_styles_library.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
- Read prompt:
- Screen Recorder & Smart Zoom: Record your screen and auto-apply zoom keyframes:
python <SKILL_ROOT>/tools/recording/recorder.py # Web preview capture (high performance) python <SKILL_ROOT>/scripts/web_recorder.py --url "http://localhost:3000" --duration 5 # Or apply zoom to existing video: python <SKILL_ROOT>/scripts/jy_wrapper.py apply-zoom --name "Project" --video "v.mp4" --json "e.json" - Draft Inspector: Examine draft structure and metadata (v5.9+ support):
python <SKILL_ROOT>/scripts/draft_inspector.py list --limit 20 python <SKILL_ROOT>/scripts/draft_inspector.py summary --name "DraftName" - Auto Exporter: Headless export of a draft to MP4/SRT:
Note: MP4 auto export uses Windows UI Automation. On macOS, generate the draft and export it manually from JianYing.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: Safely clone a template and batch replace materials (to prevent damaging the original template):
# Clone a template to create a new project python <SKILL_ROOT>/scripts/jy_wrapper.py clone --template "Hotel Template" --name "CustomerA_Copy" - API Validator: Run a quick diagnostic of your environment:
python <SKILL_ROOT>/scripts/api_validator.py
🚀 Quick Start Example
import os
import sys
# 1. Environment initialization (must be at the top of the script, supports Win/Mac)
current_dir = os.path.dirname(os.path.abspath(__file__))
env_root = os.getenv("JY_SKILL_ROOT", "").strip()
# Detect Skill path (supports Antigravity, Trae, Claude, etc.)
skill_root = next((p for p in [
env_root,
os.path.join(current_dir, ".agents", "skills", "jianying-editor"),
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(".agents/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.abspath("skills/jianying-editor"),
os.path.dirname(current_dir)
] 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__":
# 2. Initialize project (supports v5.9+ and auto-healing)
project = JyProject("New AI Video", overwrite=True)
assets_dir = os.path.join(skill_root, "assets")
# 3. Smart TTS & subtitles (One-click Script-to-Video)
project.add_narrated_subtitles(
text="Welcome to the JianYing automation Skill. This is an advanced version fully compatible with macOS.",
speaker="zh_female_xiaopengyou"
)
# 4. Import additional media
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")
# 5. Add animated title
project.add_text_simple("JianYing Automation Enabled", start_time="1s", duration="3s", anim_in="Vintage Typewriter")
project.save()
🛠️ Initialization & Project Rules
When initializing a JyProject, always set the resolution based on the aspect ratio of the main video asset. The default is landscape (1920x1080).
🚨 Script Location Rules
Do not create your business editing scripts inside the Skill installation directory.
- Correct approach: Place your editing Python scripts in the project's root directory.
- Reason: The Skill directory should only contain the toolset source code, so that future
git pullupgrades are easy. Mixing business code into it will cause version control chaos.