• homebrew (automatic updates)
  installs from the mommy tap. (requires brew.)

  brew tap fwdekker/mommy
  brew install mommy

  after installing, check the brew documentation on how to enable shell completions~
• apk (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.apk" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo apk add --allow-untrusted ./mommy-*.apk

• arch user repository (automatic updates)
  installs from the arch user repository, allowing for automatic updates. you should probably use an aur helper to do this:

  # if you use yay
  yay -S mommy
  # if you use paru
  paru -S mommy
  # if you use aura
  aura -A mommy
  # and so on

• homebrew (automatic updates)
  installs from the mommy tap. (requires brew.)

  brew tap fwdekker/mommy
  brew install mommy

  after installing, check the brew documentation on how to enable shell completions~
• pacman (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.pacman" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo pacman -U ./mommy-*.pacman

• apt ≥2.2.4 (automatic updates)
  this method requires apt v2.2.4 or newer. check your version of apt with apt -v~

  installs from the mommy apt repository. the repository supports all architectures and suites~

  sudo curl -fsSo /etc/apt/sources.list.d/mommy.sources \
    https://raw.githubusercontent.com/FWDekker/apt-mommy/main/deb/mommy.sources
  
  sudo apt update
  sudo apt install mommy

• apt <2.2.4 (automatic updates)
  this method works on all versions of apt~

  installs from the mommy apt repository. the repository supports all architectures and suites~

  check this page for details on what this code does~

  sudo mkdir -m 0755 -p /etc/apt/keyrings/
  
  curl -fsSL https://raw.githubusercontent.com/FWDekker/apt-mommy/main/deb/Release.key |
    sudo gpg --dearmor -o /etc/apt/keyrings/mommy.gpg
  
  echo "deb [signed-by=/etc/apt/keyrings/mommy.gpg] https://raw.githubusercontent.com/FWDekker/apt-mommy/main/deb/ ./" |
    sudo tee /etc/apt/sources.list.d/mommy.list > /dev/null
  
  sudo apt update
  sudo apt install mommy

• homebrew (automatic updates)
  installs from the mommy tap. (requires brew.)

  brew tap fwdekker/mommy
  brew install mommy

  after installing, check the brew documentation on how to enable shell completions~

• apt (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.deb" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo apt install ./mommy*.deb

• pkg (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.freebsd" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo pkg add ./mommy-*.freebsd

• homebrew (automatic updates)
  installs from the mommy tap. (requires brew.)

  brew tap fwdekker/mommy
  brew install mommy

  after installing, check the brew documentation on how to enable shell completions~
• pkg (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*osx\.pkg" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo installer -pkg ./mommy*+osx.pkg -target /

• pkg_add (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*netbsd\.tgz" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo pkg_add ./mommy-*+netbsd.tgz

• nix-shell (temporary)
  if you're curious but not ready for commitments, use nix-shell to temporarily install mommy:

  nix-shell -p mommy

• home-manager (persistent)
  if you use home manager, install mommy by adding the following to your home manager configuration:

  home.packages = with pkgs; [
    mommy
  ];

  you can configure mommy as follows:

  home.packages = with pkgs; [
    (mommy.override {
      mommySettings = {
        sweetie = "catgirl";
      }
    })
  ];

  check the full list of configuration options. note that your nix configuration should use lowercase variable names~

• nixos (persistent)
  install mommy by adding the following to your nixos configuration (usually in /etc/nixos/configuration.nix):

  environment.systemPackages = with pkgs; [
    mommy
  ];

  you can configure mommy as follows:

  environment.systemPackages = with pkgs; [
    (mommy.override {
      mommySettings = {
        sweetie = "catgirl";
      }
    })
  ];

  check the full list of configuration options. note that your nix configuration should use lowercase variable names~

• pkg_add (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*openbsd\.tgz" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo pkg_add -D unsigned ./mommy-*+openbsd.tgz

• dnf (copr) (automatic updates)
  installs from the copr repository. (requires the dnf-plugins-core package.)

  sudo dnf copr enable fwdekker/mommy
  sudo dnf install mommy

  packages are signed by fwdekker#[email protected], check for fingerprint E332 C8E6 ADAA 58E4 1974 7CE2 CE16 3CFF 9F79 DD8A~
• yum (copr) (automatic updates)
  installs from the copr repository. (requires the yum-plugin-core package.)

  sudo yum copr enable fwdekker/mommy
  sudo yum install mommy

  packages are signed by fwdekker#[email protected], check for fingerprint E332 C8E6 ADAA 58E4 1974 7CE2 CE16 3CFF 9F79 DD8A~
• homebrew (automatic updates)
  installs from the mommy tap. (requires brew.)

  brew tap fwdekker/mommy
  brew install mommy

  after installing, check the brew documentation on how to enable shell completions~
• dnf (github release) (manual updates)

  # download latest package from github release
  curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.rpm" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
  # install package
  sudo dnf install ./mommy-*.rpm

for git bash or cygwin, see the instructions for using mommy without a package manager~

• wsl (automatic or manual updates)
  follow any of the mommy installation instructions for your installed linux subsystem (default is ubuntu) or build mommy from source~
• msys2 (automatic or manual updates)
  follow any of the mommy installation instructions for arch linux (except do not use the arch user repository method) or build mommy from source~

if you want to customise where and how mommy installs, you can just compile her code yourself~

1. prerequisites

   • git
   • gnu make (gmake)

2. clone repository

   git clone https://github.com/FWDekker/mommy.git
   cd mommy

3. install
   this step builds mommy's files and copies them into your system. the exact paths differ per system, so find the instructions that are right for your system.

   ℹ️ note
   if you want to install mommy only for the current user, add prefix='~/.local/' before install~

   💡 tip
   check the makefile for a list of all prefix variables you can override~

   • debian/ubuntu/apt-based

     sudo make install/deb

   • freebsd

     sudo gmake install/freebsd

   • macos

     sudo gmake install/osxpkg

   • netbsd

     sudo gmake install/netbsd

   • openbsd

     sudo gmake install/openbsd

   • windows

     sudo make install

   • all other unix systems

     sudo make install

4. test (optional)
   if you want to make sure installation was successful, you can run tests using shellspec. run the following from inside the cloned mommy repository

   git clone https://github.com/shellspec/shellspec.git
   PATH="$(pwd)/shellspec/:$PATH" make system=1 test

   some tests will be skipped, depending on which other programs you have installed~

5. uninstall (optional)
   if you want to uninstall after running make install, just run the same command as in step 3, except you replace install with uninstall.

   uninstall might not work completely if you installed a different version than the one you're uninstalling. for the best results, run mommy -v, check the version number, run git checkout <the version>, and then perform the uninstallation~

if you don't want to use a package manager but also don't want to bother with makeing mommy, you can download a universal build of mommy, and play around with that. this will not install any files onto your system. if you're here because you want to install mommy only for a specific user, the "build from source and install" option is probably a better approach, though~

the script below downloads the latest stable release and extracts it for you. if you don't want to use curl, just check the latest release in your browser and download the file ending in +generic.tar.gz manually~

# download latest archive from github release
curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*generic\.tar\.gz" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
# extract archive to `mommy`
tar -C ./ -xzf mommy-*.tar.gz
# invoke mommy
./mommy/usr/bin/mommy

when mommy runs, she will first load the system-wide global config file. after that, she will read the user-specific local config file, overriding the values from the global file~

• to find the global config file, mommy runs the following procedure.
  1. mommy determines the list of global config dirs.
     1. if a list is specified using a command-line option, that list is used.
     2. otherwise, the list consists of all directories in $XDG_CONFIG_DIRS, plus /etc/mommy, plus /usr/local/etc/mommy/.
  2. mommy traverses this list, and stops once she finds a directory that contains the file config.sh. this file will be the global config file~
• to find the local config file, mommy runs the following procedure.
  1. if a config file is specified using a command-line option, that file is used.
  2. if $XDG_CONFIG_HOME is defined, the file $XDG_CONFIG_HOME/mommy/config.sh is used.
  3. otherwise, $HOME/.config/mommy/config.sh is used~

some of these settings support lists. mommy chooses a random element from each list each time she is called by you. (except for MOMMY_FORBIDDEN_WORDS and MOMMY_IGNORED_STATUSES, where mommy always considers all elements of the list.) in a list, elements are separated by a newline or by a /. elements that contain whitespace only, and elements that start with a # are ignored~

• for example, if you set

  MOMMY_SWEETIE="girl/kitten"

  then mommy will sometimes call you girl, and sometimes kitten~
• if you set

  MOMMY_CAREGIVER="mommy
  mummy/#daddy/caregiver"

  then mommy will call herself mommy, mummy, or caregiver, but not daddy~
• if you set

  MOMMY_PRONOUNS="she her her/they them their"

  then mommy may choose between mommy knows she loves her girl and mommy knows they love their girl (but not mommy knows they love her girl)~
• if you set

  MOMMY_FORBIDDEN_WORDS="cat/dog"

  then mommy will never use templates that contain cat, and will never use templates that contain dog~

you can add a list of your own compliments to either MOMMY_COMPLIMENTS or MOMMY_COMPLIMENTS_EXTRA. there is a slight difference between the two lists:

• if you want both the default and your own compliments, add your own compliments to MOMMY_COMPLIMENTS_EXTRA~
• if you want your own compliments and not the default compliments, add your own compliments to MOMMY_COMPLIMENTS~

and similarly so for encouragements~

inside compliments and encouragements, you can put placeholders that contain the random values that mommy chose. for example, if you add the compliment %%CAREGIVER%% loves you, and have MOMMY_CAREGIVER=your mommy, then mommy outputs your mommy loves you~

in bash you can set PROMPT_COMMAND to run mommy after each command. just add the following line to ~/.bashrc:

PROMPT_COMMAND="mommy -1 -s \$?; $PROMPT_COMMAND"

in fish you can have mommy output a message on the right side of your prompt by creating ~/.config/fish/functions/fish_right_prompt.fish with the following contents:

function fish_right_prompt
    mommy -1 -s $status
end

if you have an oh my fish theme installed, check the docs of your theme to see if there's an easy way to extend the theme's right prompt. if not, you can either overwrite it with the above code, or copy-paste the theme's code into your own config file and then add mommy yourself~

in nushell you can have mommy output a message on the right side of your prompt by adding the following line to your ~/.config/nushell/config.nu file:

$env.PROMPT_COMMAND_RIGHT = {|| mommy -1 -s $env.LAST_EXIT_CODE }

the exact instructions depend on how and where you installed mommy~

1. disable mommy's color output
   mommy's colors don't really work well in powershell, so you'll have to disable them~

   • wsl
     if you want to run mommy through wsl, open wsl and run

     # run this in wsl
     mkdir -p ~/.config/mommy
     echo "MOMMY_COLOR=" >> ~/.config/mommy/config.sh

   • git bash
     if you want to run mommy through git bash, run

     # run this in powershell
     [IO.Directory]::CreateDirectory("$HOME/.config/mommy")
     [IO.File]::WriteAllLines("$HOME/.config/mommy/config.sh", "MOMMY_COLOR=''")

2. test prompt
   change powershell's prompt to include mommy's message~

   • wsl
     if you want to run mommy through wsl, run

     # run this in powershell
     function prompt { "$(wsl -e mommy -1 -s $([int][bool]::Parse(!$?)))> " }

   • git bash
     if you want to run mommy through git bash, and you downloaded mommy to C:\Users\username\mommy, run

     # run this in powershell
     function prompt { "$(& "C:\Program Files\Git\bin\sh.exe" "C:/Users/username/mommy" -1 -s $([int][bool]::Parse(!$?)))> " }

3. save prompt
   now let's make this prompt persistent. in powershell, run notepad $profile to open your powershell settings, and add the function prompt [...] line from above~

   ℹ️ note
   if you get an error that this file does not exist, run new-item -itemtype file -path $profile -force to create it~

   ℹ️ note
   if you get an error that you cannot run local scripts, run Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine as admin, or sign the script~

4. improve prompt
   the instructions above show the basics of using mommy in powershell. you can make it way cooler using a theme engine like oh-my-posh. for example, you can use background colors or display mommy in the right prompt instead of the left~

depending on where you want mommy's output, the instructions are a bit different. you can either get the output above your prompt, or aligned to the right~

above the prompt
to get mommy's output on a separate line above your prompt, add the following line to ~/.zshrc:

precmd() { mommy -1 -s $? }

to the right of each command
to get mommy's output on the same line as your prompt, aligned to the right, add the following to ~/.zshrc:

set -o PROMPT_SUBST
RPS1='$(mommy -1 -s $?)'  # using single quotes here is required!

and add the following to your mommy config:

MOMMY_COLOR=""
MOMMY_PREFIX="%F{005}/%F{006}"
MOMMY_SUFFIX="~%f"

normally, mommy sets colors using standard ansi color codes, but zsh's support is a bit special, resulting in zsh miscalculating the prompt width, which looks like your prompt is misaligned or shifted. to fix this, you should disable mommy's color feature and manually set colors in the prefix option. to specify colors, use zsh's special syntax, where the numbers correspond to the xterm color codes. finally, the %f in the suffix resets the colors~

as a generic method, in any posix shell (including sh, ash, dash, bash) you can change the prompt itself to contain a message from mommy by setting the $PS1 variable:

PS1="\$(mommy -1 -s \$?)$PS1"

to improve the spacing, set MOMMY_SUFFIX="~ " in mommy's config file.

add the above line to the config file for your shell (e.g. .bashrc for bash) to apply it each time you open the shell. some shells (dash, pdksh) do not have a config file like .bashrc, but you can enable one by adding the following line to ~/.profile:

export ENV="$HOME/.shrc"

note that this will apply to all (non-login) posix shells that you open. after that, add the above-mentioned line that defines PS1 to ~/.shrc. log out and back in, and mommy will appear in your shell~

if you use any of the above integrations, you don't have to call mommy directly. if you don't want that, but also don't want to write mommy, this section explains how you can instead write, say, daddy, marija, or sinterklaas~

mommy is installed in slightly different locations on different systems, but you can easily find where mommy is installed with whereis mommy:

$ whereis mommy
mommy: /usr/bin/mommy /usr/share/man/man1/mommy.1.gz

the exact output of whereis differs depending on your system, but in this case you can see that the program is installed in /usr/bin/mommy (and the manual page in /usr/share/man/man1/mommy.1.gz). if whereis mommy doesn't work, mommy is not on your path, but you can still find her with find / -name mommy~

anyway, after finding mommy, you can just symlink using the following commands: (if whereis gave different paths than the ones above, then change these commands accordingly)

sudo ln -fs /usr/bin/mommy /usr/bin/daddy
sudo ln -fs /usr/share/man/man1/mommy.1.gz /usr/share/man/man1/daddy.1.gz

[!IMPORTANT] uninstalling mommy will not remove the manually created symlinks~

you can actually just directly run the script in src/main/sh/mommy. the only difference will be that the -h and -v options may not work correctly. if that annoys you, run make build after each change, and use build/bin/mommy instead~

1. requirements
   shellspec
2. test local code
   1. all tests

      make test

   2. unit tests

      make test/unit

   3. integration tests

      make test/integration

3. test installed code

   make system=1 test

4. configuration
   except for system=1, test behaviour is configured with environment variables. check the various files in src/test/ to find 'em all~

mommy is distributed in three ways:

• attached as binary packages to each github release,
• built on build servers,
• and available as source builds ("ports", basically) on a few servers.

let's go into them in more detail~

• 📦 binary packages
  the binary packages attached to the github release are built with the makefile. run make list to see a list of build targets; you're looking for the ones starting with dist/~

  to build the packages, you need at least gnu make, ruby, and fpm. (actually, you don't need fpm for netbsd and openbsd.) on debian-based systems, you already have gnu make, so you only need

  sudo apt install ruby
  sudo gem install fpm

  after that, just run make dist/deb (or better: mommy make dist/deb), and a .deb package will be built in dist/. run make or make list for a list of valid build targets. a special target is install, which directly copies the files into the specified directories on your system. these directories can be changed by setting prefix variables, as in make prefix=/usr/ install. i recommend running make --dry-run prefix=/usr/ install first so you can verify that all directories are calculated correctly. check the makefile for more details~

  all systems can build packages for themselves without additional dependencies beyond those noted above. if you want to compile for a different system, you may need additional dependencies. for example, if you want to build packages for alpine linux, archlinux, and rpm from a debian-like system, you will respectively need

  sudo apt install libarchive-tools rpm zstd

  and then you can run

  make dist/apk dist/pacman dist/rpm

  unfortunately, packages for macos, netbsd, and openbsd cannot be built on systems other than themselves~

• 🏗️ build servers
  build servers build mommy distributions on-demand for each release, and make the created packages available for all users. how sweet~

  • apt-mommy is a github-based apt repository that hosts mommy's .deb packages after they have been built in mommy's cd pipeline~
  • copr builds packages for fedora and epel~

• 🌱 source builds
  some servers host instructions on how to build mommy, but don't do any work beyond that. users connect to the server, get the latest instructions, and their system builds mommy for them locally~

  • for arch linux, the arch user repository hosts the mommy package. a development mirror is hosted on github in aur-mommy~
  • for homebrew, mommy has the homebrew-mommy repository on github, which is resolved automatically by the brew client based on the repository's name~

main always contains the latest stable version. to release a new version, just use the deploy action, which can be activated using a workflow_dispatch event~

release checklists

• before triggering deployment

  • update version~
  • update all changelogs~
    • update CHANGELOG.md~
      • do not leave a placeholder section for [unreleased], because it will end up like that in the .deb's changelog.gz~
      • remove empty subsections for the new release~
      • ensure no line breaks are used as whitespace; github release notes use them as actual line breaks~
    • update pkg/rpkg/mommy.spec.rpkg if changes were made to copr's rpkg packaging process~
    • update pkg/fpm/deb.changelog if changes were made to fpm's debian packaging process~
    • update pkg/fpm/rpm.changelog if changes were made to fpm's rpm packaging process~
  • update acknowledgements in README.md~
  • update promotional images in .github/img/~

• after triggering deployment

  • a new github release is created automatically~
  • aur-mommy
    • updated automatically when mommy updates
    • always manually check deployment status~
  • copr
    • updated automatically when mommy updates
    • always manually check deployment status~
  • apt-mommy
    • updated automatically when mommy updates
    • always manually check deployment status~
  • homebrew-mommy
    • updated automatically when mommy updates
    • always manually check deployment status~