KW-SSH(1)

✨ kw-ssh — Access remote via ssh() ✨

okay bestie, welcome to the kw-ssh glow-up 💅 this is the part of kw that literally just... ssh's into any machine you can reach over the network. that's it. that's the vibe. remote access era 🔥

---

🌸 NAME 🌸

kw-ssh — Access remote via ssh. yes the title of the man page has that cute little dangling dash at the end, we keep it, we respect it 💖

---

💫 SYNOPSIS 💫

kw (s | ssh) [(-s | --script) <script-path>] [--verbose]
kw (s | ssh) [(-c | --command) <string-command>] [--verbose]
kw (s | ssh) [(-r | --remote) <<USER@IP>:PORT | CONFIG_HOST_NAME>] [--verbose]
kw (s | ssh) --send <from-local-path> [--to <to-remote-path>] [--verbose]
kw (s | ssh) --get <from-remote-path> [--to <to-local-path>] [--verbose]

---

🦋 DESCRIPTION 🦋

ngl the whole thing is: ssh into any machine reachable via the network. that's the assignment and it ate 💖

so, the two star players:

• --script expects a bash script as a parameter, and it gets evaluated over there on the target machine.
• --command expects a command to be executed inside the target machine.

pick your fighter, bestie 🫶

---

✨ OPTIONS ✨

• -c <string-command>, --command <string-command> — hands you a bash <string-command> and runs it remotely on the target machine. like texting your VM "hey do this" 📲
• -s <script-path>, --script <script-path> — takes the <script-path> pointing at a local script and runs it, but remotely. local script, remote era 🧚
• -r <<USER@IP>:PORT | CONFIG_HOST_NAME>, --remote <<USER@IP>:PORT | CONFIG_HOST_NAME> — uses the parameter you gave it to ssh into the target machine. you can pass a <USER@IP>:PORT situation or a CONFIG_HOST_NAME, dealer's choice 💅
• --verbose — verbose mode, aka the ✨debug vision✨ option. it makes the kw program spit out debug messages so you can track its progress. this is genuinely so useful while you're debugging, because it helps you spot possible errors way more easily. lowkey a lifesaver, no cap 😭
• --send <from-local-path> --to <to-remote-path> — transfers a file or a directory sitting at <from-local-path> over to the remote destination you named in <remote-path>. and if you don't supply --to? bestie it just sends your file or directory to the user's home folder on the remote side. it got you 🫶
• --get <from-remote-path> --to <to-local-path> — pulls a file or directory from the remote path <from-remote-path> and saves it onto your local machine at <to-local-path>. no --to given? it automatically defaults the destination directory to the current directory where you're standing. convenient queen 👑

---

🌈 EXAMPLES 🌈

for all of these, we're assuming the relevant fields in your configuration files (located by default in .kw/) are already set up. and honestly? we recommend using kw config for managing your local and global configurations. trust, it's the move 💖

once you've started your VM, you can ssh into it like:

kw s -c "dmesg -wH"
kw s

when you wanna send a file or directory to a remote machine:

kw s --send /path/to/file/or/folder --to /tmp/

when you wanna get a file or directory from a remote machine:

kw s --get /path/to/file/or/folder --to /path/to/save

---

quick vibe check 💀 this page's footer is literally the same string as its header, which is iconic in a chaotic way, so go off kw-ssh - Access remote via ssh(), we see you 👑

and that's the whole page bestie, slay 🎀🦋✨ signed off with the source line kw-ssh - Access remote via ssh() — no notes, periodt 💅