yamcs commands¶

Synopsis¶

Description¶

Manage commands.

Commands¶

list

List commands

describe <COMMAND>

Describe a command

run <COMMAND>

Run a command

log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>]

Read command log

Options¶

--processor <PROCESSOR>¶

With run, specifies the name of the target processor.

Default is realtime.

--dry-run¶

With run, validate the command, but do not queue it.

--arg-file <FILE>¶

With run, read command arguments from a file

--arg <KEY=VALUE> [KEY=VALUE ...]¶

With run, set command arguments.

--sequence-number <SEQNO>¶

With run, set the sequence number of this command. This is used to determine unicity of commands at the same time and coming from the same origin. If not set Yamcs will automatically assign a sequential number as if every submitted command is unique.

-n <LINES>, --lines <LINES>¶

With log, specify the number of commands to show, or all to show all.

Default: 10, but only when --since and --until are unset.

-s <DATE>, --since <DATE>¶

With log, include commands not older than the specified date.

The date should be specified in ISO format or as detailed under Timestamps.

-u <DATE>, --until <DATE>¶

With log, include commands not newer than the specified date.

The date should be specified in ISO format or as detailed under Timestamps.

Timestamps¶

When parsing timestamps, yamcs-cli accepts a specification in ISO format. The following special patterns are also recognised:

• now: current time

• now UTC: current UTC time

• today: 00:00:00 of the current day

• today UTC: 00:00:00 UTC of the current day

• yesterday: 00:00:00 of the day before

• yesterday UTC: 00:00:00 UTC of the day before

• tomorrow: 00:00:00 of the next day

• tomorrow UTC: 00:00:00 UTC of the next day