مرجع سطر الأوامر (CLI)
كل أوامر reelforge وخياراته، مولّدة من تعريف الأوامر في packages/cli/src/index.ts. على Windows شغّل reelforge.cmd، وعلى macOS وLinux شغّل ./reelforge، أو pnpm reelforge من نسخة المصدر. رموز الخروج: 0 نجاح، و1 فشل (أو أخطاء تحقق)، و2 خطأ في طريقة الاستخدام. يشرح دليل سطر الأوامر متغيرات البيئة وطرق العمل الشائعة.
ملاحظة: هذه الصفحة مولّدة من الكود. العناوين والشرح بالعربية، أما الأوصاف داخل الجداول فتُقرأ من الكود وتبقى بالإنجليزية.
الخيارات العامة
تُكتب هذه الخيارات قبل أي أمر أو بعده.
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
-V, --version | output the version number | ||
--verbose | more output (info messages, logs) | ||
--json | machine-readable JSON output | ||
--root <dir> | project root (default: $REELFORGE_ROOT or the current directory) |
الأوامر
| الأمر | الوصف |
|---|---|
reelforge studio | open the project dashboard: create episodes, upload voice, open the editor, validate and render |
reelforge new | create episodes/<id>/episode.yaml from a commented template |
reelforge packs | list industry packs and their templates with slots |
reelforge cue | open the editor in Cues mode: mark when each line starts (writes cues.json) |
reelforge align | mark cues automatically from the voice recording (lines and words; writes cues.json) |
reelforge edit | open the visual editor: canvas, layers, inspector and timeline (writes episode.yaml) |
reelforge dev | open the editor in Review mode: checks, safe zones, element outlines |
reelforge validate | check schema, cues, timing, layout, safe zones and text overflow |
reelforge render | render master + share MP4, SRT, contact sheet and publish.md |
reelforge snap | write PNG frames at times (seconds or time expressions) and a contact sheet |
reelforge doctor | check Node, ffmpeg, Chromium and fonts; print install steps |
reelforge theme new | generate a complete themes/<name>.theme.yaml (WCAG AA contrast) from one accent color |
reelforge mcp | run the Model Context Protocol server on stdio (for AI assistants and agents) |
reelforge schema | write the episode JSON Schema (editor autocompletion) |
reelforge studio
open the project dashboard: create episodes, upload voice, open the editor, validate and render
text
reelforge studio [options]| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--port <port> | port (default 4310 or $REELFORGE_PORT) | ||
--host <address> | bind address (default 127.0.0.1 or $REELFORGE_HOST); other addresses require the bearer token | ||
--no-open | do not open the browser |
reelforge new
create episodes/<id>/episode.yaml from a commented template
text
reelforge new [options] <id>| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id (slug) | نعم |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--series <name> | series name shown in the header | ||
--episode <n> | episode number | ||
--lang <en|ar> | language of the template script (default en) | ||
--pack <id> | start from an industry pack template (see reelforge packs) | ||
--template <id> | template of the pack (default: the pack's first template) | ||
--slot <key=value> | template slot value (repeatable); missing slots keep their defaults |
reelforge packs
list industry packs and their templates with slots
text
reelforge packs [options]| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--lang <en|ar> | language of names and slot defaults (default en) |
reelforge cue
open the editor in Cues mode: mark when each line starts (writes cues.json)
text
reelforge cue [options] <id>| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id or path | نعم |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--draft | write estimated cues instead (preview before recording) | ||
--port <port> | port (default 4317 or $REELFORGE_PORT) | ||
--preset <name> | override meta.preset | ||
--no-open | do not open the browser |
reelforge align
mark cues automatically from the voice recording (lines and words; writes cues.json)
text
reelforge align [options] [id]| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id or path |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--engine <name> | auto: whisper when installed, else dsp (إحدى القيم auto, dsp, whisper) | ||
--model <size> | whisper model size (default base) (إحدى القيم tiny, base, small) | ||
--no-vad | detect speech by energy only (skip Silero VAD) | ||
--no-words | only line cues | ||
--force | replace cues you marked by hand | ||
--dry-run | print the result without writing cues.json | ||
--setup | install the optional speech models (one time, ~180 MB in the user cache) | ||
--status | show which speech models are installed |
reelforge edit
open the visual editor: canvas, layers, inspector and timeline (writes episode.yaml)
text
reelforge edit [options] <id>| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id or path | نعم |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--port <port> | port (default 4317 or $REELFORGE_PORT) | ||
--preset <name> | override meta.preset | ||
--no-open | do not open the browser |
reelforge dev
open the editor in Review mode: checks, safe zones, element outlines
text
reelforge dev [options] <id>| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id or path | نعم |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--port <port> | port (default 4317 or $REELFORGE_PORT) | ||
--preset <name> | override meta.preset | ||
--no-open | do not open the browser |
reelforge validate
check schema, cues, timing, layout, safe zones and text overflow
text
reelforge validate [options] <id>| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id or path | نعم |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--strict | fail on warnings too | ||
--preset <name> | override meta.preset | ||
--no-measure | skip the headless V-9/V-10 checks |
reelforge render
render master + share MP4, SRT, contact sheet and publish.md
text
reelforge render [options] [id]| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id or path (or a folder of episodes with --all) |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--all | render every episode in episodes/ (or in the given folder) | ||
--preset <name> | tiktok | reels | shorts (default: meta.preset, $REELFORGE_PRESET) | ||
--workers <n> | parallel Chromium workers (default: CPU cores − 1, $REELFORGE_WORKERS) | ||
--from <t> | partial render start (seconds) → <id>.part.mp4 | ||
--to <t> | partial render end (seconds) | ||
--share-size <MB> | share file size cap (default 28, $REELFORGE_SHARE_SIZE) | ||
--no-sfx | render without sound effects | ||
--no-share | skip the share file | ||
--lossless | capture PNG frames instead of JPEG | ||
--fast | faster master/share encoding (preset medium) | ||
--silent | allow rendering without a voice recording | ||
--keep-tmp | keep out/.tmp/<run-id>/ on failure | ||
--no-measure | skip the headless V-9/V-10 checks | ||
--denoise | remove background noise from the voice (default: audio.denoise) | ||
--no-denoise | keep the voice as recorded, even when audio.denoise is true |
reelforge snap
write PNG frames at times (seconds or time expressions) and a contact sheet
text
reelforge snap [options] <id> [times...]| الوسيط | الوصف | إلزامي |
|---|---|---|
id | episode id or path | نعم |
times... | times: 12.5, 12.5s, l7, "l7:'word'", l7.end+0.2 |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--every <seconds> | one frame every N seconds | ||
--out <dir> | output folder (default out/snaps) | ||
--preset <name> | override meta.preset | ||
--cover | write a single 1080×1920 cover image to out/<id>.cover.png |
reelforge doctor
check Node, ffmpeg, Chromium and fonts; print install steps
text
reelforge doctor [options]| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--fix | install the pinned Chromium if missing |
reelforge theme new
generate a complete themes/<name>.theme.yaml (WCAG AA contrast) from one accent color
text
reelforge theme new [options] <name>| الوسيط | الوصف | إلزامي |
|---|---|---|
name | theme name (slug) | نعم |
| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--accent <hex> | accent color, e.g. #b8ff3c (adjusted only if it would be hard to read) | نعم | |
--mode <mode> | light or dark background (default dark) | ||
--font <family> | bundled font for its slot (display, mono or arabic): Space Grotesk, JetBrains Mono, Cairo, Inter, Manrope, Playfair Display, Noto Kufi Arabic, Noto Naskh Arabic, Readex Pro | ||
--out <file> | output file |
reelforge mcp
run the Model Context Protocol server on stdio (for AI assistants and agents)
text
reelforge mcp [options]| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--toolsets <list> | only these toolsets: basic, design, render or all (default all) |
reelforge schema
write the episode JSON Schema (editor autocompletion)
text
reelforge schema [options]| الخيار | الوصف | الافتراضي | إلزامي |
|---|---|---|---|
--out <file> | output file (default schema/episode.schema.json) |