Docs / CLI reference

Global options

The flags, output format, exit codes and environment variables that work the same way on every minicut command.

Every minicut command follows the rules on this page. A script or a coding agent can read the exit code and the JSON output of any command in the same way.

Options

FlagTypeDescription
--jsonswitchPrint one JSON object on stdout instead of text. Works on every command that lists it in its usage line
--help, -hswitchPrint every command with a one-line description, then exit with code 0. minicut help does the same

A command name MiniCut does not know prints the command list and exits with code 2. On a computer that is not signed in, the sign-in check comes first, so it exits with code 10.

Output

Results go to stdout. Notes for a person go to stderr, so stdout stays one clean result. Two notes can appear on stderr:

  • The offline note, when the computer has not reached minicut.ai for a while. See Account.
  • One line after an automatic update, on the next command.

With --json, an error has the same shape on every command:

Terminal
minicut me --json
Output
{"error":{"code":"signed_out","message":"You are not signed in. Ask your agent to run minicut login.","url":null,"request_id":null}}
FieldDescription
codeA fixed error code. Read this to decide what to do
messageThe same sentence the text output prints
urlA page on minicut.ai that fixes it, or null
request_idThe id of the request, to quote when you contact us, or null

Without --json, the command prints the message, then the URL and Request id: when they exist.

If a command stops on an error it did not expect, it prints minicut: and the error, and exits with code 1.

Exit codes

CodeMeaningWhat to do
0DoneNothing
1A check found a problem, or the command stopped on an error it printedRead the printed lines. Each check failure names its fix
2The command could not run: a wrong flag, a missing file or a wrong idFix the command and run it again
3The command needs your yes before it runs. It printed the line to run after you agree. Nothing was sentRun the printed line if you agree. minicut setup also uses 3 when there is less than 5 GB free
4minicut setup finished, but Python 3.12 or ffmpeg is missingInstall it from the site setup printed, then run setup again
5An input is outside what the command or model takesChange the input the message names
6Not ready yet: a job is still runningRun the same command again later
7MiniCut could not reach minicut.aiConnect to the internet, then run the same command again
8Something went wrong on our side, or there are too many requests right nowRun the same command again. If it fails again, wait a few minutes
9Your account does not cover this. The message links to minicut.aiOpen the link in the message
10This computer is not signed in, or the sign-in was cancelled or expiredRun minicut login
12This version of MiniCut is too oldRun minicut update, then the same command again
75Another minicut update is runningWait for it to finish, then run minicut update again

Environment variables

VariableDefaultDescription
MINICUT_HOME~/.minicut, or %LOCALAPPDATA%\minicut on WindowsThe MiniCut home folder: settings, key file, tools, projects and library
MINICUT_PORT7311The port the MiniCut app uses on your computer. Set it when another program uses that port
MINICUT_NO_AUTOUPDATEnot setSet to 1 to turn off the automatic update. "auto_update": false in settings.json does the same
MINICUT_NO_ERROR_REPORTSnot setSet to 1 to turn off crash reports. "error_reports": false in settings.json does the same
CInot setWhen set, MiniCut makes no automatic update and sends no crash reports
HTTPS_PROXYnot setRead when you install MiniCut. The install saves it as the proxy for every command. Change it later with minicut network

When a command crashes, MiniCut sends one crash report to minicut.ai. It carries no key, no file path and no error message.

See also