DocsDevelopers

CLI

The loudscene command line: log in, create, render and download.

loudscene makes on-brand videos from your terminal, scripts and CI, and bridges the MCP server to agents that only speak stdio. It needs Node 20 or newer and an API key (Agency plan).

Install and log in#

npx loudscene login   # paste your ls_live_… key

Quick start#

Terminal

loudscene create --url yourbrand.com --brief "We just launched v2: twice as fast." --formats 9:16 --wait
loudscene render <video id> --formats 9:16,1:1 --wait
loudscene download <render id> -o ./videos

Commands#

Command	What it does
`login [--key <key>]`	Checks the key and saves it to ~/.config/loudscene/config.json (readable only by you). Without --key it asks for it without echoing.
`logout`	Removes the saved key.
`whoami`	Shows the key (masked), where it comes from, the server, and whether the key works.
`brand <url> [--wait]`	Extracts a brand kit from a website. --wait waits for the kit id.
`brands`	Lists brand kits, default first.
`stories`	Lists story templates and their field keys.
`create [--url <site> \| --brand <kit id>] --brief "<text>" [--story <id>] [--formats <list>] [--duration <s>] [--locale <code>] [--title <text>] [--wait] [--render]`	Creates a video. The first of --formats is its main format. --wait waits for the AI generation; --render then renders every listed format (add --wait to wait for the MP4s too).
`status <id>`	Status of a job, video or render (the kind of id is detected).
`render <video id> [--formats <list>] [--resolution 720\|1080\|2160] [--wait]`	Renders MP4s, by default in the video's main format.
`download <render id> [-o <dir>] [--wait]`	Saves a finished render as loudscene-<video>-<format>-<res>p.mp4.
`open <video id>`	Opens the video in the loudscene editor.
`mcp`	Runs the stdio MCP bridge for agents that only speak stdio (see MCP server).

Formats are 16:9, 9:16, 1:1 and 4:5 (9x16 works too), comma-separated.

Options and exit codes#

Option	Meaning
`--json`	Machine-readable output on stdout.
`--api-url <url>`	Another server (default https://www.loudscene.com).
`--timeout <s>`	Upper bound for --wait, default 900.
`-h, --help`	Help for every command.
`-v, --version`	The CLI version.

Exit code	Meaning
0	Success
1	Error
2	Usage error
3	Missing or rejected API key

Environment and CI#

Variable	Default	Meaning
`LOUDSCENE_API_KEY`	the saved key	Overrides the key saved by login.
`LOUDSCENE_API_URL`	https://www.loudscene.com	Another server.
`XDG_CONFIG_HOME`	~/.config	Where loudscene/config.json lives.

In CI, set the key as a secret and skip login:

Shell

export LOUDSCENE_API_KEY=…   # from your CI secrets
npx loudscene create --brand <kit id> --brief "Release notes for v2.3" --formats 16:9,9:16 --wait --render --json

Credits#

The CLI spends credits exactly as the API does. create with a brief is an AI generation and counts against your plan's monthly generations. The first render of a video version costs one credit per started minute and covers every format and resolution of that version; rendering an unchanged version again is free. See Credits and plans.