MOSH(1)

📦
version 1.4.0 · 2 versions
  • 1.4.0 · alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, debian bookworm, debian trixie, epel 10, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.3.2 · ubuntu jammy
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, debian bookworm, debian trixie, epel 10, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💅 MOSH(1) — mosh-client, the client-side helper bestie 💖

okay so real talk, this is the manual page for mosh-client, the client-side helper for mosh. she's the little icon that does the actual terminal work while the mosh script out here doing the logistics. periodt. ✨

🌸 NAME 🌸

mosh-client — client-side helper for mosh, no cap 💅

🎀 SYNOPSIS 🎀

MOSH_KEY=KEY mosh-client [-v] IP PORT
mosh-client -c

like, those are the two ways you call her. pick your fighter. 💖

✨ DESCRIPTION ✨

so. mosh-client is a helper program for the mosh(1) remote terminal application. she's not the main character exactly, but bestie, she is literally running for the whole connection, so.

mosh itself is a setup script. what it does is:

  • establishes an SSH connection 🔌
  • runs the server-side helper mosh-server 👑
  • collects the server's port number and session key 🎁

then mosh executes mosh-client with the server's IP address, port, and session key. and mosh-client just... runs. for the lifetime of the connection. she's committed like that. 🫶

the 22-byte base64 session key that mosh-server hands over gets supplied in the MOSH_KEY environment variable. that key represents a 128-bit AES key that protects the integrity and confidentiality of the session. so like, it's kind of a big deal. 🔐

if you're out here constructing new setup wrappers for remote execution facilities other than SSH, it may be necessary to invoke mosh-client directly. so she's not just a helper, she's a building block. main character energy honestly. 🌈

with the -c option, mosh-client instead prints the number of colors of the terminal given by the TERM environment variable. cute little color vibe check. 🎨

the -v option will print some debugging information on standard error. more instances of this flag = more debugging information. stack 'em. 🔥

⚠️ okay listen, important: if standard error is not redirected from the terminal, the display will be corrupted and quickly become unusable. like, your whole screen. gone. 💀 don't do that.

🌈 ENVIRONMENT VARIABLES 🌈

  • MOSH_KEY — this variable must be set, and must contain a Base64-encoded cryptographic key from mosh-server(1). non-negotiable bestie, she will not run without it. 🗝️
  • MOSH_ESCAPE_KEY — see mosh(1). 🦋
  • MOSH_PREDICTION_DISPLAY — controls local echo as described in mosh(1). ✨
  • MOSH_PREDICTION_OVERWRITE — controls local echo insert/overwrite as described in mosh(1). ✏️
  • MOSH_TITLE_NOPREFIX — see mosh(1). 💜

👀 SEE ALSO 👀

project home page: https://mosh.org 🌐

👑 AUTHOR 👑

mosh was written by Keith Winstein <mosh-devel@mit.edu>. we love an icon. 💖

😭 BUGS 😭

please report bugs to <mosh-devel@mit.edu>. users may also subscribe to the <mosh-users@mit.edu> mailing list, at http://mailman.mit.edu/mailman/listinfo/mosh-users 📬

and that's the whole page bestie 💅 this version is dated February 2012 and it's from the General Commands Manual — so like, retro but still slaying. mwah. 🎀✨🦋

📦 where this page comes from