~fmac/corylus

ref: 1558e2016ceb11a8bdb5daf07657629fbf798178 corylus/README.md -rw-r--r-- 1.0 KiB
1558e201 — Francesco Camuffo Add cwd.go 5 months ago

#Corylus

Simple shell prompt generator in Go.

#Usage

Corylus expects strings as arguments. If an argument matches the name of a known segment generator, then the result will be appended. If an argument does not match any generator then it is appended as string.


Edit the prompt variable in your shell configuration file, probably .bashrc, .zshrc or .profile. For ZSH you may need to enable the prompt expansion by adding setopt PROMPT_SUBST to your .zshrc.


At the moment the available segments are:

  • hostname
  • username
  • cwd
  • tail

Here is an example with some colors.

PS1='$(corylus \
	"[" hostname "] " \
	"\033[34m" username "\033[0m " \
	"\033[35m" cwd "\033[0m" \
	tail)'

Which outputs with this format:

[myhost] myname ~/r/c/.g/branches
$

#Install

go get git.sr.ht/~fmac/corylus

#Contributing

Of course you are free to send me a git-email with a patch that adds new segments.