27 KiB
Phundrak’s fish config
- Presentation
- Fish from within Emacs
- Tramp remote access
- Regular fish shell appearance
- Global variables
- Abbreviations
Presentation
The file present in ~/.config/fish/config.fish
is the configuration file for
the fish shell. It contains custom functions, environment variables and
abbreviations.
Just in case, we might need sometimes to declare the fish function
fish_title
as true
, so let’s do so.
function fish_title
true
end
Fish from within Emacs
I sometimes call fish from within emacs, with M-x ansi-term
. In this case,
the variable TERM
needs to have the value eterm-color
.
if test -n "$EMACS"
set -x TERM eterm-color
end
Tramp remote access
When accessing from a remote machine our computer from Emacs, tramp needs a
precise shell appearance: a simple $
followed by a space after which to put
the commands it needs to execute, and nothing else. Due to this, let’s
deactivate and redefine some of the functions defining the appearance of
fish.
if test "$TERM" = "dumb"
function fish_prompt
echo "\$ "
end
function fish_right_prompt; end
function fish_greeting; end
function fish_title; end
end
Regular fish shell appearance
Now, there is only one function I modify when it comes to the appearance of
fish when I’m the one using it: the fish_greeting
function. I use it to give
me an overview of my computer’s status, including its hostname, uptime, disks
usage, ram usage, swap usage, and networking.
set RED '\033[0;31m'
set GREEN '\033[0;32m'
set NC '\033[0m'
function display_slider # used total
set -l slider_length 39
set -l used $argv[1]
set -l total $argv[2]
set -l used_slider (math -s0 "($used * $slider_length) / $total")
set -l unused_slider (math -s0 "$slider_length - $used_slider")
echo -en "["
echo -en $RED
echo -en (string repeat -n $used_slider '=')
echo -en $GREEN
echo -en (string repeat -n $unused_slider '=')
echo -en $NC
echo -en "]"
end
function fish_greeting
set -l ruler_length 79
set -l ruler (string repeat -n $ruler_length "=")
set -l osname (cat /etc/os-release | grep -i pretty_name | sed 's/.*"\(.*\)".*/\1/')
set -l uptime (uptime | sed 's/\(.*\):\(.*\):\(.*\) up.*/\1 hours \2 minutes/' | sed 's/ *\(.*\)/\1/')
set -l root (df -Ph | grep -E "/\$")
set -l root_p (echo $root | awk '{print $5}' | tr -d '%')
set -l root_used (echo $root | awk '{print $3}')
set -l root_total (echo $root | awk '{print $2}')
set -l ram (free -tm | grep Mem)
set -l ram_total (echo $ram | awk '{print $2}')
set -l ram_used (echo $ram | awk '{print $3}')
set -l ram_p (math -s0 "$ram_used / $ram_total * 100")
set -l swap (free -tm | grep Swap)
set -l swap_total (echo $swap | awk '{print $2}')
set -l swap_used (echo $swap | awk '{print $3}')
set -l swap_p (math -s0 "$swap_used / $swap_total * 100")
set -l connections (nmcli c s | grep -E "wifi|ethernet" | grep -v '\-\-')
set -l wifi (echo $connections | grep "wifi" | awk '{print $1}')
set -l ethernet (test "$connections" = "*ethernet*" && echo -e $GREEN"UP"$NC || echo -e $RED"DOWN"$NC)
set -l wifi (test -n wifi && echo -e $GREEN$wifi$NC || echo - $RED"DOWN"$NC)
echo $ruler
printf "OS......: %-30sKernel: %s %s\n" $osname (uname -s) (uname -r)
printf "Hostname: %-30sUptime: %s\n" (hostname) $uptime
printf "Ethernet: %-41sWifi..: %s\n" $ethernet $wifi
printf "Disks...: %-5s %s %6s / %6s (%2d%%)\n" "/" (display_slider $root_p 100) $root_used $root_total $root_p
# loop other mountpoints
for mp in (df -Ph 2> /dev/null | egrep "sd|tank" | egrep -v "boot|/\$")
set -l mp_p (echo $mp | awk '{print $5}' | tr -d '%')
set -l mp_used (echo $mp | awk '{print $3}')
set -l mp_total (echo $mp | awk '{print $2}')
set -l mp_name (echo $mp | awk '{print $6}')
printf " %-5s %s %6s / %6s (%2d%%)\n" $mp_name (display_slider $mp_p 100) $mp_used $mp_total $mp_p
end
printf "Ram.....: %s %5dM / %5dM (%2d%%)\n" (display_slider $ram_used $ram_total) $ram_used $ram_total $ram_p
printf "Swap....: %s %5dM / %5dM (%2d%%)\n" (display_slider $swap_used $swap_total) $swap_used $swap_total $swap_p
echo $ruler
end
Global variables
Some global variables might sometimes be needed and need to be modified. This
is for example the case with my PATH
variable in which I add Rust’s Cargo’s
binaries, Go’s binaries and my own executables. And of course, don’t forget
to add the already existing PATH
.
additional path | what it leads to |
---|---|
$HOME/.pub-cache/bin | Dart binaries and executables |
$HOME/.local/bin | Custom executables, see /phundrak/config.phundrak.com/src/commit/d274e03fb1db045dba6514da64a1dabcd8e5b77e/org/config/bin.org |
$HOME/go/bin | Go binaries and executables |
$HOME/.cargo/bin | Rust binaries and executables |
$HOME/.gem/ruby/2.6.0/bin | Ruby binaries and executables |
$HOME/.pub-cache/bin $HOME/.local/bin $HOME/go/bin $HOME/.cargo/bin $HOME/.gem/ruby/2.6.0/bin
set -gx PATH <<generate-extra-paths()>> $PATH
In order to keep some other code clean, I set the $BROWSER
variable so I
don’t have to call my web browser directly but rather with this variable.
set -gx BROWSER firefox
Sometimes, software will rely on SUDO_ASKPASS
to get a GUI from which it
can get the sudo password. So, let’s declare it.
set -gx SUDO_ASKPASS ~/.local/bin/askpass
Now, let’s declare our editor of choice, EmacsClient; not Emacs itself since
it will most often be just quick edits, nothing too heavy, if it is called
from the EDITOR
variable (from Git, for example).
set -gx EDITOR emacsclient -c
We also need to set the path to the Dart SDK.
set -gx DART_SDK /opt/dart-sdk/bin
And we also need to specify where the Android SDK it located.
set -gx ANDROID_HOME $HOME/Android/Sdk
Finally, some development packages require the PKG_CONFIG_PATH
to be set,
so let’s do so.
set -gx PKG_CONFIG_PATH /usr/local/lib/pkgconfig/ $PKG_CONFIG_PATH
Abbreviations
System monitoring
Here I have some abbreviations which are quite useful when performing some
system monitoring. With df
, we can get an overview of our filesystem usage,
while with diskspace
we get some more precise information. meminfo
is a
call to free
with sane defaults, and similar to meminfo
, we also have
gpumeminfo
so we can get a quick look at the memory-related logs of our X
session. I also declared cpuinfo
an alias of lscpu
in order to keep
consistent with meminfo
. pscpu
gives us information on what the CPU is
running right now, and pscpu10
limits that to the top 10 threads.
Similarly, psmem
gives us information on the memory usage of the current
threads, and psmem10
only the ten most important threads in terms of memory
usage.
abbreviation | command |
---|---|
df | df -H |
diskspace | sudo df -h | grep -E "sd|lv|Size" |
meminfo | free -m -l -t |
gpumeminfo | grep -i –color memory /var/log/Xorg.0.log |
cpuinfo | lscpu |
pscpu | ps auxf | sort -nr -k 3 |
pscpu10 | ps auxf | sort -nr -k 3 | head -10 |
psmem | ps auxf | sort -nr -k 4 |
psmem10 | ps auxf | sort -nr -k 4 | head -10 |
<<generate-abbr(table=mgmt-abbr)>>
System management (packages and services)
I added some of these abbreviations due to how often I have to write the whole thing.
Package management
The first command is remove
which removes a package from my system, as
well as its dependencies no longer needed. p
. pacman
's or yay
's. This
is why I simply type purge
. And if I want to simply seach among the
pacman
repos, I can type search
. Otherwise, if I want to include AUR
results, I’ll use yay
.
abbreviation | command |
---|---|
remove | sudo pacman -Rscnd |
p | sudo pacman |
purge | yay -Sc |
search | yay -Ss |
<<generate-abbr(table=pm-abbr)>>
Service management
I don’t have the muscle memory of systemctl
. So instead, I simply type
c
when I want to do something user service related.
And if I want to manipulate system services, I can instead type a simple
capital S
.
abbreviation | command |
---|---|
s | systemctl –user |
S | sudo systemctl |
<<generate-abbr(table=service-abbr)>>
Development
A good amount of these commands are development related, especially when it comes to compilation or Docker.
CMake
I have the following abbreviations so I can quickly run CMake and create a configuration for debug or release profiles.
abbreviation | command |
---|---|
cdebug | cmake -DCMAKE_BUILD_TYPE=Debug |
crelease | cmake -DCMAKE_BUILD_TYPE=Release |
Here is the corresponding fish configuration:
<<generate-abbr(table=abbr-cmake)>>
Compilation
By default, I set clang
, clang++
, gcc
and g++
to the latest
standard and with the -Wall
flag activated.
abbreviation | command |
---|---|
clang | clang -Wall |
clang++ | clang++ -Wall |
g++ | g++ -Wall -std=c++17 |
gcc | gcc -Wall -std=c18 |
Here is the corresponding fish configuration:
<<generate-abbr(table=abbr-comp)>>
Docker
And of course, when it comes to Docker Compose, I don’t have time to write the full command, so I use these instead.
abbreviation | command |
---|---|
dc | docker-compose |
dcd | docker-compose down |
dcr | docker-compose run –rm |
dcu | docker-compose up |
dcub | docker-compose up –build |
Here is the corresponding fish configuration:
<<generate-abbr(table=abbr-docker)>>
Git
And let’s face it: we all at one point just wanted to commit our code without thinking about the message, to just get over with it. Don’t worry, I got you covered.
abbreviation | command |
---|---|
randcommit | git commit -m (curl -s whatthecommit.com/index.txt) |
Here is the corresponding fish configuration:
<<generate-abbr(table=abbr-git)>>
Prolog
When I launch swipl
, I prefer to have my terminal cleaned before and
after it runs, I find it more clean.
abbreviation | command |
---|---|
swipl | clear && swipl -q && clear |
Here is the corresponding fish configuration:
<<generate-abbr(table=abbr-prolog)>>
Text editors
I greatly prefer to use Emacsclient as my main text editor; Emacs has
basically all I need. So, it’s only normal I have an abbreviation to launch
a new instance of it. However, in a graphical environment, this will launch
a new graphical window of Emacs. To launch a terminal instance, I’ll use
enw
(nw
stands for the option “nowindow” -nw
of Emacs). I also wish to
completely stop using other text editors, such as vi
, vim
, nano
and
ed
, so let’s all add their command as an abbreviation for Emacs.
abbreviation | command |
---|---|
e | emacsclient -c |
enw | emacsclient -c -nw |
vi | emacsclient -c |
vim | emacsclient -c |
nano | emacsclient -c |
ed | emacsclient -c |
Here is the corresponding fish configuration:
<<generate-abbr(table=abbr-text-ed)>>
LaTeX
Yes, although I use org-mode, I still have some use for LaTeX, especially
when it comes to PDF exports of my org files. Hence why I use the LaTeX
package manager. It is recommended to use tllocalmgr
instead of tlmgr
,
but I can never remember the command, and the latter is faster to type, so
time for an abbreviation. Same goes for texhash
which must be run as sudo.
abbreviation | command |
---|---|
tlmgr | tllocalmgr |
texhash | sudo texhash |
Here is the corresponding fish configuration:
<<generate-abbr(table=latex-abbr)>>
Some security measures
Some commands can be quite dangerous when not used properly, which is why I
added default flags and options so I can get warnings before things get ugly.
The -i
and -I
add prompts in case we might not want to do what we asked
the shell to do. Notice lns
which creates symlinks, rmd
which removes
directories, rmf
which forces deletion, and rmdf
which forces the
delition of a directory. Notice also the --preserve-root
which will prevent
me from accidentally removing the root folder. I added the same option to
chgrp
, chmod
, and chown
.
abbreviation | command |
---|---|
cp | cp -i |
ln | ln -i |
lns | ln -si |
mv | mv -i |
rm | rm -Iv |
rmd | rm –preserve-root -Irv |
rmdf | rm –preserve-root -Irfv |
rmf | rm –preserve-root -Ifv |
chgrp | chgrp –preserve-root -v |
chmod | chmod –preserve-root -v |
chown | chown –preserve-root -v |
Here is the corresponding fish configuration:
<<generate-abbr(table=sec-abbr)>>
Typos
Let’s admit it, we all make typos from time to time in the shell, and some
are recurrent enough we make abbreviations or aliases of the correct command.
Well, I have some of my abbreviations which were make exactly because of
this. Sometimes for some reasons, my brain makes me write clean
instead of
clear
. So, let’s just replace the former by the latter. I’m also very bad
at typing exit
. And sometimes I suck at typing htop
.
abbreviation | command |
---|---|
clean | clear |
exi | exit |
exti | exit |
hotp | htop |
Here is the corresponding fish configuration:
<<generate-abbr(table=typo-abbr)>>
Misc
Finally, some miscellaneous abbreviations that don’t really fit into any of the above categories.
Sudo
First, I make it so that sudo
comes with the -A
switch in order to call
my custom graphical script for getting my password (see
.local/bin/askpass). I also made it so please
is an equivalent to sudo
-A
as a joke.
abbr please 'sudo -A'
Exit
Sometimes I find it easier to just type q
instead of exit
.
abbr q exit
History
I also find it more intuitive and faster to just write hist
instead of
history
, so let’s declare that.
abbr hist history
youtube-dl
related commands
Song download from YouTube
When I want to download a song from YouTube, I’ll just use the command
flac videoIdentifier
to get it through youtube-dl
.
abbr flac 'youtube-dl -x --audio-format flac --audio-quality 0 -o "~/Music/%(uploader)s/%(title)s.%(ext)s"'
Videos download from YouTube
I download a LOT of videos from YouTube, generally educative videos that I
do not want to lose to YouTube one day who will decide that such channel is
unworthy of their platform, or if the original author decides to delete
their videos or whatever. So, I use the abbreviation ytdl
to download
either one video, or a whole YouTube channel.
abbr ytdl 'youtube-dl -f best -ciw -o "~/Videos/YouTube/%(uploader)s/%(upload_date)s - %(title)s.%(ext)s"'
MPV
When it comes to mpv, I do not want to force it to open a graphical window if for example I want to listen to an audio file. I also do not want any border on that window. So, I declared this abbreviation.
abbr mpv 'mpv --no-border --force-window=no'
Compression
It seems it’s just like many other people, but I cannot for the life of me
remember the syntax of tar
. So, I made the following abbreviations, and
one day hopefully, after seeing the abbreviations’ expansion over and over
I’ll remember the command like I did for the abbreviation of remove
(see
Package management).
abbreviation | command |
---|---|
compress | tar -czf |
untar | tar -xvzf |
<<generate-abbr(table=tar-abbr)>>
Sxiv
Some sane default options for sxiv
, a simple X image Viewer. This includes
playing GIFs and not displaying the filename below. Sxiv will also open in
fullscreen and will fit the displayed image to the frame. I also abbreviated
feh
to sxiv, old habits die hard.
abbr sxiv 'sxiv -abfs f'
abbr feh 'sxiv -abfs f'
exa
abbr exa 'exa -halg@ --group-directories-first --git'
Network Management
First, we have just nmcli
with sane default options, that is a pretty output
with colors.
abbr nmcli 'nmcli -p -c auto'
NordVPN
Next, we have some NordVPN-related shortcuts. The first one is a simple
abbreviation to nordvpn
. The second one is a shortcut to connect to a
server, and to disconnect from the current server. I also have a couple of
shortcuts to quickly connect to some preselected countries, mainly France,
Germany, Japan and the US.
abbreviation | command |
---|---|
n | nordvpn |
nc | nordvpn c |
nd | nordvpn d |
ncf | nordvpn c France |
ncg | nordvpn c Germany |
ncj | nordvpn c Japan |
ncu | nordvpn c United_States |
<<generate-abbr(table=nordvpn-abbr)>>
Webcam
abbreviation | command |
---|---|
webcam | mpv –no-border –demuxer-lavf-format=video4linux2 –demuxer-lavf-o-set=input_format=mjpeg av://v4l2:/dev/video0 |
<<generate-abbr(table=webcam-abbr)>>
Wget
By default, continue a download that was interupted.
abbr wget 'wget -c'