CluLo Documentation

What is CluLo?

CluLo (the tilde.Club Login) is the unofficial new MOTD / login message for tilde.club. It animates a colorful tilde.club logo without forcing you to wait for the animation to complete to begin typing. For more information, see the main webpage.

Using CluLo

Before you begin

Consult the main webpage for information on which shells are supported, and which features have been ported to which shells.

Running CluLo once

Arguments surrounded by [square brackets] are optional.

• Bash: ~sebastian/bin/motd-bash "$PS1" ["$PROMPT_COMMAND"]
• Fish: ~sebastian/bin/motd-fish
• Ksh/Mksh: ~sebastian/bin/motd-mksh
• PowerShell: /home/sebastian/bin/motd-pwsh
  • CluLo was ported to PowerShell by ~entoreor; I take no credit. Thanks! Note that tilde notation (~user) can't be used in PowerShell.
• Zsh: ~sebastian/bin/motd-zsh "$PS1" ["$(whence -f precmd)"]
• Other shells (Csh, Dash, Tcsh, Xonsh): ~sebastian/bin/motd-dash
  • Your mileage may vary depending on which shell you're running this on.

Setting CluLo up to run on login (installing)

1. Run touch ~/.hushlogin to silence the old official prompt if you haven't already.
2. Copy the script corresponding to your shell to a directory that you control. This is strongly recommended for security reasons, as you shouldn't let a script that another user has full control over run everytime you login. To do this, run cp ~sebastian/bin/motd-shell ~/bin, replacing motd-shell with the script corresponding to the shell that you use.
3. Put the script into a file that runs on login. This step will vary depending on your shell. Arguments surrounded by [square brackets] are optional.
   • Bash: In ~/.bash_profile, put ~/bin/motd-bash "$PS1" ["$PROMPT_COMMAND"] [--no-update-check]
   • Csh, Tcsh: In ~/.login, put ~/bin/motd-dash
   • Fish: In ~/.config/fish/config.fish, put status --is-login; and ~/bin/motd-fish
   • Ksh, Mksh, Dash: In ~/.profile, put ~/bin/motd-shell, replacing -motd-shell with the script corresponding to the shell you use
   • Zsh: In ~/.zprofile, put ~/bin/motd-zsh "$PS1" ["$(whence -f precmd)"] [--no-update-check]
4. Test if it works by logging out of the ssh/mosh session and logging back in.

Removing CluLo (uninstalling)

1. Perform the opposite of step 3 of setting CluLo up. That is, remove the line from the file corresponding to the shell that you use.
2. Optionally, you can delete the script with rm ~/bin/motd-*
3. If you wish to re-enable the old official MOTD, run rm ~/.hushlogin

Updates (Bash and Zsh)

Update Checking

Everytime CluLo runs, it will automatically check for updates by comparing the version number on line two of the local file to the version number of line two of the stock copy in ~sebastian/bin/. If there is an update available, CluLo displays an update notice as part of the message. To suppress this automatic update checking, pass the flag --no-update-check as the last argument.

Updating

For security reasons, CluLo will never automatically update. Updates are always to be done manually by the user. To update CluLo, run motd-shell -u, replacing motd-shell with either motd-bash or motd-zsh, depending on your shell.

This launches the update menu, where you have five options:

1. Overwrite current version with new version
2. Backup current version and copy over new version
   • Update using this option if you've made your own modifications to the script, to prevent the risk of something breaking. The current version is backed up to motd-shell.bak.
3. View source code of new version in editor
4. Compare source code of old and new versions using diff in editor
5. Cancel (don't update)

Updating is a straight-forward process, and you hopefully shouldn't run in to any trouble.

Reporting bugs

~sebastian is the creator and maintainer of CluLo. To contact me, email sebastian@tilde.club or message sebastian on the tilde.chat IRC network.

License

All versions of CluLo (all motd-* scripts in ~sebastian/bin, as well as the MOTD text modified from tildeclub/motd are free software licensed under the GNU General Public License version 3 (only). You can read the license here.