Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badouralix/oh-my-via
Custom theme for ZSH
https://github.com/badouralix/oh-my-via
ecp theme via zsh zsh-theme
Last synced: about 1 month ago
JSON representation
Custom theme for ZSH
- Host: GitHub
- URL: https://github.com/badouralix/oh-my-via
- Owner: badouralix
- License: wtfpl
- Created: 2016-06-13T19:05:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-27T17:19:14.000Z (about 1 year ago)
- Last Synced: 2024-08-07T18:44:41.599Z (5 months ago)
- Topics: ecp, theme, via, zsh, zsh-theme
- Language: Shell
- Size: 47.9 KB
- Stars: 39
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VIA theme for ZSH
[](https://github.com/badouralix/oh-my-via/actions/workflows/ci.yaml)
[](https://hub.docker.com/r/badouralix/oh-my-via)
[](http://www.wtfpl.net)
This is a theme for ZSH which mainly forks the historical theme used on
[VIA Centrale Réseaux](https://via.l4th.fr/) servers. It can be used with
ZSH frameworks such as [Oh-My-ZSH](https://github.com/robbyrussell/oh-my-zsh).
- [Preview](#preview)
- [Info](#info)
- [VCS caption](#vcs-caption)
- [Usage](#usage)
- [Install for Oh-My-ZSH](#install-for-oh-my-zsh)
- [Customization](#customization)
- [Unit testing](#unit-testing)
- [License](#license)
## Preview
Test [oh-my-via](https://github.com/badouralix/oh-my-via) easily without installing it with this [docker image](https://hub.docker.com/r/badouralix/oh-my-via/) :
```bash
docker run -it --rm badouralix/oh-my-via
```
## Info
### VCS caption
| Color | State | Variable |
| :----: | :------------------------: | :---------------------------: |
| red | there are unstaged files | `OHMYVIA_VCS_COLOR_UNSTAGED` |
| yellow | there are staged files | `OHMYVIA_VCS_COLOR_STAGED` |
| blue | there are untracked files | `OHMYVIA_VCS_COLOR_UNTRACKED` |
| cyan | stash stack is not empty | `OHMYVIA_VCS_COLOR_STASH` |
| green | working directory is clean | `OHMYVIA_VCS_COLOR_CLEAN` |
## Usage
### Install for Oh-My-ZSH
Oh-My-VIA is available as an [external theme for Oh-My-ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes#oh-my-via).
In order to use this theme, you have to clone this repository in your Oh-My-ZSH
`custom/themes` directory ( usually `~/.oh-my-zsh/custom/themes` ) :
```zsh
git clone https://github.com/badouralix/oh-my-via.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/themes/oh-my-via
```
You then need to select this theme in your `~/.zshrc` :
```zsh
ZSH_THEME="oh-my-via/via"
```
### Customization
Prompt is composed of several widgets that are displayed one after the other.
#### Date and time
| Variable | Description | Default |
| :-------------------: | :------------------------------- | :----------: |
| `OHMYVIA_TIME_COLOR` | Background and foreground color. | `%B%F{cyan}` |
| `OHMYVIA_TIME_FORMAT` | Display date and time. | `%D{%H:%M}` |
#### Context ( user and hostname )
Context prompt showing `user@hostname`.
| Variable | Description | Default |
| :----------------------------------: | :------------------------------------------------------------------------------------------------ | :-------------------------------: |
| `OHMYVIA_CONTEXT_HOSTNAME` | Display hostname. Set to `partial` to print up to the first `.`. Set to `empty` to hide hostname. | `full` |
| `OHMYVIA_CONTEXT_HOSTNAME_COLOR` | Hostname background and foreground color. | `%B%F{white}` |
| `OHMYVIA_CONTEXT_HOSTNAME_COLOR_SSH` | Alternative hostname background and foreground color only applied on ssh sessions. | `$OHMYVIA_CONTEXT_HOSTNAME_COLOR` |
| `OHMYVIA_CONTEXT_SEPARATOR_COLOR` | `@` separator between the user and the hostname background and foreground color. | `%B%F{yellow}` |
| `OHMYVIA_CONTEXT_ROOT_COLOR` | Root username background and foreground color. | `%B%F{blue}` |
| `OHMYVIA_CONTEXT_USER_COLOR` | Non-root username background and foreground color. | `%B%F{red}` |
#### Working directory
| Variable | Description | Default |
| :-----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------ | :-----------: |
| `OHMYVIA_DIR_COLOR` | Background and foreground color. | `%B%F{green}` |
| `OHMYVIA_DIR_SIZE` | Number of trailing components of the current directory to show. Set to `0` to show the whole path. Set to `1` to show only the current directory. | `0` |
#### VCS theme
| Variable | Description | Default |
| :-----------------: | :-------------------------------------------------------------------- | :-------: |
| `OHMYVIA_VCS_THEME` | Git prompt theme ( see [available themes](functions/vcs_themes.zsh) ) | `default` |
## Unit testing
Oh-My-VIA uses [ZUnit](https://github.com/molovo/zunit) as unit testing framework.
To run the tests, just run:
```zsh
# Directly with zunit
zunit run tests
# Indirectly with act
act --job zunit
```
## License
Unless explicitly stated to the contrary, all contents licensed under the [WTFPL](LICENSE).