Console command

Русский · User guide · Operations · Presets · AI agent

Contents

• Commands
• Running an operation
• A frame before and after
• The output
• Outcome and exit codes
• Where the result goes
• Stopping

vs_cli.cmd in the root of the program runs what the buttons of the window run: a preset, a profile or a service, with the same fields. The window is the face of this command: whatever it starts, it starts through the command, and the first line of every run in its journal is a ready command that can be repeated in a console.

The command is for the cases where a preset is started not by a person at the window: a batch file, another tool, an AI agent, a long night of renders.

Commands

--root FOLDER before the command names another copy of the program; --language ru or en — the language of the journal (the language of the window when not named).

Running an operation

copy.\vs_cli.cmd run --operation film_35mm
.\vs_cli.cmd run --operation film_35mm --set stock=500T --set intensity=1.2 --encoder prores_422hq
.\vs_cli.cmd run --operation shadow_denoise_sota --set vs_accel=cpu --source D:\Footage --target D:\Clean
.\vs_cli.cmd run --operation profile_run --set profile=filmic_warm_35mm --source D:\Footage\take.mov
.\vs_cli.cmd run --operation deband_safe --dry-run
.\vs_cli.cmd run --operation doctor

A relative --source and --target count from the root of the program; --result, --params, --cancel-file — from the folder of the caller.

The fields every preset has — the processing and the cards of the encoder, and the run:

<!-- map:machine --> These fields stand on every page: the processing and the cards of the encoder are one for the whole window, set on one page they are set on all.

Where the result goes. <Target>\<Palette>\<preset>_<encoder>\<the folders of the Source>\<name>.<ext>; a profile - <Target>\Profiles\<profile>_<encoder>\.... The name of the source is kept. A result that is there is passed over unless Overwrite. <!-- /map -->

A hardware encoder this machine has not passed SERVICE → Hardware capabilities is turned into the processor, and a [NOTE] line says so. vs_accel changes something only on the BM3D presets and the neural ones; on the rest it is accepted and does nothing.

A value is checked before the run. A number outside its range, a choice that is none of its field's, a field the operation does not have, --dry-run of an operation that cannot say its commands — each is a wrong call: exit 2 and the reason, nothing is run. A value is never moved quietly into its range.

A JSON value from PowerShell. A field whose value is JSON (profile_values of profile_save) goes through --params FILE: PowerShell breaks the quotes of JSON on its way into a .cmd.

A frame before and after

copy.\vs_cli.cmd frame --operation polaroid --source D:\Footage\take.mov
.\vs_cli.cmd frame --operation mild_denoise --set strength=strong --source D:\Footage\take.mov --at 0.25 --out D:\Look --max-width 0

It runs the same .vpy with the same values a run takes and writes nothing into the Target. The answer is one line of JSON: before and after with path, frame, frames, width, height, fps; seconds, params, and noise for a denoiser. A preset that changes the number of frames (RIFE) is read at the same share of its length. When it cannot — no engine, a neural preset without MLRT, no video — ok is false, error says why, exit 1; a wrong call is exit 2.

The output

The journal is ordinary lines:

copy[PREFLIGHT] OK engine: installed
[PREFLIGHT] OK Source: 3 video(s) in D:\Footage
[RUN] preset: film_looks/film_35mm, encoder h264_crf14, BM3D auto
[FILE] 1/3 take_01.mov
[PROGRESS] take_01.mov [##########--------------]  42% 105/250 18.40 fps ETA 00:08
Frame: 105/250 (18.40 fps)
[OK] take_01.mp4: 48,210,334 B in 13.6 s
[DONE] 3 done, 0 passed over, 0 failed

[NOISE] mild_denoise: noise 5.34 / 3.44 / 2.75 (8-bit, Y/U/V) -> DFTTest sigma 57.1 — what a denoiser measured and what it made of it. [SKIP] — a result already there; [FAIL] — a file that failed, the next goes on; [DRY RUN], [STOPPED], [REFUSED], [NOTE] say what they say. A caller that reads by a pipe gets service lines ::vs::{...} (started, progress, activity, finished) too; a console does not. The journal of every run is logs\<time>_<operation>.log, its report report\<time>_<operation>\run_report.json and .md, with a JSON of every file beside them.

Outcome and exit codes

--result FILE writes, whatever the outcome:

copy{"operation": "film_35mm", "outcome": "done", "ok": true, "message": "Operation finished.",
 "processed": 3, "skipped": 0, "failed": 0, "parameters": {"stock": "250D", "...": "..."}, "seconds": 41.2,
 "log_file": "...", "source": "D:\\Footage", "target": "E:\\...\\output", "data": {"files": ["..."], "encoder": "h264_crf14"}}

outcome is done, failed, refused or stopped. The file is a .json outside the Source.

Where the result goes

<Target>\<Palette>\<preset>_<encoder>\<the folders of the Source>\<name>.<ext> — Precision\, Film Looks\, Retro\, Restoration\; a profile — <Target>\Profiles\<profile>_<encoder>\…. The name of the source is kept. A result is written as <name>.writing-<pid>-<token>.<ext> and takes its name only when whole. A result already there is passed over unless --set overwrite=true, so a second run into the same Target reads done with processed 0.

The encoders and the cards each one is:

<!-- map:encoders -->

<!-- /map -->

Stopping

--cancel-file FILE: when the file appears, the engine ends vspipe and FFmpeg, removes the half-written file and keeps the finished ones; the outcome is stopped, exit 130. The window's STOP is this file.