Skip to content

Latest commit

 

History

History
158 lines (117 loc) · 7.94 KB

README.md

File metadata and controls

158 lines (117 loc) · 7.94 KB
Raw

Vertical

A clean and git-aware prompt for the fish shell with a distinct vertical line.

Screenshot

Features

  • Unique vertical line prompt
  • Git-aware
  • Background job status
  • User and host names
  • Previous command duration

Requirements

  • fish (3.0.0 or higher)
  • git (optional, for git integration)

Installation

Using Fisher

fisher install adamchristiansen/vertical-fish

Configuration

The following options can be overridden by setting the variable. This only needs to be done once, as universal variables are used for all configuration options.

The vertical_clear_configuration command can be used to clear all universal variables. They are reset to their default values the next time that the prompt is run. This affects only universal variables, so any set global variables will still be used.

General

Option Default Description
vertical_newline true Insert a newline before the prompt
vertical_order jobs user host dir git_branch git_status duration vi_mode Order to display components
vertical_version 1.0.0 Current version

Cue

The cue is displayed immediately before where the user types.

Option Default Description
vertical_vert_cue ' ' Cue text
vertical_vert_cue_color normal Cue color

Directory

Option Default Description
vertical_dir_color blue --bold Directory color
vertical_dir_prefix ' ' Directory prefix
vertical_dir_prefix_color blue --bold Directory prefix color
vertical_dir_trunc_git true Shorten directory relative to git repository
vertical_dir_trunc_home true Replace $HOME with ~

Duration

Option Default Description
vertical_duration_color yellow --bold Duration color
vertical_duration_min 5000 Minimum command duration (milliseconds)
vertical_duration_prefix ' ' Duration prefix
vertical_duration_prefix_color yellow --bold Duration prefix color

Git Branch

Option Default Description
vertical_git_branch_color magenta --bold Git branch color
vertical_git_branch_prefix ' ' Git branch prefix
vertical_git_branch_prefix_color magenta --bold Git branch prefix color

Git Status

Option Default Description
vertical_git_status_color cyan --bold Git status color
vertical_git_status_prefix ' [' Git status prefix
vertical_git_status_prefix_color cyan --bold Git status prefix color
vertical_git_status_suffix ] Git status suffix
vertical_git_status_suffix_color cyan --bold Git status suffix color
vertical_git_status_sym_added + Git added status symbol
vertical_git_status_sym_added_deleted ± Git added and deleted status symbol
vertical_git_status_sym_ahead ↑ Git ahead status symbol
vertical_git_status_sym_behind ↓ Git behind stymbol
vertical_git_status_sym_diverged ↕ Git diverged status symbol
vertical_git_status_sym_deleted - Get deleted status symbol
vertical_git_status_sym_modified • Git modified status symbol
vertical_git_status_sym_renamed ‣ Git renamed status symbol
vertical_git_status_sym_stashed # Git stashed status symbol
vertical_git_status_sym_unmerged = Git unmerged status symbol
vertical_git_status_sym_untracked ? Git untracked status symbol

Host

Option Default Description
vertical_host_color yellow --bold Host color
vertical_host_prefix @ Host prefix
vertical_host_prefix_color yellow --bold Host prefix color
vertical_host_ssh_only true Show only over SSH

Jobs

Option Default Description
vertical_jobs_color cyan --bold Jobs color
vertical_jobs_prefix ' ' Jobs prefix
vertical_jobs_prefix_color cyan --bold Jobs prefix color
vertical_jobs_sym ● Jobs symbol

User

Option Default Description
vertical_user_color yellow --bold User color
vertical_user_prefix ' ' User prefix
vertical_user_prefix yellow --bold User prefix color
vertical_user_ssh_only true Show only over SSH

Vertical Bar

Option Default Description
vertical_vert_bottom │ Vertical bottom symbol
vertical_vert_color_success green Vertical color when the previous command succeeds
vertical_vert_color_failure red Vertical color when the previous command fails
vertical_vert_top │ Vertical top symbol

VI Mode

Option Default Description
vertical_vi_mode_color yellow --bold VI mode color
vertical_vi_mode_prefix '' VI mode prefix
vertical_vi_mode_prefix_color yellow --bold VI mode prefix color
vertical_vi_mode_sym_insert '' VI insert mode symbol
vertical_vi_mode_sym_normal ' (N)' VI normal mode symbol
vertical_vi_mode_sym_replace_one ' (R)' VI replace one mode symbol
vertical_vi_mode_sym_visual ' (V)' VI visual mode symbol