yggctl(8)

✨ NAME ✨

okay so bestie, welcome to yggctl(8) from the System Manager's Manual — this is literally the page for yggctl, aka the tool that lets you control and interact with yggd. It’s giving command-line main character energy, and honestly? Iconic. 💅

---

✨ SYNOPSIS ✨

vibe check on the syntax, bestie — here it is exactly:

yggctl

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

Usage:

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

So it’s yggctl with optional global flags, then a command, then that command’s options and arguments. Simple? Yes. Slay? Also yes. 🦋

---

🌸 GLOBAL OPTIONS 🌸

These are the big-picture flags — lowkey the pre-game before your command:

• --help, -h — show help. Your little “what is this?” button.
• --version, -v — print the version. For when you need the receipts. 🧾

---

🦋 COMMANDS 🦋

This is the command menu, bestie. Each one has its own vibe, and yes, you need every single detail. No skipping, fr fr.

🌟 client-id

Retrieve the current client id. No options, no drama — just straight to the point:

yggctl client-id

🧚 workers

Interact with yggdrasil workers. This is the umbrella command, and it has a subcommand that’s giving organized:

🎀 list

List currently connected workers.

• --format="" — print output in FORMAT (json or table) (default: "table"). The way that --format lets you pick your output style? Obsessed. ✨

🚀 dispatch

Dispatch data to a worker locally. Here’s the exact shape, bestie:

yggctl dispatch [command options] FILE

Options:

• --metadata, -m="" — attach JSON as metadata to the message (default: "{}").
• --worker, -w="" — send data to WORKER.

📓 message-journal

Show events emitted by workers. It’s the receipts command, and you run it like this:

yggctl message-journal

Options:

• --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. Highkey useful.

• --worker, -w="" — listen for events emitted by WORKER.

🫶 help, h

Shows a list of commands or help for one command. Your built-in “help me, bestie” button — no cap. 💖

---

that’s the whole yggctl(8) manual page, bestie — signed off from the yggctl(8) footer vibe, with all the details intact and zero fake extras 💖✨