phundrak/config.phundrak.com

Fork 0

Lucien Cartier-Tilet 22361f5120

docs(fish): replace cd with zoxide

2024-02-20 06:30:19 +01:00

19 KiB

Raw Blame History

Fish

Fish

Fish

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 sometimes need 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

Global variables

An important thing to do is to load all variables from my ~/.profile file (which you can find here). The foreign-env plugin comes in handy:

fenv source ~/.profile

Direnv is a really neat tool that allows you to load the content of a dotenv file as environment variables. Its installation is quite simple for fish.

direnv hook fish | source

Since I don’t really have a better place on this website to put it, here is my direnv configuration located at $HOME/.config/direnv/direnv.toml.

[global]
load_dotenv = true

Development

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

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 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 just want it empty.

function fish_greeting; end

For my fish prompt, I use starship, a shell-agnostic prompt. Let’s load it:

starship init fish | source

Setting up external tools

Starship configuration

As mentioned above, starship is a shell-agnostic prompt, written in Rust and which can be configured separately from the shell. I decided to configure it here though, since fish is the only shell I use which is compatible with starship.

First I’ll modify the default format variable, removing the modules I don’t need.

format = """
$username\
$hostname\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$deno\
$lua\
$nodejs\
$python\
$rlang\
$rust\
$scala\
$zig\
$memory_usage\
$env_var\
$custom\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""

I want starship to be able to detect Lisp files, be it CommonLisp or EmacsLisp. Unfortunately, it seems nerd-font doesn’t have any symbol for either language, so I’m just using a lambda character.

[custom.lisp]
extensions = ["lisp", "el"]
symbol = "λ "
style = "bold green"

Finally, let’s disable all modules I don’t need.

[cobol]
disable = true
[dotnet]
disable = true
[elixir]
disable = true
[elm]
disable = true
[erlang]
disable = true
[golang]
disable = true
[helm]
disable = true
[java]
disable = true
[julia]
disable = true
[kotlin]
disable = true
[nim]
disable = true
[ocaml]
disable = true
[perl]
disable = true
[php]
disable = true
[pulumi]
disable = true
[purescript]
disable = true
[red]
disable = true
[ruby]
disable = true
[swift]
disable = true
[terraform]
disable = true
[vlang]
disable = true
[vagrant]
disable = true
[nix_shell]
disable = true
[conda]
disable = true
[aws]
disable = true
[gcloud]
disable = true
[openstack]
disable = true
[crystal]
disable = true

Loading `zoxide`

zoxide is a smarter cd command. I actually have it replace cd entirely through the --cmd flag you see below..

zoxide init --cmd cd fish | source

Abbreviations

Abbreviations are a great way to keep correctly track of which commands are run in the shell without polluting the history of the shell with obscure commands. When typing an abbreviation, fish will replace it with replace it with its expanded equivalent. Below are some of the abbreviations I use. Be aware some of them that invoke GUI programs can be invoked through devour which will make the terminal disappear while the program runs, and once the GUI program exists the terminal window will come back.

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 to 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"
du	du -ch
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 paru's. This is why I simply type purge. And if I want to simply search among the pacman repos, I can type search. Otherwise, if I want to include AUR results, I’ll use paru.

abbreviation	command
remove	sudo pacman -Rsc
purge	paru -Sc

<<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
suser	systemctl –user

<<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 to 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