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]

Starts or opens a project. A folder that is not one yet gets an empty film.html; nothing else is created. Then Studio shows the project: a Studio page already open switches to it, otherwise it opens in your browser. Starts Studio if it is not running and prints its address. A project that was copied in and never opened is shown the first time look or render runs in it.

The first time, it downloads Studio for this version of OpenFilm (about 175 MB, into ~/.openfilm) and the browser it draws films with (about 100 MB). Studio runs on macOS with Apple silicon for now; the format and the other commands work everywhere.

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/look/.

openfilm render

openfilm render [a-b]

Renders the project to an MP4 beside film.html, or a range to .film/render/.

openfilm get

openfilm get <what> [--option value …]

Media for the project from the OpenFilm account, saved under assets/: voice, tts, sfx, music, asr, image-search, image and video. Each call is paid with the account's credits. Without an account, your agent can use any other service with its own API key.