HOMESICK(1)

✨ HOMESICK ✨

okay bestie, gather round, because homesick(1) is genuinely one of the most iconic little tools ever and I need you to understand it 💖 it's a User Command, and what it does is keep your dotfiles in git. yes. your whole messy little ~ situation, version controlled, cloned around like castles. it's giving organized. it's giving put together. periodt 👑

🏰 NAME 🏰

homesick — keep your dotfile in git

like literally that's it, that's the whole vibe: your dotfiles, in git. no cap.

🌸 DESCRIPTION 🌸

okay so here's the tea. homesick works in castles — a castle is just a git repo full of your dotfiles, cloned somewhere, ready to be linked into your home dir. and then there's a whole roster of commands to boss those castles around. let's go through every single one, no skipping, I would never do that to you 🫶

💅 Commands: 💅

• homesick cd CASTLE — opens a brand new shell right in the root of the castle you named. like walking into the castle's front door and just... living there for a bit.
• homesick clone URI — clones uri as a castle for homesick. boom, new castle acquired 👑
• homesick commit CASTLE MESSAGE — commits the specified castle's changes, with your message. git commit but make it castle-flavored.
• homesick destroy CASTLE — deletes all the symlinks and removes the cloned repository. that's a full yeet, bestie 💀 nothing left, no takebacks.
• homesick diff CASTLE — shows the git diff of uncommitted changes in a castle. the receipts, if you will.
• homesick exec CASTLE COMMAND — executes a single shell command inside the root of a castle. one command, one castle, very efficient.
• homesick exec_all COMMAND — executes a single shell command inside the root of every cloned castle. all of them. every last one. the group chat gets the message fr fr.
• homesick generate PATH — generates a homesick-ready git repo at path. a fresh castle, forged from scratch ✨
• homesick help [COMMAND] — describes the available commands, or just one specific command if you're being specific about it.
• homesick link CASTLE — symlinks all the dotfiles from the specified castle. this is the moment your home dir gets its glow-up 💅
• homesick list — lists the cloned castles. roster check 🎀
• homesick open CASTLE — opens your default editor in the root of the given castle. editor time.
• homesick pull CASTLE — updates the specified castle. pull up, get current.
• homesick push CASTLE — pushes the specified castle. send it, bestie 🔥
• homesick rc CASTLE — runs the .homesickrc for the specified castle. yep, that file, exactly that name, character for character.
• homesick show_path CASTLE — prints the path of a castle. just the path. no drama, no extras.
• homesick status CASTLE — shows the git status of a castle. the vibe check, git edition 🌈
• homesick track FILE CASTLE — adds a file to a castle. file goes in, castle gets bigger.
• homesick unlink CASTLE — unsymlinks all the dotfiles from the specified castle. undoing the glow-up, respectfully.
• homesick version — displays the current version of homesick. spoiler: it's 1.1.2 and I'll get to that at the end 😌

🎀 Runtime options: 🎀

these bad boys apply across the board, so memorize them, they WILL come up:

• -f, --force — overwrite files that already exist. bold. fearless. maybe a little reckless, but we love her 💖
• -p, --pretend, --no-pretend — run but do not make any changes. a rehearsal, a dress run, a "let's see what would happen" moment. so safe, so smart. and yes, there's a --no-pretend to turn the pretending back off 🧚
• -q, --quiet, --no-quiet — suppress status output. shhh. and --no-quiet to un-shhh, obviously.
• -s, --skip, --no-skip — skip files that already exist. the polite alternative to --force. choose your fighter ⭐

heads up bestie: --force overwrites and --skip skips — those are two very different energies for the exact same problem, so pick deliberately 🙈

and that's the whole page, no crumbs left behind, I promise. every command, every flag, every placeholder, all of it 🌸

mwah, love you, go forth and organize your dotfiles 💖

this has been homesick version 1.1.2, dated February 2015 — yes she's an elder icon and she still ate 👑 🦋