aurora/shinkansen.zsh-theme
1
0 Fork 0
mirror of https://github.com/MRZ07/shinkansen.zsh-theme.git synced 2026-10-06 12:45:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update Documentation

Browse Source
This commit is contained in:
Mustafa Rasheed committed 2022-07-24 05:13:05 +02:00
1 parent 73ed52d9be
commit 82db53d643
18 files changed
+161 -261
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

LICENSE
+1 -1
View File
@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2016 Caio Gondim
Copyright (c) 2022 Mustafa Rasheed
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
README.md
+159 -235
View File
@@ -1,57 +1,56 @@
<img src="http://rawgit.com/caiogondim/bullet-train-oh-my-zsh-theme/master/img/icon.svg" width="100%" />
<p align="center">
<img src="https://raw.githubusercontent.com/MRZ07/shinkansen.zsh-theme/main/img/shinkansen-icon.png" width="50%" />
</p>
<p align="center">
Shinkansen is a fast, customizable and easily expandable terminal theme
</p>
# Bullet Train for oh-my-zsh <a href="http://webchat.freenode.net/?channels=bullettrain-sh" target="_blank"><img src="https://img.shields.io/badge/IRC-bullettrain–sh-1e72ff.svg?style=flat" height="20"></a>
![Preview](http://raw.github.com/MRZ07/shinkansen.zsh-theme/master/img/preview.gif)
Bullet Train is a [oh-my-zsh shell](https://github.com/robbyrussell/oh-my-zsh)
theme based on the
[Powerline Vim plugin](https://github.com/Lokaltog/vim-powerline). It aims for
simplicity, showing information only when it's relevant.
## Features
It currently shows:
- Current Python virtualenv; when using Pyenv and no active virtualenv shows the current Python version the shell uses
- Current Python version when using virtualenv otherwise the installed version
- Current Ruby version using chruby; version and gemset when on RVM or Rbenv
- Current Node.js version, through NVM (if present) or Node.js
- Current Node.js version
- Current Java version
- Current Go version
- Current Perl version using plenv
- Current Elixir version
- Git status
- Timestamp
- Time in 12h or 24h format
- Current directory
- Background jobs
- Custom Message
- Exit code of last command
- Execution time of command
If you want add some new feature, of fix some bug, open an issue and lets hack
together.
For a tmux theme to work with it, I suggest [Maglev](https://github.com/caiogondim/maglev).
## Preview
![Preview](http://raw.github.com/caiogondim/bullet-train-oh-my-zsh-theme/master/img/preview.gif)
And much more...
If you want add some new feature, of fix some bug, open an issue and lets hack together.
## Requirements
In order to use the theme, you will first need:
* Powerline compatible fonts like [Vim Powerline patched fonts](https://github.com/Lokaltog/powerline-fonts), [Input Mono](http://input.fontbureau.com/) or [Monoid](http://larsenwork.com/monoid/).
* On Ubuntu like systems you'll need the `ttf-ancient-fonts` package to correctly display some unicode symbols that are not covered by the Powerline fonts above.
* A ZSH framework like [antigen](https://github.com/zsh-users/antigen), [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) or [zgen](https://github.com/tarjoilija/zgen)
* Make sure terminal is using 256-colors mode with `export TERM="xterm-256color"`
* For [iTerm 2](http://iterm2.com/) users, make sure you go into your settings and set both the regular font and the non-ascii font to powerline compatible [fonts](https://github.com/powerline/fonts) or the prompt separators and special characters will not display correctly.
- Powerline compatible fonts
- On Ubuntu like systems you'll need the `ttf-ancient-fonts` package to correctly display some unicode symbols that are not covered by the Powerline fonts above.
- A ZSH framework like, [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh), [antigen](https://github.com/zsh-users/antigen) or [zgen](https://github.com/tarjoilija/zgen)
- Make sure terminal is using 256-colors mode with `export TERM="xterm-256color"`
- For [iTerm 2](http://iterm2.com/) users, make sure you go into your settings and set both the regular font and the non-ascii font to powerline compatible [fonts](https://github.com/powerline/fonts) or the prompt separators and special characters will not display correctly.
## Installing
### For oh-my-zsh users
1. Download the theme [here](http://raw.github.com/caiogondim/bullet-train-oh-my-zsh-theme/master/bullet-train.zsh-theme)
1. Download the theme [here](http://raw.github.com/MRZ07/shinkansen.zsh-theme/master/shinkansen.zsh-theme)
2. Put the file **bullet-train.zsh-theme** in **$ZSH_CUSTOM/themes/**
2. Put the file **shinkansen.zsh-theme** in **$ZSH_CUSTOM/themes/**
3. Configure the theme in your **~/.zshrc** file:
```bash
ZSH_THEME="bullet-train"
ZSH_THEME="shinkansen"
```
### For antigen users
@@ -60,7 +59,7 @@ Add the following snippet to your **.zshrc** somewhere after the line
`antigen use oh-my-zsh`.
```bash
antigen theme https://github.com/caiogondim/bullet-train-oh-my-zsh-theme bullet-train
antigen theme https://github.com/MRZ07/shinkansen.zsh-theme shinkansen
```
### For Zgen users
@@ -68,7 +67,7 @@ antigen theme https://github.com/caiogondim/bullet-train-oh-my-zsh-theme bullet-
If you're using [zgen](https://github.com/tarjoilija/zgen), add the following line to your **~/.zshrc** where you're adding your other zsh plugins **after** the line `zgen oh-my-zsh`.
```bash
zgen load caiogondim/bullet-train-oh-my-zsh-theme bullet-train
zgen load mrz07/shinkansen.zsh-theme shinkansen
```
### For Zplug users
@@ -78,20 +77,21 @@ to your **~/.zshrc** where you're adding your other zsh plugins.
```bash
setopt prompt_subst # Make sure prompt is able to be generated properly.
zplug "caiogondim/bullet-train.zsh", use:bullet-train.zsh-theme, defer:3 # defer until other plugins like oh-my-zsh is loaded
zplug "mrz07/shinkansen.zsh", use:shinkansen.zsh-theme, defer:3 # defer until other plugins like oh-my-zsh is loaded
```
## Options
Bullet Train is configurable. You can change colors and which segments you want
Shinkansen is configurable. You can change colors and which segments you want
or don't want to see. All options must be overridden in your **.zshrc** file.
### Order
`BULLETTRAIN_PROMPT_ORDER` defines order of prompt segments. Use zsh array
`SHINKANSEN_PROMPT_ORDER` defines order of prompt segments. Use zsh array
syntax to specify your own order, e.g:
```bash
BULLETTRAIN_PROMPT_ORDER=(
SHINKANSEN_PROMPT_ORDER=(
git
context
dir
@@ -99,268 +99,192 @@ BULLETTRAIN_PROMPT_ORDER=(
)
```
NOTE: You do not need to specify *end* segment - it will be added automatically. With this you can also specify custom segments.
NOTE: You do not need to specify _end_ segment - it will be added automatically. With this you can also specify custom segments.
### Prompt
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_PROMPT_CHAR`|`\$`|Character to be show before any command
|`BULLETTRAIN_PROMPT_ROOT`|`true`|Highlight if running as root
|`BULLETTRAIN_PROMPT_SEPARATE_LINE`|`true`|Make the prompt span across two lines
|`BULLETTRAIN_PROMPT_ADD_NEWLINE`|`true`|Adds a newline character before each prompt line
| Variable | Default | Meaning |
| --------------------------------- | ------- | ------------------------------------------------ |
| `SHINKANSEN_PROMPT_CHAR` | `\$` | Character to be show before any command |
| `SHINKANSEN_PROMPT_ROOT` | `true` | Highlight if running as root |
| `SHINKANSEN_PROMPT_SEPARATE_LINE` | `true` | Make the prompt span across two lines |
| `SHINKANSEN_PROMPT_ADD_NEWLINE` | `true` | Adds a newline character before each prompt line |
### Status
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_STATUS_EXIT_SHOW`|`false`|Show/hide exit code of last command
|`BULLETTRAIN_STATUS_BG`|`green`|Background color
|`BULLETTRAIN_STATUS_ERROR_BG`|`red`|Background color of segment when last command exited with an error
|`BULLETTRAIN_STATUS_FG`|`black`|Foreground color
| Variable | Default | Meaning |
| ----------------------------- | ------- | ------------------------------------------------------------------ |
| `SHINKANSEN_STATUS_EXIT_SHOW` | `false` | Show/hide exit code of last command |
| `SHINKANSEN_STATUS_BG` | `green` | Background color |
| `SHINKANSEN_STATUS_ERROR_BG` | `red` | Background color of segment when last command exited with an error |
| `SHINKANSEN_STATUS_FG` | `black` | Foreground color |
### Time
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_TIME_12HR`|`false`|Format time using 12-hour clock (am/pm)
|`BULLETTRAIN_TIME_BG`|`white`|Background color
|`BULLETTRAIN_TIME_FG`|`black`|Foreground color
| Variable | Default | Meaning |
| ---------------------- | ------- | --------------------------------------- |
| `SHINKANSEN_TIME_12HR` | `false` | Format time using 12-hour clock (am/pm) |
| `SHINKANSEN_TIME_BG` | `white` | Background color |
| `SHINKANSEN_TIME_FG` | `black` | Foreground color |
### Custom
### Custom Message
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_CUSTOM_MSG`|`false`|Free segment you can put a custom message which will be eval'ed for every prompt
|`BULLETTRAIN_CUSTOM_BG`|`black`|Background color
|`BULLETTRAIN_CUSTOM_FG`|`default`|Foreground color
| Variable | Default | Meaning |
| ----------------------- | --------- | -------------------------------------------------------------------------------- |
| `SHINKANSEN_CUSTOM_MSG` | `false` | Free segment you can put a custom message which will be eval'ed for every prompt |
| `SHINKANSEN_CUSTOM_BG` | `black` | Background color |
| `SHINKANSEN_CUSTOM_FG` | `default` | Foreground color |
### Context
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_CONTEXT_BG`|`black`|Background color
|`BULLETTRAIN_CONTEXT_FG`|`default`|Foreground color
|`BULLETTRAIN_CONTEXT_DEFAULT_USER`|none|Default user. If you are running with other user other than default, the segment will be showed.
|`BULLETTRAIN_CONTEXT_HOSTNAME`|`%m`|Hostname. Set %M to display the full qualified domain name.
|`BULLETTRAIN_IS_SSH_CLIENT`|none|If `true`, the segment will be showed.
| Variable | Default | Meaning |
| --------------------------------- | --------- | ------------------------------------------------------------------------------------------------ |
| `SHINKANSEN_CONTEXT_BG` | `black` | Background color |
| `SHINKANSEN_CONTEXT_FG` | `default` | Foreground color |
| `SHINKANSEN_CONTEXT_DEFAULT_USER` | none | Default user. If you are running with other user other than default, the segment will be showed. |
| `SHINKANSEN_CONTEXT_HOSTNAME` | `%m` | Hostname. Set %M to display the full qualified domain name. |
| `SHINKANSEN_IS_SSH_CLIENT` | none | If `true`, the segment will be showed. |
### Python virtualenv (+Pyenv)
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_VIRTUALENV_BG`|`yellow`|Background color
|`BULLETTRAIN_VIRTUALENV_FG`|`white`|Foreground color
|`BULLETTRAIN_VIRTUALENV_PREFIX`|`🐍`|Prefix of the segment
| Variable | Default | Meaning |
| ------------------------------ | -------- | --------------------- |
| `SHINKANSEN_VIRTUALENV_BG` | `yellow` | Background color |
| `SHINKANSEN_VIRTUALENV_FG` | `white` | Foreground color |
| `SHINKANSEN_VIRTUALENV_PREFIX` | `🐍` | Prefix of the segment |
### node.js nvm
### node.js
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_NVM_BG`|`green`|Background color
|`BULLETTRAIN_NVM_FG`|`white`|Foreground color
|`BULLETTRAIN_NVM_PREFIX`|`"⬡ "`|Prefix of the segment
| Variable | Default | Meaning |
| ----------------------- | ------- | --------------------- |
| `SHINKANSEN_NVM_BG` | `green` | Background color |
| `SHINKANSEN_NVM_FG` | `white` | Foreground color |
| `SHINKANSEN_NVM_PREFIX` | `"⬡ "` | Prefix of the segment |
### Java
| Variable | Default | Meaning |
| ------------------------ | -------- | --------------------- |
| `SHINKANSEN_JAVA_BG` | `black` | Background color |
| `SHINKANSEN_JAVA_FG` | `red` | Foreground color |
| `SHINKANSEN_JAVA_PREFIX` | `"☕️ "` | Prefix of the segment |
### Ruby RVM/Rbenv
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_RUBY_BG`|`magenta`|Background color
|`BULLETTRAIN_RUBY_FG`|`white`|Foreground color
|`BULLETTRAIN_RUBY_PREFIX`|`"♦"`|Prefix of the segment
| Variable | Default | Meaning |
| ------------------------ | --------- | --------------------- |
| `SHINKANSEN_RUBY_BG` | `magenta` | Background color |
| `SHINKANSEN_RUBY_FG` | `white` | Foreground color |
| `SHINKANSEN_RUBY_PREFIX` | `"♦"` | Prefix of the segment |
### Elixir
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_ELIXIR_BG`|`magenta`|Background color
|`BULLETTRAIN_ELIXIR_FG`|`white`|Foreground color
|`BULLETTRAIN_ELIXIR_PREFIX`|`"💧"`|Prefix of the segment
| Variable | Default | Meaning |
| -------------------------- | --------- | --------------------- |
| `SHINKANSEN_ELIXIR_BG` | `magenta` | Background color |
| `SHINKANSEN_ELIXIR_FG` | `white` | Foreground color |
| `SHINKANSEN_ELIXIR_PREFIX` | `"💧"` | Prefix of the segment |
### Go
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_GO_BG`|`green`|Background color
|`BULLETTRAIN_GO_FG`|`white`|Foreground color
|`BULLETTRAIN_GO_PREFIX`|`go`|Prefix of the segment
| Variable | Default | Meaning |
| ---------------------- | ------- | --------------------- |
| `SHINKANSEN_GO_BG` | `green` | Background color |
| `SHINKANSEN_GO_FG` | `white` | Foreground color |
| `SHINKANSEN_GO_PREFIX` | `🦦` | Prefix of the segment |
### Kubernetes Context
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_KCTX_BG`|`yellow`|Background color
|`BULLETTRAIN_KCTX_FG`|`white`|Foreground color
|`BULLETTRAIN_KCTX_PREFIX`|`⎈`|[Kubernetes](https://unicode-table.com/de/2388/) prefix of the segment
|`BULLETTRAIN_KCTX_KUBECTL`|`true`|If `false` disable `kubectl` usage
|`BULLETTRAIN_KCTX_NAMESPACE`|`true`|If `false` will not show the default namespace. Namespace is only visible if `kubectl` is installed
|`BULLETTRAIN_KCTX_KCONFIG`|`${HOME}/.kube/config`|Location of kube config file (e.g. /Users/Hugo/.kube/config)
| Variable | Default | Meaning |
| --------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------- |
| `SHINKANSEN_KCTX_BG` | `yellow` | Background color |
| `SHINKANSEN_KCTX_FG` | `white` | Foreground color |
| `SHINKANSEN_KCTX_PREFIX` | `⎈` | [Kubernetes](https://unicode-table.com/de/2388/) prefix of the segment |
| `SHINKANSEN_KCTX_KUBECTL` | `true` | If `false` disable `kubectl` usage |
| `SHINKANSEN_KCTX_NAMESPACE` | `true` | If `false` will not show the default namespace. Namespace is only visible if `kubectl` is installed |
| `SHINKANSEN_KCTX_KCONFIG` | `${HOME}/.kube/config` | Location of kube config file (e.g. /Users/Hugo/.kube/config) |
The prompt will first check if `BULLETTRAIN_KCTX_KUBECTL=true` and `kubectl` is installed than it will use `kubectl config view --minify` to determine the context and default namespace in use.
If `BULLETTRAIN_KCTX_KUBECTL=false` or `kubectl` is not installed, `BULLETTRAIN_KCTX_KCONFIG` will be parsed to get the current context.
The prompt will first check if `SHINKANSEN_KCTX_KUBECTL=true` and `kubectl` is installed than it will use `kubectl config view --minify` to determine the context and default namespace in use.
If `SHINKANSEN_KCTX_KUBECTL=false` or `kubectl` is not installed, `SHINKANSEN_KCTX_KCONFIG` will be parsed to get the current context.
The usage of `kubectl` allow the prompt to get the default namespace even if you are using multiple kube config files (e.g. KUBECONFIG=~/.kube/config:path-to-config1:path-to-config2)
### AWS Profile
Displays which AWS (Amazon Web Services) credentials profile is currently set.
This environment var is used by aws-cli and other tools to use the right access keys and other parameters.
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_AWS_BG`|`yellow`|Background color
|`BULLETTRAIN_AWS_FG`|`black`|Foreground color
|`BULLETTRAIN_AWS_PREFIX`|`☁️`|Prefix of the segment
| Variable | Default | Meaning |
| ----------------------- | -------- | --------------------- |
| `SHINKANSEN_AWS_BG` | `yellow` | Background color |
| `SHINKANSEN_AWS_FG` | `black` | Foreground color |
| `SHINKANSEN_AWS_PREFIX` | `☁️` | Prefix of the segment |
### Perl
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_PERL_BG`|`yellow`|Background color
|`BULLETTRAIN_PERL_FG`|`black`|Foreground color
|`BULLETTRAIN_PERL_PREFIX`|`🐪`|Prefix of the segment
| Variable | Default | Meaning |
| ------------------------ | -------- | --------------------- |
| `SHINKANSEN_PERL_BG` | `yellow` | Background color |
| `SHINKANSEN_PERL_FG` | `black` | Foreground color |
| `SHINKANSEN_PERL_PREFIX` | `🐪` | Prefix of the segment |
### Dir
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_DIR_BG`|`blue`|Background color
|`BULLETTRAIN_DIR_FG`|`white`|Foreground color
|`BULLETTRAIN_DIR_CONTEXT_SHOW`|`false`|Show user and machine in an SCP formatted style
|`BULLETTRAIN_DIR_EXTENDED`|`1`|Extended path (0=short path, 1=medium path, 2=complete path, everything else=medium path)
| Variable | Default | Meaning |
| ----------------------------- | ------- | ----------------------------------------------------------------------------------------- |
| `SHINKANSEN_DIR_BG` | `blue` | Background color |
| `SHINKANSEN_DIR_FG` | `white` | Foreground color |
| `SHINKANSEN_DIR_CONTEXT_SHOW` | `false` | Show user and machine in an SCP formatted style |
| `SHINKANSEN_DIR_EXTENDED` | `1` | Extended path (0=short path, 1=medium path, 2=complete path, everything else=medium path) |
### Git
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_GIT_COLORIZE_DIRTY`|`false`|Set `BULLETTRAIN_GIT_BG` to `BULLETTRAIN_GIT_COLORIZE_DIRTY_COLOR` in dirty state
|`BULLETTRAIN_GIT_COLORIZE_DIRTY_BG_COLOR`|`yellow`|`BULLETTRAIN_GIT_BG` in dirty state
|`BULLETTRAIN_GIT_COLORIZE_DIRTY_FG_COLOR`|`black`|`BULLETTRAIN_GIT_FG` in dirty state
|`BULLETTRAIN_GIT_BG`|`white`|Background color
|`BULLETTRAIN_GIT_FG`|`black`|Foreground color
|`BULLETTRAIN_GIT_PROMPT_CMD`|`git_prompt_info`|Function to display details about your git segment.
|`BULLETTRAIN_GIT_EXTENDED`|`true`|
|`BULLETTRAIN_GIT_PREFIX`|`""`|Prefix
|`BULLETTRAIN_GIT_SUFFIX`|`""`|Suffix
|`BULLETTRAIN_GIT_DIRTY`|`"✘"`|Icon for dirty state
|`BULLETTRAIN_GIT_CLEAN`|`"✔"`|Icon for clean state
|`BULLETTRAIN_GIT_ADDED`|`"%F{green}✚%F{black}"`|Icon for added files on stage
|`BULLETTRAIN_GIT_MODIFIED`|`"%F{blue}✹%F{black}"`|Icon for modified files
|`BULLETTRAIN_GIT_DELETED`|`"%F{red}✖%F{black}"`|Icon for delete files on stage
|`BULLETTRAIN_GIT_UNTRACKED`|`"%F{yellow}✭%F{black}"`|Icon for untracked files
|`BULLETTRAIN_GIT_RENAMED`|`"➜"`|Icon for renamed
|`BULLETTRAIN_GIT_UNMERGED`|`"═"`|Icon for unmerged state
|`BULLETTRAIN_GIT_AHEAD`|`" ⬆"`|Icon for ahead state from remote
|`BULLETTRAIN_GIT_BEHIND`|`" ⬇"`|Icon for behind state from remote
|`BULLETTRAIN_GIT_DIVERGED`|`" ⬍"`|Icon for diverged state from remote
| Variable | Default | Meaning |
| ---------------------------------------- | ------------------------ | ------------------------------------------------------------------------------- |
| `SHINKANSEN_GIT_COLORIZE_DIRTY` | `false` | Set `SHINKANSEN_GIT_BG` to `SHINKANSEN_GIT_COLORIZE_DIRTY_COLOR` in dirty state |
| `SHINKANSEN_GIT_COLORIZE_DIRTY_BG_COLOR` | `yellow` | `SHINKANSEN_GIT_BG` in dirty state |
| `SHINKANSEN_GIT_COLORIZE_DIRTY_FG_COLOR` | `black` | `SHINKANSEN_GIT_FG` in dirty state |
| `SHINKANSEN_GIT_BG` | `white` | Background color |
| `SHINKANSEN_GIT_FG` | `black` | Foreground color |
| `SHINKANSEN_GIT_PROMPT_CMD` | `git_prompt_info` | Function to display details about your git segment. |
| `SHINKANSEN_GIT_EXTENDED` | `true` |
| `SHINKANSEN_GIT_PREFIX` | `""` | Prefix |
| `SHINKANSEN_GIT_SUFFIX` | `""` | Suffix |
| `SHINKANSEN_GIT_DIRTY` | `"✘"` | Icon for dirty state |
| `SHINKANSEN_GIT_CLEAN` | `"✔"` | Icon for clean state |
| `SHINKANSEN_GIT_ADDED` | `"%F{green}✚%F{black}"` | Icon for added files on stage |
| `SHINKANSEN_GIT_MODIFIED` | `"%F{blue}✹%F{black}"` | Icon for modified files |
| `SHINKANSEN_GIT_DELETED` | `"%F{red}✖%F{black}"` | Icon for delete files on stage |
| `SHINKANSEN_GIT_UNTRACKED` | `"%F{yellow}✭%F{black}"` | Icon for untracked files |
| `SHINKANSEN_GIT_RENAMED` | `"➜"` | Icon for renamed |
| `SHINKANSEN_GIT_UNMERGED` | `"═"` | Icon for unmerged state |
| `SHINKANSEN_GIT_AHEAD` | `" ⬆"` | Icon for ahead state from remote |
| `SHINKANSEN_GIT_BEHIND` | `" ⬇"` | Icon for behind state from remote |
| `SHINKANSEN_GIT_DIVERGED` | `" ⬍"` | Icon for diverged state from remote |
The git prompt can be disabled for a specific repository by setting a git config flag: `git config oh-my-zsh.hide-status 1`. This is useful to avoid performance issues for particularly huge repositories.
### Screen
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_SCREEN_BG`|`white`|Background color
|`BULLETTRAIN_SCREEN_FG`|`black`|Foreground color
|`BULLETTRAIN_SCREEN_PREFIX`|`⬗`|Prefix of the segment
| Variable | Default | Meaning |
| -------------------------- | ------- | --------------------- |
| `SHINKANSEN_SCREEN_BG` | `white` | Background color |
| `SHINKANSEN_SCREEN_FG` | `black` | Foreground color |
| `SHINKANSEN_SCREEN_PREFIX` | `⬗` | Prefix of the segment |
### Mercurial/HG
|Variable|Default|Meaning
|--------|-------|-------|
Nothing to configure.
### Command execution time
|Variable|Default|Meaning
|--------|-------|-------|
|`BULLETTRAIN_EXEC_TIME_ELAPSED`|5|Minimum elapsed time of command execution. If the execution time of a command is smaller than this, the segment will be hidden.
|`BULLETTRAIN_EXEC_TIME_BG`|`yellow`|Background color
|`BULLETTRAIN_EXEC_TIME_FG`|`black`|Foreground color
| Variable | Default | Meaning |
| ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `SHINKANSEN_EXEC_TIME_ELAPSED` | 5 | Minimum elapsed time of command execution. If the execution time of a command is smaller than this, the segment will be hidden. |
| `SHINKANSEN_EXEC_TIME_BG` | `yellow` | Background color |
| `SHINKANSEN_EXEC_TIME_FG` | `black` | Foreground color |
## Wiki
- [FAQ](https://github.com/caiogondim/bullet-train-oh-my-zsh-theme/wiki/FAQ)
- [Screenshots](https://github.com/caiogondim/bullet-train-oh-my-zsh-theme/wiki/Screenshots)
- [Tips](https://github.com/caiogondim/bullet-train-oh-my-zsh-theme/wiki/Tips)
## Contributors
## Contributors & Credits
That project was originally a fork from
[Powerline](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme), but
most of the code was later erased and its now more closely related to
[Agnoster](https://gist.github.com/agnoster/3712874). Below is a `git summary`
of the project:
```
156 Caio Gondim
33 Jérémy Romey
14 Greg Fitzgerald
8 Dan Kaplun
8 Viktor (Icon) VAD
7 Jocelyn Mallon
7 Dawid Kurek
6 Joe Block
6 Jérémy Romey
5 Arthur Wang
4 Flavius Aspra
3 Mario Zigliotto
3 Michael Robinson
3 Michael Cornell
3 Iulian Onofrei
2 itsZero (Chien-An Cho)
2 Daniel Loader
2 Charlie Smith
2 wujtruj
2 Jiri Tyr
1 Sébastien Bordenave
1 Yongqian Li
1 alysson
1 gvillalta99
1 illuminatis
1 krischer
1 m.kuehn
1 timfeirg
1 Adrien Brault
1 yachi
1 Andreas Galauner
1 Dale Davis
1 Fabio Poloni
1 Faure Hu
1 Guillaume BINET
1 Hannes Frank
1 Heng-Yi Wu
1 Jack Chu
1 Jason Hollis
1 KVoll
1 Kevin
1 Lyncredible
1 Manuel Hoffmann
1 Marius Krämer
1 Maxime Bruguet
1 Mertcan Mermerkaya
1 Nicholas
1 Peter Nagy
1 Sen Jiang
```
## Credits
This theme is highly inspired by the following themes:
- [Powerline](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme)
- [Agnoster](https://gist.github.com/agnoster/3712874)
## Donating
If you found this project useful and are willing to donate, transfer some
bitcoins to `1BqqKiZA8Tq43CdukdBEwCdDD42jxuX9UY` or through the
[URL](https://www.coinbase.com/caiogondim) https://www.coinbase.com/caiogondim
Or via [PayPal.me](https://www.paypal.me/caiogondim) https://www.paypal.me/caiogondim.
---
[caiogondim.com](https://caiogondim.com) &nbsp;&middot;&nbsp;
GitHub [@caiogondim](https://github.com/caiogondim) &nbsp;&middot;&nbsp;
Twitter [@caio_gondim](https://twitter.com/caio_gondim)
[Bullettrain](https://github.com/MRZ07/bullet-train.zsh)
img/icon-square.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 19 KiB

img/icon-square.sketch
BIN
View File
Binary file not shown.
img/icon.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 29 KiB

img/icon.sketch
BIN
View File
Binary file not shown.
img/icon.svg
-24
View File
@@ -1,24 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg width="980px" height="400px" viewBox="0 0 980 400" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- Generator: Sketch 3.6.1 (26313) - http://www.bohemiancoding.com/sketch -->
<title>icon</title>
<desc>Created with Sketch.</desc>
<defs>
<circle id="path-1" cx="127.785004" cy="128.175003" r="127.785004"></circle>
</defs>
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
<path d="M381.920665,131.630005 C404.600143,96.0153239 444.433578,72.3899994 489.785004,72.3899994 C560.358712,72.3899994 617.570007,129.601294 617.570007,200.175003 C617.570007,270.748712 560.358712,327.960007 489.785004,327.960007 C444.101682,327.960007 404.017411,303.987622 381.4255,267.936161 L437.146203,267.936161 L437.146203,131.630005 L381.920665,131.630005 Z" id="Combined-Shape" fill="#3B3B3B"></path>
<g id="Group-2" transform="translate(362.000000, 72.000000)">
<mask id="mask-2" fill="white">
<use xlink:href="#path-1"></use>
</mask>
<use id="Oval-1" fill-opacity="0" fill="#3B3B3B" xlink:href="#path-1"></use>
<g id="Group" mask="url(#mask-2)">
<g transform="translate(-75.820300, 59.633943)">
<path d="M224.965576,136.306156 L70.2828619,136.306156 L70.2828619,0 L224.965576,0 L293.016665,68.1530782 L224.965576,136.300887 Z" id="Rectangle-2" fill="#78AAD6"></path>
<path d="M113.827177,136.209291 L113.827177,136.306156 L0,136.306156 L0,0 L113.827177,0 L113.827177,0.096865154 L181.7868,68.1530782 L113.827177,136.209291 Z" id="Combined-Shape" fill="#A8D4AA"></path>
</g>
</g>
</g>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 1.8 KiB

img/preview.gif
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 492 KiB

After

Width:  |  Height:  |  Size: 4.1 MiB

img/shinkansen-icon.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 140 KiB

img/wiki/screenshots/monokai.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 144 KiB

img/wiki/screenshots/solarized-dark.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 144 KiB

img/wiki/screenshots/tomorrow-night-bright.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 143 KiB

img/wiki/screenshots/tomorrow-night-eighties.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 145 KiB

img/wiki/tips/git_prompt_command.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 5.5 KiB

img/wiki/tips/git_prompt_function.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 5.4 KiB

img/wiki/tips/git_prompt_origin.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 5.3 KiB

img/wiki/tips/prompt_order.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 7.4 KiB

shinkansen.zsh-theme
+1 -1
View File
@@ -10,7 +10,7 @@
# ------------------------------------------------------------------------------
# CONFIGURATION
# The default configuration, that can be overwrite in your .zshrc file
# The default configuration, that can be overwrite in your .zshrc file before you loading the theme.
# ------------------------------------------------------------------------------
VIRTUAL_ENV_DISABLE_PROMPT=true