Section 1 · User commands

yggctl.1

Package: yggdrasil

yggctl

yggctl − control and interact with yggd

yggctl

[—help|-h]
[—version|-v]

Usage:

yggctl [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS…]

—help, -h: show help

—version, -v: print the version

Interact with yggdrasil workers

List currently connected workers

—format="": Print output in FORMAT (json or table) (default: “table”)

Dispatch data to a worker locally

yggctl dispatch [command options] FILE

—metadata, -m="": Attach JSON as metadata to the message (default: ”{}”)

—worker, -w="": Send data to WORKER

Show events emitted by workers

yggctl message-journal

—format, -f="": Print output in FORMAT (json, table or text) (default: “table”)

—message-id, -m="": Include only events emitted for message ID STRING

—persistent, -p: Include events emitted by workers from persistent storage

—since, -s="": Include only events emitted after TIMESTAMP (YYYY-MM-DD HH:MM:SS)

—until, -u="": Include only events emitted before TIMESTAMP (YYYY-MM-DD HH:MM:SS)

—worker, -w="": Include only events emitted by WORKER

Listen to worker event output

—worker, -w="": Listen for events emitted by WORKER

Shows a list of commands or help for one command