README
¶
Pin
Pin is a TUI base16 theme manager, it applies base16 themes globally using templates.
Description
Pin is a TUI base16 theme manager heavily inspired by flavours, but I wanted something more up to date with the latest Tinted Theming spec. So I built pin as a way to further learn Go.
I have only tested Pin on linux, other OS may have some issues. If you encounter any bugs or have any ideas to improve pin please create an issue and let me know, Thanks.
Alternatively feel free to open a pull request if you know how to fix an issue or just want to help out!
Installation
Install pin with Go
go install github.com/ClaraSmyth/pin@main
Or download one of the binaries Here
Built Using
Acknowledgements
- flavours - Pin is heavily inspired by flavours.
- Tinted Theming - For the base16 colour schemes
- Charm - For their great cli tools
- nap - I learned a lot from nap about using bubble tea
Config
Default Config file
# Change the default shell and any required args
DefaultShell: sh -c
# Change the default start string to search for when inserting templates
InsertStart: START_PIN_HERE
#Change the default end string to search for when inserting templates
InsertEnd: END_PIN_HERE
If you want to change where the config/data is stored by default you can do so with these env variables.
Config files: PIN_HOME
Data (cloned schemes etc.): PIN_DATA
Basic Usage/Examples
Apps
Press "n" on the App pane to create a new App
- Name - Name of the application you want to theme
- Hook - Any command you want to run after applying the theme
- Write Method - Rewrite the entire config file or insert between 2 points
- Select config file - Select the apps theme config file
Pressing "enter" to select an App will set it to active meaning themes will be applied. If you see an ✗ indicator beside an App it means it is missing either a config file or an active template.
Insert Write Method?
If you selected the insert write method you will want to wrap the lines where you want the template to be inserted in 2 comments. The first must contain the text "START_PIN_HERE" and the second must contain "END_PIN_HERE". These insert strings can be changed in the config if required.
Example
...
# START_PIN_HERE
Any lines you want pin to
overwrite with the template
# END_PIN_HERE
...
Templates
Templates are .mustache files
You can also find lots of premade templates in the Tinted Theming repo and by searching online for base16 templates.
After creating an app a default Backup template will be created for you, this is just a copy of the config file before being modified.
New templates will contain the current config file contents or the section between the 2 insert points by default. You will need to open the template and modify it by adding tags to be able to apply base16 themes to it. See the example template below for details.
Press "n" on the Template pane to create a new Templae
Press "enter" to select a template to set it as the active template for the app.
Press "o" to open the template in the default editor
Press "c" on a template to create a copy of it.
Templates named after a theme will overwrite the active template when that theme is selected. This can be useful for hard coding a config for a certain theme that you dont want to apply on all themes.
Example Template for Zellij
In this example the {{base06-hex}} tag will be replaced with the correct hex color when applying a theme.
themes {
base16 {
fg "#{{base06-hex}}"
bg "#{{base02-hex}}"
black "#{{base00-hex}}"
red "#{{base08-hex}}"
green "#{{base0D-hex}}"
yellow "#{{base0B-hex}}"
blue "#{{base0C-hex}}"
magenta "#{{base0D-hex}}"
cyan "#{{base0E-hex}}"
white "#{{base06-hex}}"
orange "#{{base0A-hex}}"
}
}
Themes
Pressing "Alt + p" on the Themes pane will fetch all the schemes from Tinted Theming. Requires git be installed
Fetching themes will overwrite any existing themes! If you want to customise a theme you should apply it then create a new theme as the current active theme will be used as a base. Custom themes will not get reset when re-fetching.
Pressing "enter" will select and apply the theme. Once applied the Apps hook will then be run.
The theme hook will be run once per theme.
An ✗ indicator means an error occured trying to apply that theme, make sure the theme is formatted correctly.
Cli
You can run also trigger a theme change using the cli by calling pin with a theme name
pin 'theme name'
Examples
Check out my dotfiles to see how I use pin - Here
License
Things to do
- Improve Error handling
- Clean up code
- Fix any existing bugs
Documentation
¶
There is no documentation for this package.
Source Files
Directories