Reference
CLI
Run with npx openfilm, or install it with npm i -g openfilm. With no arguments it prints the agent manual. openfilm <command> --help shows one command's options.
look, render and get work on the project around the current folder; open makes one. Exit status: 0 done, 1 the film or the command failed (the output says why), 2 not a project or a wrong command.
openfilm open
openfilm open [folder | url]
Starts or opens a project. A folder that is not one yet gets an empty film.html; nothing else is created. A GitHub or GitLab address (a repository, or a folder in one) is copied into your projects without its git history, then opened. Without an argument: the project around the current folder, else the last one opened, else Studio's projects.
Starts Studio if it is not running and prints its address. A Studio page already open switches to the project; otherwise Studio opens in your browser. The first time, OpenFilm downloads the browser it draws films with (about 100 MB).
openfilm look
openfilm look [what] [t | a-b]
Checks the film and draws it. Without a time: a contact sheet of the whole film, its sound and loudness, and a check that the same t draws the same picture. With t: one frame at full size. With a-b: a dense sheet of that stretch. what can also be a film page or a media file. The PNGs are written under .film/cache/look/.
openfilm render
openfilm render [a-b]
Renders the project to an MP4 beside film.html, or a range to .film/cache/render/.
| Option | |
|---|---|
--out <file> | another path; .webm or .mov with --alpha |
--fps <n> | frame rate (30) |
--4k | 3840 px wide |
--scale <n> | any device pixel ratio |
--blur | motion blur (8 samples; --samples, --shutter) |
--alpha | transparent background |
--workers <n> | parallel browsers |
openfilm get
openfilm get <what> [--option value …]
Media for the project from the services you connected, saved under assets/: voice-over, music, sound effects, transcripts, images, image search, video and subtitle translation. Each kind works once a service that makes it is connected. Run it alone to see what is available. Each service bills you directly.