ster request
Run one JSON request from a desktop application to completion: the body on stdin, NDJSON log events and one result event on stdout, and the result's status as the exit status.
Invocation and purpose#
ster request <OPERATION>Runs one train, optimize, evaluate, generate, extract, inspect, decide, calibrate, workspace, pair-set or tune operation for a desktop client and exits when it has answered. Ster Desktop runs one per operation, so no Ster process stays running between two of them and no port is opened.
Inputs and options#
| Input | Required | Meaning |
|---|---|---|
<OPERATION> | yes | train, optimize, evaluate, generate, extract, inspect, decide, calibrate, workspace/import-pairs, pairs/inspect, pairs/save, pairs/synthesize, tune/sft, tune/dpo, tune/reward, tune/grpo, tune/merge, tune/evaluate or tune/inspect. |
| stdin | yes | One JSON document whose camelCase fields are the flags of the mirrored command. An empty body is {}. The fields per operation are in the desktop request reference. |
Output and state#
stdout carries only NDJSON events: zero or more log events with the progress lines the command would have written to stderr, then exactly one result event whose json is the document the command prints. The process exits with the result's status. It keeps no state of its own; an operation may write the output artifacts its request names.
Refusals#
- A missing
<OPERATION>is rejected by clap before anything is read. - An unknown operation, a body that does not parse (
request body is not valid JSON: <reason>), and a missing or invalid field such asvector/train requires a model,vector/train requires a pairs fileorvector/train requires an output pathend with a singleresultevent of status2before any model loads. - A failure once the operation has started prints
error: <sentence>as the lastlogevent and ends with aresultof status1— the sentencester <command>prints afterError:. The full contract is in the desktop request reference.