Skip to content

Home

Jump to bottom
John Meow edited this page Jul 24, 2020 · 37 revisions

Subcommands

init

This subcommand outputs shell script to be evaluated by your shell on startup. Silver detects your shell with the SILVER_SHELL environment variable.

lprint, rprint

These subcommands shouldn't be called by the user, but by the code init generates. They output the left and right prompt respectively.

Environment variables

Every following variable with the exceptions of $SILVER_LEFT and $SILVER_RIGHT must be exported by the shell.

SILVER_LEFT, SILVER_RIGHT

These variables are arrays of every module, in order, you want in your left or right prompt respectively. The elements in these arrays have three fields separated by colons. The first field is the module name, the second is the background color of the segment, and the third is the foreground color.

For example, if you wanted the dir module with black text on a blue background, the element would be dir:blue:black.

SILVER_SHELL

This variable tells silver what shell you are using. The supported shells are Bash, Zsh, and fish.

SILVER_LEFT_SEPARATOR, SILVER_RIGHT_SEPARATOR

These variables are the separators between segments in left and right prompt respectively. The default values are \ue0b0 and \ue0b2.

Left prompt example with \ue0b4:

Left prompt example with \ue0bc:

SILVER_THIN_LEFT_SEPARATOR, SILVER_THIN_RIGHT_SEPARATOR

These variables are the thin separators between segments of the same background color. The default values are \ue0b1 and \ue0b3 respectively.

SILVER_ICONS

This variable is a preset of every icon. Valid values are nerd, unicode, or ascii. It defaults to nerd. For more information, see Icons.

Modules

Icons

Every icon is completely customizable through environment variables.

There are three presets for icons (which can be set through SILVER_ICONS):

  • nerd uses icons from Nerd Fonts
  • unicode uses Unicode (mostly emojis)
  • ascii uses only ASCII

The default preset is nerd, but each individual icon can be set with environment variables. The environment variables to set is SILVER_ICON_[icon name]. For example, if you wanted to set the failed icon to "✗", you would set the environment variable SILVER_ICON_FAILED to \u2717.

Every icon name can be found on the appropriate module wiki page.

Example configurations

~/.bashrc/~/.zshrc:

export SILVER_SHELL=$0
SILVER_LEFT=(dir:blue:black git:green:black)
SILVER_RIGHT=(status:white:black cmdtime:magenta:black env:green:black:SILVER_SHELL)
source <(silver init)

~/.config/fish/config.fish:

set -x SILVER_SHELL fish
set SILVER_LEFT dir:blue:black git:green:black 
set SILVER_RIGHT status:white:black cmdtime:magenta:black env:green:black:SILVER_SHELL
silver init | source
Clone this wiki locally