1
0
mirror of https://github.com/mifi/lossless-cut.git synced 2024-11-24 19:32:29 +01:00
lossless-cut/cli.md
Mikael Finstad b32d1958e5
improve docs
2024-08-15 14:57:25 +02:00

3.0 KiB

Command line interface (CLI)

LosslessCut has basic support for automation through the CLI. See also HTTP API.

LosslessCut [options] [files]

Note that these examples assume that you have set up the LosslessCut executable to be available in your PATH (command line environment). Alternatively you can run it like this:

# First navigate to the folder containing the LosslessCut app
cd /path/to/directory/containing/app
# Then run it
# On Linux:
./LosslessCut arguments
# On Windows:
./LosslessCut.exe arguments
# On MacOS:
./LosslessCut.app/Contents/MacOS/LosslessCut arguments

Open one or more files:

LosslessCut file1.mp4 file2.mkv

Override settings (experimental)

See available settings. Note that this is subject to change in newer versions. ⚠️ If you specify incorrect values it could corrupt your configuration file. You may use JSON or JSON5. Example:

LosslessCut --settings-json '{captureFormat:"jpeg", "keyframeCut":true}'

Other options

  • --locales-path Customise path to locales (useful for translators).
  • --disable-networking Turn off all network requests.
  • --http-api Start the HTTP server with an API to control LosslessCut, optionally specifying a port (default 8080).
  • --keyboard-action Run a keyboard action (see below.)
  • --config-dir Path to a directory where the config.json file will be stored and loaded from. Note: don't include config.json in the path (only the directory containing it).

Controlling a running instance (experimental)

If you have the "Allow multiple instances" setting enabled, you can control a running instance of LosslessCut from the outside, using for example a command line. You do this by issuing messages to it through the LosslessCut command. Currently only keyboard actions are supported, and you can open files. Note that this is considered experimental and the API may change at any time.

Keyboard actions, --keyboard-action

Simulate a keyboard press action in an already running instance of LosslessCut. Note that the command will return immediately, so if you want to run multiple actions in a sequence, you have to sleep for a few seconds between the commands. Alternatively if you want to wait until an action has finished processing, you can use the HTTP API instead. Note that the HTTP API does not support opening files, and it is currently not possible to wait for a file to have finished opening.

Available keyboard actions

A list of the available action names can be found in the "Keyboard shortcuts" dialog in the app. Note that you don't have to bind them to any key before using them.

Example:

# Open a file in an already running instance
LosslessCut file.mp4
sleep 3 # hopefully the file has loaded by now
# Export the currently opened file
LosslessCut --keyboard-action export

Open files in running instance

LosslessCut file1.mp4 file2.mkv