reelkit-cli 0.6.0 → 0.10.0

package/src/cli.ts

@@ -1,8 +1,8 @@
 import { Command } from "commander";
 import { ApiFailure } from "./api/client";
-import { assetsGenClip, assetsGenImage, assetsPull, assetsSearch, assetsUpload, assetsVoiceover, assetsVoices } from "./commands/assets";
+import { assetsGenClip, assetsGenImage, assetsGenSvg, assetsLayers, assetsPull, assetsSearch, assetsUpload, assetsVoiceover, assetsVoices } from "./commands/assets";
 import { authLogin, authLogout, whoami } from "./commands/auth";
-import { check, preview, render } from "./commands/build";
+import { check, preview, render, soundCommand } from "./commands/build";
 import { componentsShare } from "./commands/components";
 import { init } from "./commands/init";
 import { install } from "./commands/install";
@@ -66,28 +66,36 @@ auth.command("login").description("Log in to Reelkit: opens the login page in yo
 auth.command("logout").description("Log out and remove the stored token").action(run(authLogout));
 program.command("whoami").description("Show your account, quota and contributions").action(run(whoami));
 
-program.command("init [name]").description("Set up a video project (in a new folder named after it, or in this folder)").option("--aspect <aspect>", "9:16, 16:9 or 1:1").option("--private", "do not share new components with the library after a render (writes shareComponents: false)").action(run(init));
+program.command("init [name]").description("Set up a video project (in a new folder named after it, or in this folder)").option("--aspect <aspect>", "9:16, 16:9 or 1:1").option("--private", "keep everything in this project out of the library: no components after a render, and no generated images, clips or graphics (writes shareComponents: false)").action(run(init));
 
 const assets = program.command("assets").description("Find, add and generate the files a video needs");
 assets.command("upload <file>").description("Add one of your own files to this project (private unless --share; with --cutout the video is sent to the Reelkit server to be processed)")
   .option("--describe <text>", "what the file shows").option("--footage", "use this video as the footage to overlay").option("--green", "the video is a subject on a green background: also make a copy with the green transparent (free, on this machine)")
   .option("--cutout", "remove any background: the video is sent to the Reelkit server to be processed and a copy with a transparent background comes back (up to 20 seconds, counts against a monthly quota)")
   .option("--resume <id>", "with --cutout: keep waiting for a cutout already started, without uploading or paying again")
-  .option("--share", "also send it to the shared library").option("--kind <kind>", "library kind when sharing").option("--tags <tags>", "comma-separated tags when sharing")
+  .option("--background", "use this video or image as the ground behind the whole film (it stays on this machine)").option("--share", "also send it to the shared library").option("--kind <kind>", "library kind when sharing").option("--tags <tags>", "comma-separated tags when sharing")
   // Called with the arguments named: commander adds its own command object last, which must not be taken for the function's test hooks.
   .action(run((ctx, file: string, opts: Parameters<typeof assetsUpload>[2]) => assetsUpload(ctx, file, opts)));
 assets.command("search <query>").description("Search the shared library by meaning; each result shows how well it fits").option("--kind <kind>", "image, overlay, sfx, music, component or clip").option("--limit <n>", "how many results")
   .action(run(assetsSearch));
-assets.command("pull <id>").description("Download a library item into this project").option("--scene <sceneId>", "use it as this scene's image or clip").option("--force", "replace a component file that already exists").option("--music", "make this music item the video's track (its tempo is measured and scene changes land on its beat)")
+assets.command("pull <id>").description("Download a library item into this project").option("--scene <sceneId>", "use it as this scene's image or clip").option("--force", "replace a component file that already exists").option("--music", "make this music item the video's track (its tempo is measured and scene changes land on its beat)").option("--background", "make this clip, overlay or image the ground behind the film (with --scene: the ground of that scene, an image only)")
+  .option("--layers", "with --scene and an image: right after it is pulled, cut the subject out as a layer (about 1 second of the cutout quota; the picture is sent to the Reelkit server)")
   .action(run((ctx, id, opts) => assetsPull(ctx, id, opts)));
+assets.command("layers [file]").description("Split a picture into layers: the subject cut out as a PNG with alpha beside it, and where words can sit (the picture is sent to the Reelkit server for the cut-out and uses about 1 second of the cutout quota)")
+  .option("--scene <sceneId>", "the scene whose image to split").option("--redo", "make the layers again even if they exist").option("--resume <id>", "keep waiting for a cut-out already started, without sending or paying again")
+  .action(run((ctx, file: string | undefined, opts: Parameters<typeof assetsLayers>[2]) => assetsLayers(ctx, file, opts)));
 assets.command("voices").description("List the narration voices").action(run(assetsVoices));
 assets.command("voiceover").description("Record the narration from plan.json").option("--scene <sceneId>", "one scene").option("--all", "every scene").option("--redo", "record again even if it exists")
   .action(run(assetsVoiceover));
 const gen = assets.command("gen").description("Generate an asset");
 gen.command("image [prompt]").description("Generate a scene's illustration; the prompt defaults to the plan's")
-  .requiredOption("--scene <sceneId>", "the scene it is for").option("--redo", "generate a new image even if the scene has one").action(run(assetsGenImage));
+  .option("--scene <sceneId>", "the scene it is for").option("--background", "make an abstract background picture for the film (or for --scene) instead of an illustration").option("--redo", "generate a new image even if the scene has one").option("--layers", "right after it is made, cut the subject out as a layer (about 1 second of the cutout quota; the picture is sent to the Reelkit server) and measure where words can sit")
+  .action(run((ctx, prompt: string | undefined, opts: Parameters<typeof assetsGenImage>[2]) => assetsGenImage(ctx, prompt, opts)));
+gen.command("svg <prompt>").description("Generate a vector graphic (an icon, a mark, a simple illustration or a diagram) that stays sharp at any size; it takes about 45 seconds and counts as one image")
+  .option("--scene <sceneId>", "use it as this illustration scene's image").option("--background", "use it as the ground of the film (or of --scene)").option("--redo", "generate a new one even if the scene has an image").option("--private", "never share it with the library, whatever the plan says")
+  .action(run((ctx, prompt: string, opts) => assetsGenSvg(ctx, prompt, opts)));
 gen.command("clip [prompt]").description("Generate a scene's video clip (takes minutes); the prompt defaults to the plan's clipPrompt")
-  .requiredOption("--scene <sceneId>", "the scene it is for").option("--green", "film it on green and key the green out into a transparent .webm")
+  .option("--scene <sceneId>", "the scene it is for").option("--background", "make an abstract, seamless clip to sit behind the whole film (no --scene)").option("--green", "film it on green and key the green out into a transparent .webm")
   .option("--cutout", "make the clip normally, then cut the subject out on the server (the video is sent to the Reelkit server to be processed; counts against a monthly quota)").option("--seconds <n>", "5 or 10 (default 5)")
   .option("--share", "also add it to the shared library (only a generic clip)").option("--redo", "generate a new clip even if the scene has one").option("--resume <id>", "keep waiting for a clip already started, without paying again")
   .action(run((ctx, prompt, opts) => assetsGenClip(ctx, prompt, opts)));
@@ -110,6 +118,9 @@ program.command("install").description("Install the Reelkit skill into your codi
 program.command("preview").description("Render preview frames into out/preview/: two per scene (at 30% and 90%) and the frames either side of each scene change, with a report of what carries across").action(run((ctx) => preview(ctx)));
 program.command("render").description("Render the video to out/video.mp4; new components written in this project are then shared with the library for review").option("--no-share", "do not share new components with the library after this render (also: REELKIT_NO_SHARE=1)")
   .action(run((ctx, opts: { share?: boolean }) => render(ctx, { noShare: opts.share === false })));
+program.command("sound [file]").description("Measure the sound of a finished film against its picture: hits, swells and how many picture changes have a sound (default out/video.mp4)")
+  .option("--detail", "list every picture change with the nearest hit and its distance, every swell (start, peak, length) and the first sound")
+  .action(run((ctx, file: string | undefined, o: { detail?: boolean }) => soundCommand(ctx, file, { detail: o.detail })));
 const components = program.command("components").description("Components written in this project");
 components.command("share [names...]").description("Share components written in this project with the library for review (all of them with no name): their source, a description and an example are sent, nothing else")
   .option("--describe <text>", "what it shows and when to use it (one component)").option("--example <jsx>", "an example use with plain values, such as '<StatRing value={42} />' (one component)").option("--tags <tags>", "comma-separated tags, 3 to 6 (one component)")