Installation

Prerequisites

As a plugin for SwiftBar, you should first ensure that you have SwiftBar installed on your Mac.

• SwiftBar

The ste-mux plugin has no other prerequisites that are not supported by default in recent versions of macOS.

Installation Instructions

1. From SwiftBar, select the option to Open Plugin Folder.
2. Create a folder called ste-mux in the plugin folder.
3. Copy the contents of the ste-mux folder in the GitHub repo to the local plugin folder.
   • The files you to be copied across include.
     • ste-mux.10s.sh - The main script file.
     • .ste-mux-functions.sh - A file containing some functions used by the scripts.
     • .ste-mux-tmux-custom.sh - A file containing some example TMUX commands.
     • .ste-mux-custom.sh - A file containing some example shell commands.

Notes

• Several of the file names begin with a period ("."). This will mean that when you copy them to your Mac, they will be hidden, unless you have Finder or your file management app of choice set to show hidden files. The files are purposefully set as hidden to stop SwiftBar identifying them as other plugins.
• The main script includes .10s as a portion of the name. This relates to the frequency that SwiftBar will refresh the plugin. This frequency can be changed and the plugin should continue to work.

Update Instructions

Please ensure you also read the notes section below prior to updating, and always consider backing up any files that may be changed asa a result of the following process.

1. From SwiftBar, select the option to Open Plugin Folder.
2. Navigate to ste-mux in the plugin folder.
3. Copy the following files in the ste-mux folder in the GitHub repo to the local plugin folder, overwriting the existing files.
   • ste-mux.10s.sh - The main script file.
   • .ste-mux-functions.sh - A file containing some functions used by the scripts.

Notes

• The .ste-mux-*custom.sh files can also be copied, but if you have updated your own copies of these files, you should first back them up, and you would need to manually reconcile any differences you may wish to retain.
• The ste-mux.10s.sh file may need to be renamed once again if you have previously set a refresh period other than every 10 seconds by amending the file name.
• The ste-mux.10s.sh and .ste-mux-functions.sh are not generally intended to be maintained by end users (though some users may choose to change some of the Script Metadata in the ste-mux.10s.sh file for example). If you have modified these, then please note any updates will need to be reconciled to ensure any changes you wish to retain are merged into the updated file(s).

Uninstallation Instructions

1. From SwiftBar, select the option to Open Plugin Folder.
2. Delete the folder called ste-mux in the plugin folder.

For good measure, restarting the SwiftBar app only takes a few moments and ensures all resources are freed up, etc.