vid-scaffold
v1.0.0
Published
Scaffold video editing project directory structures interactively
Maintainers
Readme
🎬 vid-scaffold
Scaffold video editing project directory structures — interactively, cross-platform.
Works on Windows, macOS, and Linux.
Usage
No install needed — just run:
npx vid-scaffoldOr install globally:
npm install -g vid-scaffold
vid-scaffoldWhat it does
Launches an interactive CLI that asks you:
- Software — which NLE you use (sets the project file extension)
- Project name — the root folder to create
- Template — full, minimal, your saved preset, or customize
- Customize mode — pick folders, add your own, drill into nested ones
- Save as preset — optionally save your layout for next time
Supported software
| Software | Project file |
| --------------------- | ------------------------ |
| Kdenlive | project.kdenlive |
| DaVinci Resolve | project.drp |
| Adobe Premiere Pro | project.prproj |
| Final Cut Pro | project.fcpbundle |
| Shotcut | project.mlt |
| Vegas Pro | project.veg |
| Avid Media Composer | project.avb |
| CapCut / Other / none | (no file created) |
| Custom | enter your own extension |
Default "full" structure
my-video-project/
├── 01_project/
│ └── project.kdenlive ← depends on your software choice
├── 02_a-roll/
├── 03_b-roll/
├── 04_music/
├── 05_sfx/
├── 06_subtitles/
└── 07_exports/
├── drafts/
├── final/
└── shorts/Presets
Saved presets are stored at:
| Platform | Path |
| ------------- | ------------------------------------------ |
| macOS / Linux | ~/.vid-scaffold/presets.json |
| Windows | %USERPROFILE%\.vid-scaffold\presets.json |
Contributing / Development
git clone https://github.com/your-username/vid-scaffold
cd vid-scaffold
npm install
# Compile TypeScript
npm run build
# Run locally
npm start
# Watch mode during development
npm run devProject structure
vid-scaffold/
├── src-ts/ # TypeScript source
│ ├── types.ts # Shared interfaces (DirEntry, SoftwareChoice, …)
│ ├── structure.ts # Default & minimal templates
│ ├── software.ts # NLE software selection prompt
│ ├── customize.ts # Interactive folder picker (recursive)
│ ├── creator.ts # Disk writer + tree printer
│ ├── presets.ts # Save/load ~/.vid-scaffold/presets.json
│ └── index.ts # Main orchestrator
├── bin-ts/
│ └── cli.ts # #!/usr/bin/env node entry point
├── dist/ # Compiled output (generated — do not edit)
├── tsconfig.json
└── package.jsonPublishing
npm run build # compiles src-ts/ → dist/
npm publish # ships only the dist/ folder (see .npmignore)Requirements
- Node.js 18+
License
MIT
