Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tinted-theming/base16-shell-legacy
Base16 for Shells
https://github.com/tinted-theming/base16-shell-legacy
base16 base16-theme bash fish shell theme zsh
Last synced: about 2 months ago
JSON representation
Base16 for Shells
- Host: GitHub
- URL: https://github.com/tinted-theming/base16-shell-legacy
- Owner: tinted-theming
- License: other
- Archived: true
- Created: 2021-01-16T12:24:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-30T18:13:19.000Z (about 2 years ago)
- Last Synced: 2024-06-10T00:38:42.441Z (3 months ago)
- Topics: base16, base16-theme, bash, fish, shell, theme, zsh
- Language: Shell
- Homepage: https://github.com/base16-project/base16
- Size: 865 KB
- Stars: 21
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Base16 Shell
See the [Base16 repository][1] for more information.
A shell script to change your shell's default ANSI colors but most
importantly, colors 17 to 21 of your shell's 256 colorspace (if
supported by your terminal). This script makes it possible to honor the
original bright colors of your shell (e.g. bright green is still green
and so on) while providing additional base16 colors to applications such
as Vim and tmux.
![Base16 Shell][8]
## Use Cases
- You want to use a `*.256.*` variant of a Terminal theme designed to
honor the original bright colors.
- You prefer to use a script instead of a terminal emulator theme to
color your shell.
- You use this script to have different colorschemes appear on different
SSH sessions.
## Installation
```shell
git clone https://github.com/base16-project/base16-shell.git \
$HOME/.config/base16-shell
```
### Bash/ZSH
Add following lines to `.bashrc` or `.zshrc`:
```bash
# Base16 Shell
BASE16_SHELL_PATH="$HOME/.config/base16-shell"
[ -n "$PS1" ] && \
[ -s "$BASE16_SHELL_PATH/profile_helper.sh" ] && \
source "$BASE16_SHELL_PATH/profile_helper.sh"
```
### Oh my zsh
```bash
mkdir $HOME/.oh-my-zsh/plugins/base16-shell
ln -s $HOME/.config/base16-shell/base16-shell.plugin.zsh \
$HOME/.oh-my-zsh/plugins/base16-shell/base16-shell.plugin.zsh
```
To use it, add `base16-shell` to the plugins array in your `.zshrc` file:
`plugins=(... base16-shell)`
### Fish
Add following lines to `$HOME/.config/fish/config.fish`:
```fish
# Base16 Shell
if status --is-interactive
set BASE16_SHELL_PATH "$HOME/.config/base16-shell"
source "$BASE16_SHELL_PATH/profile_helper.fish"
end
```
## Configuration
### Base16-Vim Users
#### Vim
The `BASE16_THEME` environment variable will set to your current
colorscheme. You can set the [base16-vim][2] colorscheme to the
`BASE16_THEME` environment variable by adding the following to your
`.vimrc`:
```vim
if exists('$BASE16_THEME')
\ && (!exists('g:colors_name')
\ || g:colors_name != 'base16-$BASE16_THEME')
let base16colorspace=256
colorscheme base16-$BASE16_THEME
endif
```
Remove the `base16colorspace` line if it is not needed.
#### Neovim
If you have a lua neovim config, add the following to your `init.lua`:
```lua
local cmd = vim.cmd
local g = vim.g
local base16_project_theme = os.getenv('BASE16_THEME')
if base16_project_theme and g.colors_name ~= 'base16-'..base16_project_theme then
cmd('let base16colorspace=256')
cmd('colorscheme base16-'..base16_project_theme)
end
```
### Base16-Tmux Users
This section is for [base16-tmux][3] users. base16-shell will update (or
create) the `$HOME/.config/base16-project/tmux.base16.conf` file and
set the colorscheme. You need to source this file in your `.tmux.conf`.
You can do this by adding the following to your `.tmux.conf`:
```
source-file $HOME/.config/base16-project/tmux.base16.conf
```
Make sure to reload your `.tmux.conf` file after the theme has been
updated through `profile_helper`.
### Keeping your themes up to date
To update, just `git pull` wherever you've cloned `base16-shell`. The
themes are updated on a weekly basis thanks to GitHub Actions. See the
GitHub Actions workflow in [`.github/workflows/update.yml`][6].
### Default theme
You can set the `$BASE16_THEME_DEFAULT` environment variable to the name
of a theme and it will use that theme if there is no theme currently
set. This can be useful for when you're using your dotfiles in a brand
new environment and you don't want to manually set the theme for the
first time.
For example: `$BASE16_THEME_DEFAULT="solarized-light"`
## Usage
Open a new shell and type `base16` followed by a tab to perform tab
completion.
## Troubleshooting
Run the included **colortest** script and check that your colour
assignments appear correct. If your teminal does not support the setting
of colours in within the 256 colorspace (e.g. Apple Terminal), colours
17 to 21 will appear blue.
![setting 256 colourspace not supported][9]
If **colortest** is run without any arguments e.g. `./colortest` the hex
values shown will correspond to the default scheme. If you'd like to see
the hex values for a particular scheme pass the file name of the theme
as the arguement e.g. `./colortest base16-ocean.sh`.
### Inverted blacks and whites
This is the expected behaviour when using a light theme:
https://github.com/base16-project/base16-shell/issues/150
## Contributing
See [`CONTRIBUTING.md`][7], which contains building and contributing
instructions.
[1]: https://github.com/base16-project/base16
[2]: https://github.com/base16-project/base16-vim
[3]: https://github.com/mattdavis90/base16-tmux
[4]: https://github.com/base16-project/base16-builder-go
[5]: https://formulae.brew.sh
[6]: .github/workflows/update.yml
[7]: CONTRIBUTING.md
[8]: screenshots/base16-shell.png
[9]: screenshots/setting-256-colourspace-not-supported.png