spatialmsg(1)

💌 spatialmsg(1) — General Commands Manual edition: send messages to Spatial Shell over IPC 💌

✨ NAME ✨

spatialmsg sends messages to a running instance of Spatial Shell over the IPC socket. that's literally the whole job, and it's iconic for it 💅.

🦋 SYNOPSIS 🦋

bestie, the shape is right here — keep the brackets exactly as they are, they're doing important work 🫶:

spatialmsg [--json|--quiet] [-t <type>] [message]

🎀 OPTIONS 🎀

okay so the flags are giving choices ✨:

• --quiet — sends the IPC message, but does not print the response from Spatial Shell. silent-mode bestie, no notes 🙈.
• --json — prints the response from Spatial Shell as received, that is in JSON. raw JSON realness, we love to see it 🧚.
• --type, -t <type> — specifies the type of the IPC message. the types are right below, keep scrolling 💖.

👑 IPC MESSAGE TYPES 👑

these are the message types you can pass with --type / -t, and yes they all have main character energy 👑:

• <command> — the message is a Spatial Shell command. See spatial(5) for a list of available commands.
• get_workspace_config — gets the current workspace configuration: its layout, and the maximum number of columns displayed at once when in the column layout. workspace config tea ☕.
• get_workspaces — gets the list of the workspaces currently in use.
• get_windows — gets the list of the windows for the current workspace.

See spatial-ipc(7) for a description of the JSON objects returned for each IPC message. iykyk 🦋.

🌈 RETURN CODE 🌈

exit codes, aka the final vibe check 😭:

• 0 — Success ✨
• 1 — Invalid but correctly parsed command line arguments
• 2 — Spatial Shell returned an error
• 124 — Command line parsing errors
• 125 — Internal errors (bugs)

💜 AUTHOR 💜

Developed by Thomas Letan <lthms@soap.coffee> — yes, that's the icon behind it 💖. For more information about Spatial Shell development, see <https://github.com/lthms/spatial-shell>.

🙌 ACKNOWLEDGMENT 🙌

Spatial Shell could not have been possible without sway, which remains a reference and a significant source of inspiration for the software architecture of this project, including for the wording of several man pages. respect where respect is due, fr fr 🫶.

---

okay that's the whole vibe 💖 — spatialmsg(1) from the General Commands Manual, dated 1980-01-01. bye bestie, go send some messages 💌✨