Home
Welcome to the wiki for the Ste-Mux plugin for SwiftBar This wiki is intended to provide you with all of the information you require to get up and running with the plugin and to customise it to suit your own needs.
The wiki is not intended to teach you how to write your own custom commands beyond providing the documentation of how the plugin's helper functions work and providing worked examples for you to customise.
To install Ste-Mux, follow the steps in the Installation guide. This also includes the steps on how to uninstall Ste-Mux should you decide you do not wish to use it any longer.
Ste-Mux was primarily created to help manage tmux sessions, but it can also trigger other shell commands. Check out the Features walkthrough for details.
Ste-Mux is intended to be tailored to your own needs. While it is entirely functional out-of-the-box, it becomes so much more useful when you configure it to support the way that you want to work.
As a result, there are several guides that you may find useful. They are listed below with a brief description of what each. guide covers.
- Menus - explains the building blocks for including menu items, sub menus, and menu separators.
- Common Functions - defines the details of the helper functions available for use when creating your own custom additions to the plugin.
-
Adding Custom TMUX Entries - describes how to add your own custom
tmuxentries and what each of the included examples does. - Adding Custom Command Entries - describes how to add your own custom terminal command entries and what each of the included examples does.
- Script Metadata - describes what all of the metadata settings in the main script file do.
- Script Settings - details of what each of the settings are for in the PLIST file for the plugin.
You want more? Okay, well we have a few additional pages that might be of interest to you.
- FAQ - a list of common questions and answers about the Ste-Mux plugin.
- Change Log - a list of the changes in each release of Ste-Mux.