A comprensive collection of fish, Nushell, and zsh dotfiles which will allow a quick and easy customization of fish or zsh on a new install or an existing system. This configuration is intended to work cross-platform betwen MacOS and Linux, although Linux compatibility will vary widely.
This solution works on the concept of symlinking dotfiles from a git repository into their respective configuration locations on the target operating system. This allows the files to be maintained in version control in a uniform way across multiple systems.
You can symlink your dotfiles from this repo into the home directory by running the installer.sh file at the root of this repository. Linking your dotfiles will first attempt to make backups of any existing dotfiles before establishing the link, but it is always recommended that some prep work be done - such as a full backup - to be confident that you won't lose anything.
- It is recommended that if you want to use the .gitconfig sample file, to make a fork of this repo and update the GitHub account info to your own in your repo. Then you can symlink your .gitconfig across environments without having to constantly update the account info.
- If you run
installer.shand the part about zsh/oh-my-zsh is not commented out, then it leaves you in zsh momentarily and you have to typeexitin order for the script to continue processing. I consider this a bug for the time being. If you exit zsh in some other way other than an orderly exit, you'll likely need to runinstaller.shagain. - If you are using the neovim configuration supplied in these dotfiles, then ignore the long list of errors on your first entry into neovim after symlinking, and remember to run
:PlugInstall
To permanently change the default shell to Fish, run the following from bash:
chsh -s $(which fish) $(whoami)
The ZSH support is rather bare-bones but it will automatically try to symlink oh-my-zsh and powerlevel10k. From there, you may wish to run the powerlevel10k via p10k configure at any time. If p10k configure is never run then you will simply have my default zsh configuration.
To permanently change the default shell to ZSH, run the following from bash:
chsh -s $(which zsh) $(whoami)
NOTE: You also need to confirm that your preferred shell is in
/etc/shells.
If you want to use p10k in zsh on Mac, you need to change the font to a nerd font. The Meslo font family is a great choice and can be changed in iTerm2 Under Preferences->Profiles->->Text->Font. After making a change to a new terminal font and using zsh, I recommend re-running p10k configure just to make sure everything is lined up.
# on Mac. Note that you may need to run `brew tap homebrew/cask-fonts` first
brew install font-meslo-lg-nerd-fontNote that iTerm2 does not have direct, intuitive support for deploying configuration files. If you go under iTerm2 -> Preferences -> Profiles and import the latest Gruvbox theme, it will automatically configure a default color scheme as well as the font.
This project includes a basic neovim configuration. If you run ./installer.sh it will automatically symlink neovim's init.vim and install vim-plug for you.
Or, if you prefer not to run the symlinking and still want to use the init.vim, remember to install vim-plug manually:
curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
Remember that after you open neovim for the first time, you will likely see errors until you run:
:PlugInstall
The following are included in init.vim with customizations:
- coc.nvim
- Nerdtree
- Airline
- Terminal support.
- .ncmpcpp music player
- mpd music server
- alacritty terminal
- sway wm config
- waybar support for sway
- kitty terminal config
It makes sense to consolidate notes on multi-platform issues in a global location such as GitHub. Hence there are several howto/readmes on several technical areas:
Dotfiles are a highly personal thing and will vary widely based on an individual, their current job role and daily workflow. I am mostly sharing these because I want to share, and I've had a lot of requests over the years for, "how did you get x,y,z to work." I fully people to use them more for ideas than as a complete solution.
The most common usage scenario for these dotfiles would be for you to fork this repo, make any tweaks to your fork as you see fit, then pull my latest changes into your fork on whatever schedule you find useful. If you make an improvement or bug fix that you would like to share please open a PR against this repo.
If you find a bug and it's obvious, please just open a PR. If you find a bug and it's not obvious or you hope for me to fix it, please use the GitHub issues feature for this branch located here: https://github.com/BlueTufa/dotfiles/issues.
I am very welcoming to feedback and I constantly learn from the community and from other peoples' approaches to these common problems. If you see something that looks odd, or is harder than it should be please let me know, and feel free to open PR's against this branch. It would be much appreciated.
A great deal of effort has been made to omit any personally identifiable information, as well as employer names, project names, user id's or even public keys.
It is possible to store secrets by adding a new suffix to any of the file types you don't want checked in. For example, create an .aliasesLocal or .exportsLocal under ~/.config/fish. These files will be detected by the fish and zsh pattern matching scheme used by this solution. But unlike the other shared dotfiles in this project, these would not be symlinked into the git repository, making them suitable for storing secrets.
If you discover anything that is of a privacy or security concern please report it immediately as it's not just my well-being but a concern of others who might fork or use these files. Use the Issue tracker or contact mailto:github@bluetufa.com. I also bothered to set up a security policy here.
Thanks for looking!