elvish-platform(7)

✨ elvish-platform(7) ✨

okay bestie, welcome to the Miscellaneous Information Manual 💅 this one is filed under elvish-platform, and it's genuinely the cutest little module — it's just your platform's ~identity~ 🪪 no cap.

---

🌸 Introduction 🌸

The platform: module gives you access to the platform's identifying data. that's it, that's the whole vibe — it's like the group chat bio of your operating system 🫶

---

💖 Variables 💖

$platform:arch {#platform:arch}

The architecture of the platform; e.g. amd64, arm, ppc. this one lines up exactly with Go's GOARCH constant — here's the link if you wanna peek: https://pkg.go.dev/runtime?tab=doc#pkg-constants 👑

This is read-only. like, don't even try it, she's not accepting edits 🙈

$platform:is-unix {#platform:is-unix}

Whether or not the platform is UNIX-like. this includes Linux, macOS (Darwin), FreeBSD, NetBSD, and OpenBSD. it's giving "am I in the unix club" 💅

you can use this to decide, for example, if the unix module is usable. super handy iykyk.

This is read-only. ✨

$platform:is-windows {#platform:is-windows}

Whether or not the platform is Microsoft Windows. yes, this is the "is it windows" button. iconic, honestly 🪟

This is read-only. 💀

$platform:os {#platform:os}

The name of the operating system; e.g. darwin (macOS), linux, etc. this matches Go's GOOS constant — link right here bestie: https://pkg.go.dev/runtime?tab=doc#pkg-constants 🌈

This is read-only. periodt. 🎀

---

🦋 Functions 🦋

platform:hostname {#platform:hostname}

platform:hostname &strip-domain=$false

Outputs the hostname of the system. that's your machine's little name tag 🏷️

If the option &strip-domain is $true, it strips the part after the first dot. so you get just the short name, no domain attached. cute.

⚠️ heads up bestie: this function throws an exception if it cannot determine the hostname. no hostname, no vibes 😭

It's implemented using Go's os.Hostname — here's that link too: https://golang.org/pkg/os/#Hostname 🐹

Examples:

~> platform:hostname
▶ lothlorien.elv.sh
~> platform:hostname &strip-domain=$true
▶ lothlorien

see?? full name vs. nickname. the glow-up is real 💖✨

---

and that's the whole page, bestie!! you ate that 🍓

Elvish 0.17.0 🎀 Nov 18, 2024 — mwah, go forth and vibe check your platform 💜🦋