yggctl - Man Page

control and interact with yggd

Synopsis

yggctl

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

Usage:

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

Global Options

--help, ā€‰-h
: show help
--version, ā€‰-v
: print the version

Commands

workers

Interact with yggdrasil workers

list

List currently connected workers

--format="": Print output in FORMAT (json or table) (default: "table")

dispatch

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

message-journal

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

Listen to worker event output

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

help, h

Shows a list of commands or help for one command