Output, errors, and common options

Learn to read responses and decide what to do after a failure.

User guideEnglish

Common management command options

OptionUsage
--jsonRead the version / ok / data / error JSON response.
--timeout <ms>1–86,400,000ms; default 30,000ms. The browser maximum is 60,000ms.
--helpLocal help for a management command.
--followKeep receiving new records with session output. Ctrl+C ends only the subscription.
--stdinRead the raw content for session send, package save, and employee instruct (or the shift commands request, reply, and meeting) from standard input. Do not combine with --text.

Exit codes

CodeMeaning for management and browser commands
0Success
2Usage error
3No connection or runner, or the management connection was lost. Also check partial results.
4Rejected · Conflict · Canceled · Timed out · Failed · Unknown outcome

Server commands have their own exit codes and syntax. For serve, 10 means it is already running.

Partial results and unknown outcomes

A failure can contain both data and error. Check for created IDs, completed steps, and an unknown outcome. Do not automatically resend the same input, save, or run request.

Retaining completed results

During the same daemon run, CLI completion results are kept for up to 24 hours, 100 items, or 64 MiB total. They are removed according to whichever age, count, or size limit is reached first. Recovery of retained results after a daemon restart is not guaranteed.

Search documentation

The page could not be displayed. Reload ×