From 04fd30ca732af14e5fde05e211d133217f3e9a57 Mon Sep 17 00:00:00 2001 From: tombdf Date: Fri, 3 Jan 2025 00:39:01 +0100 Subject: [PATCH] feat!: Alter most of major config files - Bash: config file - Zsh: config file - Fish: config file and fish plugins - Nvim: config files - Kitty: config files --- .chezmoiexternal.toml | 8 +- README.md | 1 - dot_bashrc | 210 +- dot_vimrc | 2 +- dot_zshrc | 85 +- private_dot_config/chezmoi/chezmoi.toml.tmpl | 4 +- private_dot_config/fish/config.fish | 172 +- private_dot_config/kitty/kitty.conf | 2505 ++++++++++++----- .../kitty/symlink_theme.conf.tmpl | 1 - private_dot_config/nvim/lua/autocmds.lua | 9 + private_dot_config/nvim/lua/chadrc.lua | 1 + .../nvim/lua/configs/lspconfig.lua | 14 +- private_dot_config/nvim/lua/mappings.lua | 134 +- private_dot_config/nvim/lua/options.lua | 2 + private_dot_config/nvim/lua/plugins/init.lua | 2 + .../nvim/lua/plugins/plugins.lua | 18 +- private_dot_config/starship.toml | 171 ++ private_dot_config/topgrade.d/topgrade.toml | 4 +- scripts/shells.sh | 7 + utils/packages | 2 + 20 files changed, 2434 insertions(+), 918 deletions(-) delete mode 100644 private_dot_config/kitty/symlink_theme.conf.tmpl create mode 100644 private_dot_config/starship.toml diff --git a/.chezmoiexternal.toml b/.chezmoiexternal.toml index 9a3c888..41ca012 100644 --- a/.chezmoiexternal.toml +++ b/.chezmoiexternal.toml @@ -13,9 +13,7 @@ url = "https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim" refreshPeriod = "168h" -[".config/kitty/kitty-themes"] - type = "git-repo" - url = "https://github.com/dexpota/kitty-themes.git" +[".config/kitty/theme.conf"] + type = "file" + url = "https://raw.githubusercontent.com/kovidgoyal/kitty-themes/refs/heads/master/themes/GruvboxMaterialDarkSoft.conf" refreshPeriod = "168h" - [".config/kitty/kitty-themes".clone] - args = ["--depth=1"] diff --git a/README.md b/README.md index eb5c855..7a6cd22 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,6 @@ The following sections will resume what usage you can have of different commands ### Commands With Zsh and Zinit, a lot of commands will be installed. They're very useful and powerful so it might be a good idea to learn what they are. -Note : Two keybindings are define in `.zshrc`. They are p and n. Use them for navigate in your command history. #### Zoxide **Commands** : `z` | `zi` diff --git a/dot_bashrc b/dot_bashrc index a49bfd8..af5055b 100644 --- a/dot_bashrc +++ b/dot_bashrc @@ -1,110 +1,56 @@ -# ~/.bashrc: executed by bash(1) for non-login shells. -# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc) -# for examples +########################################################################## +# +# ██████╗ █████╗ ███████╗██╗ ██╗██████╗ ██████╗ +# ██╔══██╗██╔══██╗██╔════╝██║ ██║██╔══██╗██╔════╝ +# ██████╔╝███████║███████╗███████║██████╔╝██║ +# ██╔══██╗██╔══██║╚════██║██╔══██║██╔══██╗██║ +# ██████╔╝██║ ██║███████║██║ ██║██║ ██║╚██████╗ +# ╚═════╝ ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ +# +########################################################################## -# If not running interactively, don't do anything +# bash configuration ------------------------------------------------------ {{{ + +# if not running interactively, don't do anything case $- in *i*) ;; *) return;; esac -export PATH="$HOME/.atuin/bin:$PATH" +export path="$home/.atuin/bin:$path" + +# history ------------------------------------------------------------------ {{{ # don't put duplicate lines or lines starting with space in the history. -# See bash(1) for more options -HISTCONTROL=ignoreboth +histcontrol=ignoreboth # append to the history file, don't overwrite it shopt -s histappend -# for setting history length see HISTSIZE and HISTFILESIZE in bash(1) -HISTSIZE=1000 -HISTFILESIZE=2000 +# for setting history length see histsize and histfilesize in bash(1) +histsize=1000 +histfilesize=2000 + +# }}} + +# general options ---------------------------------------------------------------- {{{ # check the window size after each command and, if necessary, -# update the values of LINES and COLUMNS. +# update the values of lines and columns. shopt -s checkwinsize -# If set, the pattern "**" used in a pathname expansion context will -# match all files and zero or more directories and subdirectories. -#shopt -s globstar +# make less more friendly for non-text input files +[ -x /usr/bin/lesspipe ] && eval "$(shell=/bin/sh lesspipe)" -# make less more friendly for non-text input files, see lesspipe(1) -[ -x /usr/bin/lesspipe ] && eval "$(SHELL=/bin/sh lesspipe)" - -# set variable identifying the chroot you work in (used in the prompt below) -if [ -z "${debian_chroot:-}" ] && [ -r /etc/debian_chroot ]; then - debian_chroot=$(cat /etc/debian_chroot) -fi - -# set a fancy prompt (non-color, unless we know we "want" color) -case "$TERM" in - xterm-color|*-256color) color_prompt=yes;; -esac - -# uncomment for a colored prompt, if the terminal has the capability; turned -# off by default to not distract the user: the focus in a terminal window -# should be on the output of commands, not on the prompt -force_color_prompt=yes - -if [ -n "$force_color_prompt" ]; then - if [ -x /usr/bin/tput ] && tput setaf 1 >&/dev/null; then - # We have color support; assume it's compliant with Ecma-48 - # (ISO/IEC-6429). (Lack of such support is extremely rare, and such - # a case would tend to support setf rather than setaf.) - color_prompt=yes - else - color_prompt= - fi -fi - -if [ "$color_prompt" = yes ]; then - PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ ' -else - PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ ' -fi -unset color_prompt force_color_prompt - -# If this is an xterm set the title to user@host:dir -case "$TERM" in +# if this is an xterm set the title to user@host:dir +case "$term" in xterm*|rxvt*) - PS1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$PS1" + ps1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$ps1" ;; *) ;; esac -# enable color support of ls and also add handy aliases -if [ -x /usr/bin/dircolors ]; then - test -r ~/.dircolors && eval "$(dircolors -b ~/.dircolors)" || eval "$(dircolors -b)" - alias ls='ls --color=auto' - #alias dir='dir --color=auto' - #alias vdir='vdir --color=auto' - - alias grep='grep --color=auto' - alias fgrep='fgrep --color=auto' - alias egrep='egrep --color=auto' -fi - -# colored GCC warnings and errors -#export GCC_COLORS='error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01' - -# some more ls aliases -alias ll='ls -alF' -alias la='ls -A' -alias l='ls -CF' -alias c='clear' -alias csc='sudo cytech-site-change' -alias quit='exit' -alias compresse='echo "tar -cv [nomDuFichieràCompresser] -f [nomArchive].tar"' -alias cps='cp ~/Desktop/Programme/script-c/script.sh ./script.sh' -alias sql='mysql -u thomas -p' -alias waterfox='~/waterfox/waterfox' - -# Add an "alert" alias for long running commands. Use like so: -# sleep 10; alert -alias alert='notify-send --urgency=low -i "$([ $? = 0 ] && echo terminal || echo error)" "$(history|tail -n1|sed -e '\''s/^\s*[0-9]\+\s*//;s/[;&|]\s*alert$//'\'')"' - # enable programmable completion features (you don't need to enable # this, if it's already enabled in /etc/bash.bashrc and /etc/profile # sources /etc/bash.bashrc). @@ -116,22 +62,98 @@ if ! shopt -oq posix; then fi fi -# Set the ssh-agent -if ! pgrep -u "$USER" ssh-agent > /dev/null; then +# setup custom completions +mkdir -p "$home/.completions" + +# check if the command exists and if the completion file does not exist, generate it +generate_completion() { + local cmd=$1 + local out_file="$home/.completions/$2" + local gen_cmd=$3 + + if command -v "$cmd" >/dev/null 2>&1 && [ ! -f "$out_file" ]; then + eval "$gen_cmd" + echo "generated completion for $cmd" + fi +} + +generate_completion "atuin" "atuin.bash" "atuin gen-completions --shell bash --out-dir \$home/.completions" +generate_completion "chezmoi" "chezmoi.bash" "chezmoi completion bash --output=\$home/.completions/chezmoi.bash" +generate_completion "rip" "rip.bash" "rip completions bash > \$home/.completions/rip.bash" + +source "$home/.completions/atuin.bash" +source "$home/.completions/chezmoi.bash" +source "$home/.completions/rip.bash" + +# }}} + +# }}} + +# user configuration ------------------------------------------------------------------ {{{ + +# aliases ------------------------------------------------------------------ {{{ + +alias ls='lsd' +alias ll='ls -alf' +alias rm='rip' +alias cat='bat' +alias grep='rg' +alias find='fd -h' +alias c='clear' +alias quit='exit' +alias vi=$(which vim) +alias vim='nvim' +alias csc='sudo cytech-site-change' +alias compresse='echo "tar -cv [nomdufichieràcompresser] -f [nomarchive].tar"' +alias cps='cp ~/desktop/programme/script-c/script.sh ./script.sh' +alias sql='mysql -u thomas -p' + +# }}} + +# ssh configuration ---------------------------------------------------------------- {{{ + +# preferred editor for local and remote sessions +if [[ ! -n $ssh_connection ]]; then + export editor='nvim' +else + export editor='vim' +fi + +# set the ssh-agent if it is not already running +if ! pgrep -u "$user" ssh-agent > /dev/null; then eval "$(ssh-agent -s)" > /dev/null fi -export SSH_AUTH_SOCK=$(ssh-agent -s | grep -oP '(?<=SSH_AUTH_SOCK=)[^;]+') -# Add the keys to the agent -if [ -f ~/.ssh/id_ed25519 ] && ! ssh-add -l | grep -q id_ed25519; then - ssh-add ~/.ssh/id_ed25519 > /dev/null 2>&1 -fi -if [ -f ~/.ssh/hexasec ] && ! ssh-add -l | grep -q hexasec; then - ssh-add ~/.ssh/hexasec > /dev/null 2>&1 -fi +# function to add ssh keys to the agent +add_ssh_key() { + local key_path=$1 + local key_name=$(basename "$key_path") + if [ -f "$key_path" ] && ! ssh-add -l | grep -q "$key_name"; then + ssh-add "$key_path" > /dev/null 2>&1 + fi +} + +# add personal ssh keys +add_ssh_key ~/.ssh/id_ed25519 +add_ssh_key ~/.ssh/hexasec + +# }}} + +# }}} + +# shell enhancements initialization ---------------------------------------------------------------- {{{ + +# allow zoxide to work and to replace cd eval "$(zoxide init --cmd cd bash)" +# set the theme to use with oh my posh eval "$(oh-my-posh init bash)" +# or use starship +# eval "$(starship init bash)" + +# initialize atuin [[ -f ~/.bash-preexec.sh ]] && source ~/.bash-preexec.sh eval "$(atuin init bash --disable-up-arrow)" + +# }}} diff --git a/dot_vimrc b/dot_vimrc index e5c164a..8d7733d 100644 --- a/dot_vimrc +++ b/dot_vimrc @@ -91,7 +91,7 @@ set wildmode=list:longest set wildignore=*.docx,*.jpg,*.png,*.gif,*.pdf,*.pyc,*.exe,*.flv,*.img,*.xlsx " Permit the recognition of alias by vim -set shell=/bin/zsh +set shell=/bin/bash set shellcmdflag=-ic " PLUGINS ---------------------------------------------------------------- {{{ diff --git a/dot_zshrc b/dot_zshrc index 34ea263..10bcf7e 100644 --- a/dot_zshrc +++ b/dot_zshrc @@ -24,13 +24,6 @@ fi source $ZSH/zinit.zsh -# Theme ---------------------------------------------------------------- {{{ - -# Set the theme to use with Oh My Posh -eval "$(oh-my-posh init zsh --config $HOME/.config/ohmyposh/prompt.json)" - -# }}} - # General options ---------------------------------------------------------------- {{{ # Uncomment the following line to use case-sensitive completion. @@ -94,10 +87,6 @@ setopt hist_ignore_all_dups # Ignore all duplicate commands setopt hist_save_no_dups # Do not save duplicate commands setopt hist_find_no_dups # Do not display duplicate commands -# Key bindings -bindkey "^p" history-search-backward # Search backward in history -bindkey "^n" history-search-forward # Search forward in history - # }}} # Completion ---------------------------------------------------------------- {{{ @@ -115,7 +104,35 @@ zstyle ':completion:*' list-colors '${(s.:.)LS_COLORS}' autoload -Uz +X compinit && compinit autoload -Uz +X bashcompinit && bashcompinit - # -q is for quiet; actually run all the `compdef's saved before `compinit` call +# Setup custom completions +mkdir -p "$HOME/.completions" + +# Check if the command exists and if the completion file does not exist, generate it +generate_completion() { + local cmd=$1 + local out_file="$HOME/.completions/$2" + local gen_cmd=$3 + + if command -v "$cmd" > /dev/null 2>&1 && [ ! -f "$out_file" ]; then + eval "$gen_cmd" + echo "Generated completion for $cmd" + fi +} + +generate_completion "atuin" "atuin.zsh" "atuin gen-completions --shell zsh --out-dir \$HOME/.completions/" +generate_completion "chezmoi" "chezmoi.zsh" "chezmoi completion zsh --output=\$HOME/.completions/chezmoi.zsh" +generate_completion "rip" "rip.zsh" "rip completions zsh > \$HOME/.completions/rip.zsh" + +# The default name of the completion file for atuin is `_atuin` +# as it follows the convention of zsh_completions files +# Rename it to `atuin.zsh` to be consistent with the other custom completion files +if [ -f "$HOME/.completions/_atuin" ]; then mv "$HOME/.completions/_atuin" "$HOME/.completions/atuin.zsh"; fi + +source "$HOME/.completions/atuin.zsh" +source "$HOME/.completions/chezmoi.zsh" +source "$HOME/.completions/rip.zsh" + +# -q is for quiet; actually run all the `compdef's saved before `compinit` call # (`compinit' declares the `compdef' function, so it cannot be used until # `compinit' is ran; Zinit solves this via intercepting the `compdef'-calls and # storing them for later use with `zinit cdreplay') @@ -127,8 +144,13 @@ zinit cdreplay -q # User configuration ---------------------------------------------------------------- {{{ +# Compilation flags +# export ARCHFLAGS="-arch x86_64" + +# SSH Configuration ---------------------------------------------------------------- {{{ + # Preferred editor for local and remote sessions -if [[ -n $SSH_CONNECTION ]]; then +if [[ ! -n $SSH_CONNECTION ]]; then export EDITOR='nvim' else export EDITOR='vim' @@ -138,17 +160,21 @@ fi if ! pgrep -u "$USER" ssh-agent > /dev/null; then eval "$(ssh-agent -s)" > /dev/null fi -export SSH_AUTH_SOCK=$(ssh-agent -s | grep -oP '(?<=SSH_AUTH_SOCK=)[^;]+') -# Add the keys to the agent -if [ -f ~/.ssh/id_ed25519 ] && ! ssh-add -l | grep -q id_ed25519; then - ssh-add ~/.ssh/id_ed25519 > /dev/null 2>&1 -fi -if [ -f ~/.ssh/hexasec ] && ! ssh-add -l | grep -q hexasec; then - ssh-add ~/.ssh/hexasec > /dev/null 2>&1 -fi -# Compilation flags -# export ARCHFLAGS="-arch x86_64" +# Add the keys to the agent +add_ssh_key() { + local key_path=$1 + local key_name=$(basename "$key_path") + if [ -f "$key_path" ] && ! ssh-add -l | grep -q "$key_name"; then + ssh-add "$key_path" > /dev/null 2>&1 + fi +} + +# Personal SSH keys +add_ssh_key ~/.ssh/id_ed25519 +add_ssh_key ~/.ssh/hexasec + +# }}} # Aliases ---------------------------------------------------------------- {{{ @@ -172,10 +198,21 @@ alias vim='nvim' # }}} + +# }}} + +# Shell enhancements initialization ---------------------------------------------------------------- {{{ + # Allow zoxide to work and to replace cd eval "$(zoxide init --cmd cd zsh)" # Initialize atuin -eval "$(atuin init zsh --disable-up-arrow)" +# eval "$(atuin init zsh --disable-up-arrow)" + +# Set the theme to use with Oh My Posh +eval "$(oh-my-posh init zsh --config $HOME/.config/ohmyposh/prompt.json)" + +# Or Starship +eval "$(starship init zsh)" # }}} diff --git a/private_dot_config/chezmoi/chezmoi.toml.tmpl b/private_dot_config/chezmoi/chezmoi.toml.tmpl index ae4daa5..92e72e7 100644 --- a/private_dot_config/chezmoi/chezmoi.toml.tmpl +++ b/private_dot_config/chezmoi/chezmoi.toml.tmpl @@ -30,8 +30,8 @@ encryption = "age" {{- end }} [git] - autoCommit = true - autoPush = true + autoCommit = false + autoPush = false commitMessageTemplatePath = "~/.gitmessage" [git.commit] diff --git a/private_dot_config/fish/config.fish b/private_dot_config/fish/config.fish index 2aa8062..f8ff0f8 100644 --- a/private_dot_config/fish/config.fish +++ b/private_dot_config/fish/config.fish @@ -1,58 +1,123 @@ +############################################################################################################ +# +# ██████╗ ██████╗ ███╗ ██╗███████╗██╗ ██████╗ ███████╗██╗███████╗██╗ ██╗ +# ██╔════╝██╔═══██╗████╗ ██║██╔════╝██║██╔════╝ ██╔════╝██║██╔════╝██║ ██║ +# ██║ ██║ ██║██╔██╗ ██║█████╗ ██║██║ ███╗ █████╗ ██║███████╗███████║ +# ██║ ██║ ██║██║╚██╗██║██╔══╝ ██║██║ ██║ ██╔══╝ ██║╚════██║██╔══██║ +# ╚██████╗╚██████╔╝██║ ╚████║██║ ██║╚██████╔╝██╗██║ ██║███████║██║ ██║ +# ╚═════╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═════╝ ╚═╝╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝ +# +############################################################################################################ + +# Fish configuration ------------------------------------------------------------- {{{ + set fish_greeting -# Plugins installation and configuration -# The fish_inclusion variable is used to avoid multiple inclusions of the plugins -# because of the fish configuration file being sourced every time fisher is called -# Everything related to the plugins must be in the if block -if not set -q fish_inclusion +export LS_COLORS="$(vivid generate gruvbox-dark)" - set -U fish_inclusion 1 +# Plugins installation and configuration ------------------------------------------------------------- {{{ - function install_fisher_plugin - set -l plugin_path $argv[1] - set -l plugin_name $argv[2] +# Check if fisher is installed +if not set -q _fisher_plugins + curl -sL https://raw.githubusercontent.com/jorgebucaran/fisher/main/functions/fisher.fish | source && fisher install jorgebucaran/fisher +end - if not test -e $plugin_path - if test $plugin_name = "jorgebucaran/fisher" - # Install Fisher - curl -sL https://raw.githubusercontent.com/jorgebucaran/fisher/main/functions/fisher.fish | source && fisher install $plugin_name - else - fisher install $plugin_name - end +# Configuration for automatic Fisher package manager updates +# Update interval is set to one day (86400 seconds) +set -g FISHER_UPDATE_INTERVAL 86400 +set -g fisher_update_timestamp_file ~/.cache/fisher_last_update + +# Get the last modification timestamp of a file +function get_file_timestamp + stat --format=%Y "$argv[1]" 2>/dev/null +end + +# Check if Fisher needs to be updated based on the timestamp file +function needs_update + set -l current_time (date +%s) + if not test -e "$fisher_update_timestamp_file" + return 0 end - end - - install_fisher_plugin ~/.config/fish/functions/fisher.fish jorgebucaran/fisher - install_fisher_plugin ~/.config/fish/functions/theme_gruvbox.fish jomik/fish-gruvbox # Gruvbox theme for bg and fg - install_fisher_plugin ~/.config/fish/conf.d/gruvbox.fish sujaybokil/fish-gruvbox # Gruvbox theme for syntax highlighting - install_fisher_plugin ~/.config/fish/conf.d/autopair.fish jorgebucaran/autopair.fish - install_fisher_plugin ~/.config/fish/conf.d/sponge.fish meaningful-ooo/sponge - install_fisher_plugin ~/.config/fish/conf.d/abbr_tips.fish gazorby/fish-abbreviation-tips - install_fisher_plugin ~/.config/fish/conf.d/venv.fish nakulj/auto-venv - install_fisher_plugin ~/.config/fish/conf.d/color-manual.fish goranmoomin/fish-color-manual - - theme_gruvbox dark soft - - set sponge_regex_patterns '^\s+.*' - set sponge_allow_previously_successful true - - set -eU fish_inclusion + set -l file_time (get_file_timestamp "$fisher_update_timestamp_file") + test "$current_time" -gt 0 -a "$file_time" -gt 0 + and test (math "$current_time - $file_time") -gt $FISHER_UPDATE_INTERVAL end -# Set the ssh agent -if not pgrep ssh-agent > /dev/null - eval (ssh-agent -c | string split ';') -end -set -x SSH_AUTH_SOCK (ssh-agent -s | grep -oP '(?<=SSH_AUTH_SOCK=)[^;]+') -# Set the ssh keys -if [ -f ~/.ssh/id_ed25519 ]; and not ssh-add -l | grep -q id_ed25519 - ssh-add ~/.ssh/id_ed25519 > /dev/null 2>&1 -end -if [ -f ~/.ssh/hexasec ]; and not ssh-add -l | grep -q hexasec - ssh-add ~/.ssh/hexasec > /dev/null 2>&1 +# Update Fisher packages if needed and update timestamp +function update_fisher + mkdir -p (dirname $fisher_update_timestamp_file) + if needs_update + fisher update > /dev/null 2>&1 + touch "$fisher_update_timestamp_file" + end end -# Set personal aliases +# Run Fisher update check only in interactive shells +if status is-interactive + update_fisher +end + +theme_gruvbox dark soft + +set sponge_regex_patterns '^\s+.*' +set sponge_allow_previously_successful true + +# }}} + +# Completion ------------------------------------------------------------- {{{ + +if command -v atuin >/dev/null 2>&1 && not test -f $HOME/.config/fish/completions/atuin.fish + atuin gen-completions --shell fish --out-dir $HOME/.config/fish/completions + echo "Atuin completions generated" +end + +if command -v chezmoi >/dev/null 2>&1 && not test -f $HOME/.config/fish/completions/chezmoi.fish + chezmoi completion fish --output=$HOME/.config/fish/completions/chezmoi.fish + echo "Chezmoi completions generated" +end + +if command -v rip >/dev/null 2>&1 && not test -f $HOME/.config/fish/completions/rip.fish + rip completion fish > $HOME/.config/fish/completions/rip.fish + echo "Rip completions generated" +end + +# }}} + +# }}} + +# User configuration ---------------------------------------------------------------- {{{ + +# SSH Configuration ---------------------------------------------------------------- {{{ + +# Preferred editor for local and remote sessions +if not set -q SSH_CONNECTION + set -x EDITOR nvim +else + set -x EDITOR vim +end + +# Set the ssh agent if it is not already running +if not pgrep ssh-agent >/dev/null + eval (ssh-agent -s) +end + +# Function to add SSH keys to the agent +function add_ssh_key + set key_path $argv[1] + set key_name (basename $key_path) + if test -f $key_path; and not ssh-add -l | grep -q $key_name + ssh-add $key_path > /dev/null 2>&1 + end +end + +# Add personal SSH keys +add_ssh_key ~/.ssh/id_ed25519 +add_ssh_key ~/.ssh/hexasec + +# }}} + +# Aliases ---------------------------------------------------------------- {{{ + # For a full list of active aliases, run `alias`. alias ls='lsd' alias ll='ls -alF' @@ -70,11 +135,26 @@ alias maj='~/./miseajour.sh' alias vi=(which vim) alias vim='nvim' +# }}} + +# }}} + +# Shell enhancements initialization ---------------------------------------------------------------- {{{ + # Set the Oh-My-Posh prompt -oh-my-posh init fish --config $HOME/.config/ohmyposh/prompt.json | source +#oh-my-posh init fish --config $HOME/.config/ohmyposh/prompt.json | source + +# Or Starship +function starship_transient_prompt_func + starship module character +end +starship init fish | source +enable_transience # Allow zoxide to work and to replace cd zoxide init --cmd cd fish | source # Set atuin atuin init fish | source + +# }}} diff --git a/private_dot_config/kitty/kitty.conf b/private_dot_config/kitty/kitty.conf index c5ded03..3657d69 100644 --- a/private_dot_config/kitty/kitty.conf +++ b/private_dot_config/kitty/kitty.conf @@ -1,4 +1,13 @@ -# vim:fileencoding=utf-8:ft=conf:foldmethod=marker +######################################################################################################## +# +# ██╗ ██╗██╗████████╗████████╗██╗ ██╗ ██████╗ ██████╗ ███╗ ██╗███████╗ +# ██║ ██╔╝██║╚══██╔══╝╚══██╔══╝╚██╗ ██╔╝██╔════╝██╔═══██╗████╗ ██║██╔════╝ +# █████╔╝ ██║ ██║ ██║ ╚████╔╝ ██║ ██║ ██║██╔██╗ ██║█████╗ +# ██╔═██╗ ██║ ██║ ██║ ╚██╔╝ ██║ ██║ ██║██║╚██╗██║██╔══╝ +# ██║ ██╗██║ ██║ ██║ ██║██╗╚██████╗╚██████╔╝██║ ╚████║██║ +# ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ +# +######################################################################################################## #: Fonts {{{ @@ -12,76 +21,68 @@ italic_font auto bold_italic_font auto #: You can specify different fonts for the bold/italic/bold-italic -#: variants. To get a full list of supported fonts use the `kitty -#: list-fonts` command. By default they are derived automatically, by -#: the OSes font system. Setting them manually is useful for font -#: families that have many weight variants like Book, Medium, Thick, -#: etc. For example:: - -#: font_family Operator Mono Book -#: bold_font Operator Mono Medium -#: italic_font Operator Mono Book Italic -#: bold_italic_font Operator Mono Medium Italic +#: variants. The easiest way to select fonts is to run the `kitten +#: choose-fonts` command which will present a nice UI for you to +#: select the fonts you want with previews and support for selecting +#: variable fonts and font features. If you want to learn to select +#: fonts manually, read the font specification syntax +#: . font_size 13.0 -#: Font size (in pts) +#: Font size (in pts). -force_ltr no +# force_ltr no #: kitty does not support BIDI (bidirectional text), however, for RTL #: scripts, words are automatically displayed in RTL. That is to say, #: in an RTL script, the words "HELLO WORLD" display in kitty as #: "WORLD HELLO", and if you try to select a substring of an RTL- #: shaped string, you will get the character that would be there had -#: the the string been LTR. For example, assuming the Hebrew word -#: ירושלים, selecting the character that on the screen appears to be ם -#: actually writes into the selection buffer the character י. kitty's -#: default behavior is useful in conjunction with a filter to reverse -#: the word order, however, if you wish to manipulate RTL glyphs, it -#: can be very challenging to work with, so this option is provided to -#: turn it off. Furthermore, this option can be used with the command -#: line program GNU FriBidi -#: to get BIDI -#: support, because it will force kitty to always treat the text as -#: LTR, which FriBidi expects for terminals. - -adjust_line_height 0 -adjust_column_width 0 - -#: Change the size of each character cell kitty renders. You can use -#: either numbers, which are interpreted as pixels or percentages -#: (number followed by %), which are interpreted as percentages of the -#: unmodified values. You can use negative pixels or percentages less -#: than 100% to reduce sizes (but this might cause rendering -#: artifacts). - -adjust_baseline 0 - -#: Adjust the vertical alignment of text (the height in the cell at -#: which text is positioned). You can use either numbers, which are -#: interpreted as pixels or a percentages (number followed by %), -#: which are interpreted as the percentage of the line height. A -#: positive value moves the baseline up, and a negative value moves -#: them down. The underline and strikethrough positions are adjusted -#: accordingly. +#: the string been LTR. For example, assuming the Hebrew word ירושלים, +#: selecting the character that on the screen appears to be ם actually +#: writes into the selection buffer the character י. kitty's default +#: behavior is useful in conjunction with a filter to reverse the word +#: order, however, if you wish to manipulate RTL glyphs, it can be +#: very challenging to work with, so this option is provided to turn +#: it off. Furthermore, this option can be used with the command line +#: program GNU FriBidi +#: to get BIDI support, because it will force kitty to always treat +#: the text as LTR, which FriBidi expects for terminals. symbol_map U+23FB-U+23FE,U+2665,U+26A1,U+2B58,U+E000-U+E00A,U+E0A0-U+E0A3,U+E0B0-U+E0D4,U+E200-U+E2A9,U+E300-U+E3E3,U+E5FA-U+E6AA,U+E700-U+E7C5,U+EA60-U+EBEB,U+F000-U+F2E0,U+F300-U+F32F,U+F400-U+F4A9,U+F500-U+F8FF,U+F0001-U+F1AF0 JetBrainsMono Nerd Font -#: Map the specified unicode codepoints to a particular font. Useful +#: E.g. symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols + +#: Map the specified Unicode codepoints to a particular font. Useful #: if you need special rendering for some symbols, such as for -#: Powerline. Avoids the need for patched fonts. Each unicode code -#: point is specified in the form U+. You +#: Powerline. Avoids the need for patched fonts. Each Unicode code +#: point is specified in the form `U+`. You #: can specify multiple code points, separated by commas and ranges -#: separated by hyphens. symbol_map itself can be specified multiple -#: times. Syntax is:: +#: separated by hyphens. This option can be specified multiple times. +#: The syntax is:: #: symbol_map codepoints Font Family Name +# narrow_symbols + +#: E.g. narrow_symbols U+E0A0-U+E0A3,U+E0C0-U+E0C7 1 + +#: Usually, for Private Use Unicode characters and some symbol/dingbat +#: characters, if the character is followed by one or more spaces, +#: kitty will use those extra cells to render the character larger, if +#: the character in the font has a wide aspect ratio. Using this +#: option you can force kitty to restrict the specified code points to +#: render in the specified number of cells (defaulting to one cell). +#: This option can be specified multiple times. The syntax is:: + +#: narrow_symbols codepoints [optionally the number of cells] + disable_ligatures never #: Choose how you want to handle multi-character ligatures. The -#: default is to always render them. You can tell kitty to not render +#: default is to always render them. You can tell kitty to not render #: them when the cursor is over them by using cursor to make editing #: easier, or have kitty never render them at all by using always, if #: you don't like them. The ligature strategy can be set per-window @@ -94,20 +95,26 @@ disable_ligatures never #: Note that this refers to programming ligatures, typically #: implemented using the calt OpenType feature. For disabling general -#: ligatures, use the font_features setting. +#: ligatures, use the font_features option. -# font_features none +# font_features -#: Choose exactly which OpenType features to enable or disable. This -#: is useful as some fonts might have features worthwhile in a -#: terminal. For example, Fira Code Retina includes a discretionary -#: feature, zero, which in that font changes the appearance of the -#: zero (0), to make it more easily distinguishable from Ø. Fira Code -#: Retina also includes other discretionary features known as -#: Stylistic Sets which have the tags ss01 through ss20. +#: E.g. font_features none + +#: Choose exactly which OpenType features to enable or disable. Note +#: that for the main fonts, features can be specified when selecting +#: the font using the choose-fonts kitten. This setting is useful for +#: fallback fonts. + +#: Some fonts might have features worthwhile in a terminal. For +#: example, Fira Code includes a discretionary feature, zero, which in +#: that font changes the appearance of the zero (0), to make it more +#: easily distinguishable from Ø. Fira Code also includes other +#: discretionary features known as Stylistic Sets which have the tags +#: ss01 through ss20. #: For the exact syntax to use for individual features, see the -#: Harfbuzz documentation . #: Note that this code is indexed by PostScript name, and not the font @@ -115,32 +122,22 @@ disable_ligatures never #: e.g. you can disable a feature in the italic font but not in the #: regular font. -#: On Linux, these are read from the FontConfig database first and -#: then this, setting is applied, so they can be configured in a +#: On Linux, font features are first read from the FontConfig database +#: and then this option is applied, so they can be configured in a #: single, central place. -#: To get the PostScript name for a font, use kitty + list-fonts -#: --psnames: - -#: .. code-block:: sh - -#: $ kitty + list-fonts --psnames | grep Fira -#: Fira Code -#: Fira Code Bold (FiraCode-Bold) -#: Fira Code Light (FiraCode-Light) -#: Fira Code Medium (FiraCode-Medium) -#: Fira Code Regular (FiraCode-Regular) -#: Fira Code Retina (FiraCode-Retina) - -#: The part in brackets is the PostScript name. +#: To get the PostScript name for a font, use the `fc-scan file.ttf` +#: command on Linux or the `Font Book tool on macOS +#: `__. #: Enable alternate zero and oldstyle numerals:: #: font_features FiraCode-Retina +zero +onum -#: Enable only alternate zero:: +#: Enable only alternate zero in the bold font:: -#: font_features FiraCode-Retina +zero +#: font_features FiraCode-Bold +zero #: Disable the normal ligatures, but keep the calt feature which (in #: this font) breaks up monotony:: @@ -153,52 +150,207 @@ disable_ligatures never #: font_features UnifontMedium +isol -medi -fina -init +# modify_font + +#: Modify font characteristics such as the position or thickness of +#: the underline and strikethrough. The modifications can have the +#: suffix px for pixels or % for percentage of original value. No +#: suffix means use pts. For example:: + +#: modify_font underline_position -2 +#: modify_font underline_thickness 150% +#: modify_font strikethrough_position 2px + +#: Additionally, you can modify the size of the cell in which each +#: font glyph is rendered and the baseline at which the glyph is +#: placed in the cell. For example:: + +#: modify_font cell_width 80% +#: modify_font cell_height -2px +#: modify_font baseline 3 + +#: Note that modifying the baseline will automatically adjust the +#: underline and strikethrough positions by the same amount. +#: Increasing the baseline raises glyphs inside the cell and +#: decreasing it lowers them. Decreasing the cell size might cause +#: rendering artifacts, so use with care. + box_drawing_scale 0.001, 1, 1.5, 2 -#: Change the sizes of the lines used for the box drawing unicode -#: characters These values are in pts. They will be scaled by the -#: monitor DPI to arrive at a pixel value. There must be four values -#: corresponding to thin, normal, thick, and very thick lines. +#: The sizes of the lines used for the box drawing Unicode characters. +#: These values are in pts. They will be scaled by the monitor DPI to +#: arrive at a pixel value. There must be four values corresponding to +#: thin, normal, thick, and very thick lines. + +undercurl_style thin-sparse + +#: The style with which undercurls are rendered. This option takes the +#: form (thin|thick)-(sparse|dense). Thin and thick control the +#: thickness of the undercurl. Sparse and dense control how often the +#: curl oscillates. With sparse the curl will peak once per character, +#: with dense twice. + +# text_composition_strategy platform + +#: Control how kitty composites text glyphs onto the background color. +#: The default value of platform tries for text rendering as close to +#: "native" for the platform kitty is running on as possible. + +#: A value of legacy uses the old (pre kitty 0.28) strategy for how +#: glyphs are composited. This will make dark text on light +#: backgrounds look thicker and light text on dark backgrounds +#: thinner. It might also make some text appear like the strokes are +#: uneven. + +#: You can fine tune the actual contrast curve used for glyph +#: composition by specifying up to two space-separated numbers for +#: this setting. + +#: The first number is the gamma adjustment, which controls the +#: thickness of dark text on light backgrounds. Increasing the value +#: will make text appear thicker. The default value for this is 1.0 on +#: Linux and 1.7 on macOS. Valid values are 0.01 and above. The result +#: is scaled based on the luminance difference between the background +#: and the foreground. Dark text on light backgrounds receives the +#: full impact of the curve while light text on dark backgrounds is +#: affected very little. + +#: The second number is an additional multiplicative contrast. It is +#: percentage ranging from 0 to 100. The default value is 0 on Linux +#: and 30 on macOS. + +#: If you wish to achieve similar looking thickness in light and dark +#: themes, a good way to experiment is start by setting the value to +#: 1.0 0 and use a dark theme. Then adjust the second parameter until +#: it looks good. Then switch to a light theme and adjust the first +#: parameter until the perceived thickness matches the dark theme. + +# text_fg_override_threshold 0 + +#: The minimum accepted difference in luminance between the foreground +#: and background color, below which kitty will override the +#: foreground color. It is percentage ranging from 0 to 100. If the +#: difference in luminance of the foreground and background is below +#: this threshold, the foreground color will be set to white if the +#: background is dark or black if the background is light. The default +#: value is 0, which means no overriding is performed. Useful when +#: working with applications that use colors that do not contrast well +#: with your preferred color scheme. + +#: WARNING: Some programs use characters (such as block characters) +#: for graphics display and may expect to be able to set the +#: foreground and background to the same color (or similar colors). +#: If you see unexpected stripes, dots, lines, incorrect color, no +#: color where you expect color, or any kind of graphic display +#: problem try setting text_fg_override_threshold to 0 to see if this +#: is the cause of the problem. #: }}} -#: Cursor customization {{{ +#: Text cursor customization {{{ -cursor #cccccc +# cursor #cccccc -#: Default cursor color +#: Default text cursor color. If set to the special value none the +#: cursor will be rendered with a "reverse video" effect. Its color +#: will be the color of the text in the cell it is over and the text +#: will be rendered with the background color of the cell. Note that +#: if the program running in the terminal sets a cursor color, this +#: takes precedence. Also, the cursor colors are modified if the cell +#: background and foreground colors have very low contrast. Note that +#: some themes set this value, so if you want to override it, place +#: your value after the lines where the theme file is included. -cursor_text_color #111111 +# cursor_text_color #111111 -#: Choose the color of text under the cursor. If you want it rendered -#: with the background color of the cell underneath instead, use the -#: special keyword: background +#: The color of text under the cursor. If you want it rendered with +#: the background color of the cell underneath instead, use the +#: special keyword: `background`. Note that if cursor is set to none +#: then this option is ignored. Note that some themes set this value, +#: so if you want to override it, place your value after the lines +#: where the theme file is included. cursor_shape block -#: The cursor shape can be one of (block, beam, underline). Note that +#: The cursor shape can be one of block, beam, underline. Note that #: when reloading the config this will be changed only if the cursor -#: shape has not been set by the program running in the terminal. +#: shape has not been set by the program running in the terminal. This +#: sets the default cursor shape, applications running in the terminal +#: can override it. In particular, shell integration +#: in kitty sets +#: the cursor shape to beam at shell prompts. You can avoid this by +#: setting shell_integration to no-cursor. + +cursor_shape_unfocused hollow + +#: Defines the text cursor shape when the OS window is not focused. +#: The unfocused cursor shape can be one of block, beam, underline, +#: hollow and unchanged (leave the cursor shape as it is). cursor_beam_thickness 1.5 -#: Defines the thickness of the beam cursor (in pts) +#: The thickness of the beam cursor (in pts). cursor_underline_thickness 2.0 -#: Defines the thickness of the underline cursor (in pts) +#: The thickness of the underline cursor (in pts). cursor_blink_interval -1 -#: The interval (in seconds) at which to blink the cursor. Set to zero -#: to disable blinking. Negative values mean use system default. Note -#: that numbers smaller than repaint_delay will be limited to -#: repaint_delay. +#: The interval to blink the cursor (in seconds). Set to zero to +#: disable blinking. Negative values mean use system default. Note +#: that the minimum interval will be limited to repaint_delay. You can +#: also animate the cursor blink by specifying an easing function. For +#: example, setting this to option to 0.5 ease-in-out will cause the +#: cursor blink to be animated over a second, in the first half of the +#: second it will go from opaque to transparent and then back again +#: over the next half. You can specify different easing functions for +#: the two halves, for example: -1 linear ease-out. kitty supports all +#: the CSS easing functions . Note that turning on animations +#: uses extra power as it means the screen is redrawn multiple times +#: per blink interval. See also, cursor_stop_blinking_after. cursor_stop_blinking_after 15.0 #: Stop blinking cursor after the specified number of seconds of -#: keyboard inactivity. Set to zero to never stop blinking. +#: keyboard inactivity. Set to zero to never stop blinking. + +# cursor_trail 0 + +#: Set this to a value larger than zero to enable a "cursor trail" +#: animation. This is an animation that shows a "trail" following the +#: movement of the text cursor. It makes it easy to follow large +#: cursor jumps and makes for a cool visual effect of the cursor +#: zooming around the screen. The actual value of this option controls +#: when the animation is triggered. It is a number of milliseconds. +#: The trail animation only follows cursors that have stayed in their +#: position for longer than the specified number of milliseconds. This +#: prevents trails from appearing for cursors that rapidly change +#: their positions during UI updates in complex applications. See +#: cursor_trail_decay to control the animation speed and +#: cursor_trail_start_threshold to control when a cursor trail is +#: started. + +# cursor_trail_decay 0.1 0.4 + +#: Controls the decay times for the cursor trail effect when the +#: cursor_trail is enabled. This option accepts two positive float +#: values specifying the fastest and slowest decay times in seconds. +#: The first value corresponds to the fastest decay time (minimum), +#: and the second value corresponds to the slowest decay time +#: (maximum). The second value must be equal to or greater than the +#: first value. Smaller values result in a faster decay of the cursor +#: trail. Adjust these values to control how quickly the cursor trail +#: fades away. + +# cursor_trail_start_threshold 2 + +#: Set the distance threshold for starting the cursor trail. This +#: option accepts a positive integer value that represents the minimum +#: number of cells the cursor must move before the trail is started. +#: When the cursor moves less than this threshold, the trail is +#: skipped, reducing unnecessary cursor trail animation. #: }}} @@ -215,6 +367,14 @@ scrollback_lines 2000 #: is changed it will only affect newly created windows, not existing #: ones. +# scrollback_indicator_opacity 1.0 + +#: The opacity of the scrollback indicator which is a small colored +#: rectangle that moves along the right hand side of the window as you +#: scroll, indicating what fraction you have scrolled. The default is +#: one which means fully opaque, aka visible. Set to a value between +#: zero and one to make the indicator less visible. + scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER #: Program with which to view scrollback in a new window. The @@ -223,16 +383,18 @@ scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER #: for colors and text formatting. INPUT_LINE_NUMBER in the command #: line above will be replaced by an integer representing which line #: should be at the top of the screen. Similarly CURSOR_LINE and -#: CURSOR_COLUMN will be replaced by the current cursor position. +#: CURSOR_COLUMN will be replaced by the current cursor position or +#: set to 0 if there is no cursor, for example, when showing the last +#: command output. scrollback_pager_history_size 0 -#: Separate scrollback history size, used only for browsing the -#: scrollback buffer (in MB). This separate buffer is not available -#: for interactive scrolling but will be piped to the pager program -#: when viewing scrollback buffer in a separate window. The current -#: implementation stores the data in UTF-8, so approximatively 10000 -#: lines per megabyte at 100 chars per line, for pure ASCII text, +#: Separate scrollback history size (in MB), used only for browsing +#: the scrollback buffer with pager. This separate buffer is not +#: available for interactive scrolling but will be piped to the pager +#: program when viewing scrollback buffer in a separate window. The +#: current implementation stores the data in UTF-8, so approximately +#: 10000 lines per megabyte at 100 chars per line, for pure ASCII, #: unformatted text. A value of zero or less disables this feature. #: The maximum allowed size is 4GB. Note that on config reload if this #: is changed it will only affect newly created windows, not existing @@ -245,16 +407,27 @@ scrollback_fill_enlarged_window no wheel_scroll_multiplier 5.0 -#: Modify the amount scrolled by the mouse wheel. Note this is only -#: used for low precision scrolling devices, not for high precision -#: scrolling on platforms such as macOS and Wayland. Use negative -#: numbers to change scroll direction. +#: Multiplier for the number of lines scrolled by the mouse wheel. +#: Note that this is only used for low precision scrolling devices, +#: not for high precision scrolling devices on platforms such as macOS +#: and Wayland. Use negative numbers to change scroll direction. See +#: also wheel_scroll_min_lines. + +# wheel_scroll_min_lines 1 + +#: The minimum number of lines scrolled by the mouse wheel. The scroll +#: multiplier wheel_scroll_multiplier only takes effect after it +#: reaches this number. Note that this is only used for low precision +#: scrolling devices like wheel mice that scroll by very small amounts +#: when using the wheel. With a negative number, the minimum number of +#: lines will always be added. touch_scroll_multiplier 1.0 -#: Modify the amount scrolled by a touchpad. Note this is only used -#: for high precision scrolling devices on platforms such as macOS and -#: Wayland. Use negative numbers to change scroll direction. +#: Multiplier for the number of lines scrolled by a touchpad. Note +#: that this is only used for high precision scrolling devices on +#: platforms such as macOS and Wayland. Use negative numbers to change +#: scroll direction. #: }}} @@ -273,15 +446,17 @@ url_color #0087bd url_style curly #: The color and style for highlighting URLs on mouse-over. url_style -#: can be one of: none, single, double, curly +#: can be one of: none, straight, double, curly, dotted, dashed. open_url_with default -#: The program with which to open URLs that are clicked on. The -#: special value default means to use the operating system's default -#: URL handler. +#: The program to open clicked URLs. The special value default will +#: first look for any URL handlers defined via the open_actions +#: facility and if non +#: are found, it will use the Operating System's default URL handler +#: (open on macOS and xdg-open on Linux). -url_prefixes http https file ftp gemini irc gopher mailto news git +url_prefixes file ftp ftps gemini git gopher http https irc ircs kitty mailto news sftp ssh #: The set of URL prefixes to look for when detecting a URL under the #: mouse cursor. @@ -290,41 +465,102 @@ detect_urls yes #: Detect URLs under the mouse. Detected URLs are highlighted with an #: underline and the mouse cursor becomes a hand over them. Even if -#: this option is disabled, URLs are still clickable. +#: this option is disabled, URLs are still clickable. See also the +#: underline_hyperlinks option to control how hyperlinks (as opposed +#: to plain text URLs) are displayed. -url_excluded_characters +url_excluded_characters #: Additional characters to be disallowed from URLs, when detecting -#: URLs under the mouse cursor. By default, all characters legal in -#: URLs are allowed. +#: URLs under the mouse cursor. By default, all characters that are +#: legal in URLs are allowed. Additionally, newlines are allowed (but +#: stripped). This is to accommodate programs such as mutt that add +#: hard line breaks even for continued lines. \n can be added to this +#: option to disable this behavior. Special characters can be +#: specified using backslash escapes, to specify a backslash use a +#: double backslash. + +show_hyperlink_targets no + +#: When the mouse hovers over a terminal hyperlink, show the actual +#: URL that will be activated when the hyperlink is clicked. + +underline_hyperlinks hover + +#: Control how hyperlinks are underlined. They can either be +#: underlined on mouse hover, always (i.e. permanently underlined) or +#: never which means that kitty will not apply any underline styling +#: to hyperlinks. Note that the value of always only applies to real +#: (OSC 8) hyperlinks not text that is detected to be a URL on mouse +#: hover. Uses the url_style and url_color settings for the underline +#: style. Note that reloading the config and changing this value +#: to/from always will only affect text subsequently received by +#: kitty. copy_on_select no #: Copy to clipboard or a private buffer on select. With this set to -#: clipboard, simply selecting text with the mouse will cause the text -#: to be copied to clipboard. Useful on platforms such as macOS that -#: do not have the concept of primary selections. You can instead -#: specify a name such as a1 to copy to a private kitty buffer -#: instead. Map a shortcut with the paste_from_buffer action to paste -#: from this private buffer. For example:: +#: clipboard, selecting text with the mouse will cause the text to be +#: copied to clipboard. Useful on platforms such as macOS that do not +#: have the concept of primary selection. You can instead specify a +#: name such as a1 to copy to a private kitty buffer. Map a shortcut +#: with the paste_from_buffer action to paste from this private +#: buffer. For example:: -#: map cmd+shift+v paste_from_buffer a1 +#: copy_on_select a1 +#: map shift+cmd+v paste_from_buffer a1 #: Note that copying to the clipboard is a security risk, as all #: programs, including websites open in your browser can read the #: contents of the system clipboard. +paste_actions quote-urls-at-prompt,confirm + +#: A comma separated list of actions to take when pasting text into +#: the terminal. The supported paste actions are: + +#: quote-urls-at-prompt: +#: If the text being pasted is a URL and the cursor is at a shell prompt, +#: automatically quote the URL (needs shell_integration). +#: replace-dangerous-control-codes +#: Replace dangerous control codes from pasted text, without confirmation. +#: replace-newline +#: Replace the newline character from pasted text, without confirmation. +#: confirm: +#: Confirm the paste if the text to be pasted contains any terminal control codes +#: as this can be dangerous, leading to code execution if the shell/program running +#: in the terminal does not properly handle these. +#: confirm-if-large +#: Confirm the paste if it is very large (larger than 16KB) as pasting +#: large amounts of text into shells can be very slow. +#: filter: +#: Run the filter_paste() function from the file paste-actions.py in +#: the kitty config directory on the pasted text. The text returned by the +#: function will be actually pasted. +#: no-op: +#: Has no effect. + strip_trailing_spaces never #: Remove spaces at the end of lines when copying to clipboard. A #: value of smart will do it when using normal selections, but not -#: rectangle selections. always will always do it. +#: rectangle selections. A value of always will always do it. select_by_word_characters @-./_~?&=%+# #: Characters considered part of a word when double clicking. In #: addition to these characters any character that is marked as an -#: alphanumeric character in the unicode database will be matched. +#: alphanumeric character in the Unicode database will be matched. + +select_by_word_characters_forward + +#: Characters considered part of a word when extending the selection +#: forward on double clicking. In addition to these characters any +#: character that is marked as an alphanumeric character in the +#: Unicode database will be matched. + +#: If empty (default) select_by_word_characters will be used for both +#: directions. click_interval -1.0 @@ -332,103 +568,181 @@ click_interval -1.0 #: clicks (in seconds). Negative numbers will use the system default #: instead, if available, or fallback to 0.5. -focus_follows_mouse no +focus_follows_mouse yes #: Set the active window to the window under the mouse when moving the -#: mouse around +#: mouse around. On macOS, this will also cause the OS Window under +#: the mouse to be focused automatically when the mouse enters it. pointer_shape_when_grabbed arrow #: The shape of the mouse pointer when the program running in the -#: terminal grabs the mouse. Valid values are: arrow, beam and hand +#: terminal grabs the mouse. default_pointer_shape beam -#: The default shape of the mouse pointer. Valid values are: arrow, -#: beam and hand +#: The default shape of the mouse pointer. pointer_shape_when_dragging beam #: The default shape of the mouse pointer when dragging across text. -#: Valid values are: arrow, beam and hand #: Mouse actions {{{ -#: Mouse buttons can be remapped to perform arbitrary actions. The -#: syntax for doing so is: +#: Mouse buttons can be mapped to perform arbitrary actions. The +#: syntax is: #: .. code-block:: none #: mouse_map button-name event-type modes action -#: Where ``button-name`` is one of ``left``, ``middle``, ``right`` or -#: ``b1 ... b8`` with added keyboard modifiers, for example: -#: ``ctrl+shift+left`` refers to holding the ctrl+shift keys while -#: clicking with the left mouse button. The number ``b1 ... b8`` can -#: be used to refer to upto eight buttons on a mouse. +#: Where button-name is one of left, middle, right, b1 ... b8 with +#: added keyboard modifiers. For example: ctrl+shift+left refers to +#: holding the Ctrl+Shift keys while clicking with the left mouse +#: button. The value b1 ... b8 can be used to refer to up to eight +#: buttons on a mouse. -#: ``event-type`` is one ``press``, ``release``, ``doublepress``, -#: ``triplepress``, ``click`` and ``doubleclick``. ``modes`` -#: indicates whether the action is performed when the mouse is grabbed -#: by the program running in the terminal, or not. It can have one or -#: more or the values, ``grabbed,ungrabbed``. ``grabbed`` refers to -#: when the program running in the terminal has requested mouse -#: events. Note that the click and double click events have a delay of -#: click_interval to disambiguate from double and triple presses. +#: event-type is one of press, release, doublepress, triplepress, +#: click, doubleclick. modes indicates whether the action is performed +#: when the mouse is grabbed by the program running in the terminal, +#: or not. The values are grabbed or ungrabbed or a comma separated +#: combination of them. grabbed refers to when the program running in +#: the terminal has requested mouse events. Note that the click and +#: double click events have a delay of click_interval to disambiguate +#: from double and triple presses. #: You can run kitty with the kitty --debug-input command line option #: to see mouse events. See the builtin actions below to get a sense #: of what is possible. -#: If you want to unmap an action map it to ``no-op``. For example, to +#: If you want to unmap a button, map it to nothing. For example, to #: disable opening of URLs with a plain click:: -#: mouse_map left click ungrabbed no-op +#: mouse_map left click ungrabbed + +#: See all the mappable actions including mouse actions here +#: . #: .. note:: #: Once a selection is started, releasing the button that started it will #: automatically end it and no release event will be dispatched. -mouse_map left click ungrabbed mouse_click_url_or_select -mouse_map shift+left click grabbed,ungrabbed mouse_click_url_or_select -mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_click_url +# clear_all_mouse_actions no -#: Variant with ctrl+shift is present because the simple click based -#: version has an unavoidable delay of click_interval, to disambiguate -#: clicks from double clicks. +#: Remove all mouse action definitions up to this point. Useful, for +#: instance, to remove the default mouse actions. + +#: Click the link under the mouse or move the cursor + +mouse_map left click ungrabbed mouse_handle_click selection link prompt + +#:: First check for a selection and if one exists do nothing. Then +#:: check for a link under the mouse cursor and if one exists, click +#:: it. Finally check if the click happened at the current shell +#:: prompt and if so, move the cursor to the click location. Note +#:: that this requires shell integration +#:: to work. + +#: Click the link under the mouse or move the cursor even when grabbed + +mouse_map shift+left click grabbed,ungrabbed mouse_handle_click selection link prompt + +#:: Same as above, except that the action is performed even when the +#:: mouse is grabbed by the program running in the terminal. + +#: Click the link under the mouse cursor + +mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_handle_click link + +#:: Variant with Ctrl+Shift is present because the simple click based +#:: version has an unavoidable delay of click_interval, to +#:: disambiguate clicks from double clicks. + +#: Discard press event for link click mouse_map ctrl+shift+left press grabbed discard_event -#: Prevent this press event from being sent to the program that has -#: grabbed the mouse, as the corresponding release event is used to -#: open a URL. +#:: Prevent this press event from being sent to the program that has +#:: grabbed the mouse, as the corresponding release event is used to +#:: open a URL. + +#: Paste from the primary selection + +mouse_map middle release ungrabbed paste_from_selection + +#: Start selecting text + +mouse_map left press ungrabbed mouse_selection normal + +#: Start selecting text in a rectangle -mouse_map middle release ungrabbed paste_from_selection -mouse_map left press ungrabbed mouse_selection normal mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle -mouse_map left doublepress ungrabbed mouse_selection word -mouse_map left triplepress ungrabbed mouse_selection line -#: Select the entire line +#: Select a word + +mouse_map left doublepress ungrabbed mouse_selection word + +#: Select a line + +mouse_map left triplepress ungrabbed mouse_selection line + +#: Select line from point mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point -#: Select from the clicked point to the end of the line +#:: Select from the clicked point to the end of the line. If you +#:: would like to select the word at the point and then extend to the +#:: rest of the line, change `line_from_point` to +#:: `word_and_line_from_point`. -mouse_map right press ungrabbed mouse_selection extend -mouse_map shift+middle release ungrabbed,grabbed paste_selection -mouse_map shift+left press ungrabbed,grabbed mouse_selection normal -mouse_map shift+ctrl+alt+left press ungrabbed,grabbed mouse_selection rectangle -mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word -mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line +#: Extend the current selection -#: Select the entire line +mouse_map right press ungrabbed mouse_selection extend -mouse_map shift+ctrl+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point +#:: If you want only the end of the selection to be moved instead of +#:: the nearest boundary, use move-end instead of extend. -#: Select from the clicked point to the end of the line +#: Paste from the primary selection even when grabbed + +mouse_map shift+middle release ungrabbed,grabbed paste_selection +mouse_map shift+middle press grabbed discard_event + +#: Start selecting text even when grabbed + +mouse_map shift+left press ungrabbed,grabbed mouse_selection normal + +#: Start selecting text in a rectangle even when grabbed + +mouse_map ctrl+shift+alt+left press ungrabbed,grabbed mouse_selection rectangle + +#: Select a word even when grabbed + +mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word + +#: Select a line even when grabbed + +mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line + +#: Select line from point even when grabbed + +mouse_map ctrl+shift+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point + +#:: Select from the clicked point to the end of the line even when +#:: grabbed. If you would like to select the word at the point and +#:: then extend to the rest of the line, change `line_from_point` to +#:: `word_and_line_from_point`. + +#: Extend the current selection even when grabbed mouse_map shift+right press ungrabbed,grabbed mouse_selection extend + +#: Show clicked command output in pager + +mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output + +#:: Requires shell integration +#:: to work. + #: }}} #: }}} @@ -437,30 +751,31 @@ mouse_map shift+right press ungrabbed,grabbed mouse_selection extend repaint_delay 10 -#: Delay (in milliseconds) between screen updates. Decreasing it, +#: Delay between screen updates (in milliseconds). Decreasing it, #: increases frames-per-second (FPS) at the cost of more CPU usage. #: The default value yields ~100 FPS which is more than sufficient for -#: most uses. Note that to actually achieve 100 FPS you have to either -#: set sync_to_monitor to no or use a monitor with a high refresh -#: rate. Also, to minimize latency when there is pending input to be -#: processed, repaint_delay is ignored. +#: most uses. Note that to actually achieve 100 FPS, you have to +#: either set sync_to_monitor to no or use a monitor with a high +#: refresh rate. Also, to minimize latency when there is pending input +#: to be processed, this option is ignored. input_delay 3 -#: Delay (in milliseconds) before input from the program running in -#: the terminal is processed. Note that decreasing it will increase +#: Delay before input from the program running in the terminal is +#: processed (in milliseconds). Note that decreasing it will increase #: responsiveness, but also increase CPU usage and might cause flicker #: in full screen programs that redraw the entire screen on each loop, #: because kitty is so fast that partial screen updates will be drawn. +#: This setting is ignored when the input buffer is almost full. sync_to_monitor yes #: Sync screen updates to the refresh rate of the monitor. This -#: prevents tearing (https://en.wikipedia.org/wiki/Screen_tearing) -#: when scrolling. However, it limits the rendering speed to the -#: refresh rate of your monitor. With a very high speed mouse/high -#: keyboard repeat rate, you may notice some slight input latency. If -#: so, set this to no. +#: prevents screen tearing +#: when scrolling. +#: However, it limits the rendering speed to the refresh rate of your +#: monitor. With a very high speed mouse/high keyboard repeat rate, +#: you may notice some slight input latency. If so, set this to no. #: }}} @@ -468,40 +783,88 @@ sync_to_monitor yes enable_audio_bell yes -#: Enable/disable the audio bell. Useful in environments that require +#: The audio bell. Useful to disable it in environments that require #: silence. visual_bell_duration 0.0 -#: Visual bell duration. Flash the screen when a bell occurs for the -#: specified number of seconds. Set to zero to disable. +#: The visual bell duration (in seconds). Flash the screen when a bell +#: occurs for the specified number of seconds. Set to zero to disable. +#: The flash is animated, fading in and out over the specified +#: duration. The easing function used for the fading can be +#: controlled. For example, 2.0 linear will casuse the flash to fade +#: in and out linearly. The default if unspecified is to use ease-in- +#: out which fades slowly at the start, middle and end. You can +#: specify different easing functions for the fade-in and fade-out +#: parts, like this: 2.0 ease-in linear. kitty supports all the CSS +#: easing functions . + +visual_bell_color none + +#: The color used by visual bell. Set to none will fall back to +#: selection background color. If you feel that the visual bell is too +#: bright, you can set it to a darker color. window_alert_on_bell yes #: Request window attention on bell. Makes the dock icon bounce on -#: macOS or the taskbar flash on linux. +#: macOS or the taskbar flash on Linux. -bell_on_tab yes +bell_on_tab "🔔 " -#: Show a bell symbol on the tab if a bell occurs in one of the -#: windows in the tab and the window is not the currently focused -#: window +#: Some text or a Unicode symbol to show on the tab if a window in the +#: tab that does not have focus has a bell. If you want to use leading +#: or trailing spaces, surround the text with quotes. See +#: tab_title_template for how this is rendered. + +#: For backwards compatibility, values of yes, y and true are +#: converted to the default bell symbol and no, n, false and none are +#: converted to the empty string. command_on_bell none -#: Program to run when a bell occurs. +#: Program to run when a bell occurs. The environment variable +#: KITTY_CHILD_CMDLINE can be used to get the program running in the +#: window in which the bell occurred. + +bell_path none + +#: Path to a sound file to play as the bell sound. If set to none, the +#: system default bell sound is used. Must be in a format supported by +#: the operating systems sound API, such as WAV or OGA on Linux +#: (libcanberra) or AIFF, MP3 or WAV on macOS (NSSound). + +# linux_bell_theme __custom + +#: The XDG Sound Theme kitty will use to play the bell sound. Defaults +#: to the custom theme name specified in the XDG Sound theme +#: specification , falling back to the default +#: freedesktop theme if it does not exist. To change your sound theme +#: desktop wide, create +#: :file:~/.local/share/sounds/__custom/index.theme` with the +#: contents: + +#: [Sound Theme] + +#: Inherits=name-of-the-sound-theme-you-want-to-use + +#: Replace name-of-the-sound-theme-you-want-to-use with the actual +#: theme name. Now all compliant applications should use sounds from +#: this theme. #: }}} #: Window layout {{{ -remember_window_size no +remember_window_size yes initial_window_width 800 initial_window_height 500 -#: If enabled, the window size will be remembered so that new +#: If enabled, the OS Window size will be remembered so that new #: instances of kitty will have the same size as the previous -#: instance. If disabled, the window will initially have size +#: instance. If disabled, the OS Window will initially have size #: configured by initial_window_width/height, in pixels. You can use a #: suffix of "c" on the width/height values to have them interpreted #: as number of cells instead of pixels. @@ -512,30 +875,30 @@ enabled_layouts * #: The special value all means all layouts. The first listed layout #: will be used as the startup layout. Default configuration is all #: layouts in alphabetical order. For a list of available layouts, see -#: the https://sw.kovidgoyal.net/kitty/index.html#layouts. +#: the layouts . window_resize_step_cells 2 window_resize_step_lines 2 #: The step size (in units of cell width/cell height) to use when -#: resizing windows. The cells value is used for horizontal resizing -#: and the lines value for vertical resizing. +#: resizing kitty windows in a layout with the shortcut +#: start_resizing_window. The cells value is used for horizontal +#: resizing, and the lines value is used for vertical resizing. window_border_width 0.5pt #: The width of window borders. Can be either in pixels (px) or pts #: (pt). Values in pts will be rounded to the nearest number of pixels -#: based on screen resolution. If not specified the unit is assumed to -#: be pts. Note that borders are displayed only when more than one +#: based on screen resolution. If not specified, the unit is assumed +#: to be pts. Note that borders are displayed only when more than one #: window is visible. They are meant to separate multiple windows. draw_minimal_borders yes #: Draw only the minimum borders needed. This means that only the -#: minimum needed borders for inactive windows are drawn. That is only -#: the borders that separate the inactive window from a neighbor. Note -#: that setting a non-zero window margin overrides this and causes all -#: borders to be drawn. +#: borders that separate the window from a neighbor are drawn. Note +#: that setting a non-zero window_margin_width overrides this and +#: causes all borders to be drawn. window_margin_width 0 @@ -546,12 +909,11 @@ window_margin_width 0 single_window_margin_width -1 -#: The window margin (in pts) to use when only a single window is -#: visible. Negative values will cause the value of -#: window_margin_width to be used instead. A single value sets all -#: four sides. Two values set the vertical and horizontal sides. Three -#: values set top, horizontal and bottom. Four values set top, right, -#: bottom and left. +#: The window margin to use when only a single window is visible (in +#: pts). Negative values will cause the value of window_margin_width +#: to be used instead. A single value sets all four sides. Two values +#: set the vertical and horizontal sides. Three values set top, +#: horizontal and bottom. Four values set top, right, bottom and left. window_padding_width 0 @@ -560,28 +922,38 @@ window_padding_width 0 #: the vertical and horizontal sides. Three values set top, horizontal #: and bottom. Four values set top, right, bottom and left. +# single_window_padding_width -1 + +#: The window padding to use when only a single window is visible (in +#: pts). Negative values will cause the value of window_padding_width +#: to be used instead. A single value sets all four sides. Two values +#: set the vertical and horizontal sides. Three values set top, +#: horizontal and bottom. Four values set top, right, bottom and left. + placement_strategy center #: When the window size is not an exact multiple of the cell size, the #: cell area of the terminal window will have some extra padding on #: the sides. You can control how that padding is distributed with #: this option. Using a value of center means the cell area will be -#: placed centrally. A value of top-left means the padding will be on -#: only the bottom and right edges. +#: placed centrally. A value of top-left means the padding will be +#: only at the bottom and right edges. The value can be one of: top- +#: left, top, top-right, left, center, right, bottom-left, bottom, +#: bottom-right. -active_border_color #00ff00 +# active_border_color #00ff00 #: The color for the border of the active window. Set this to none to #: not draw borders around the active window. -inactive_border_color #cccccc +# inactive_border_color #cccccc -#: The color for the border of inactive windows +#: The color for the border of inactive windows. -bell_border_color #ff5a00 +# bell_border_color #ff5a00 #: The color for the border of inactive windows in which a bell has -#: occurred +#: occurred. inactive_text_alpha 1.0 @@ -591,41 +963,93 @@ inactive_text_alpha 1.0 hide_window_decorations yes #: Hide the window decorations (title-bar and window borders) with -#: yes. On macOS, titlebar-only can be used to only hide the titlebar. -#: Whether this works and exactly what effect it has depends on the -#: window manager/operating system. Note that the effects of changing -#: this setting when reloading config are undefined. +#: yes. On macOS, titlebar-only and titlebar-and-corners can be used +#: to only hide the titlebar and the rounded corners. Whether this +#: works and exactly what effect it has depends on the window +#: manager/operating system. Note that the effects of changing this +#: option when reloading config are undefined. When using titlebar- +#: only, it is useful to also set window_margin_width and +#: placement_strategy to prevent the rounded corners from clipping +#: text. Or use titlebar-and-corners. -resize_debounce_time 0.1 +# window_logo_path none -#: The time (in seconds) to wait before redrawing the screen when a -#: resize event is received. On platforms such as macOS, where the -#: operating system sends events corresponding to the start and end of -#: a resize, this number is ignored. +#: Path to a logo image. Must be in PNG/JPEG/WEBP/GIF/TIFF/BMP format. +#: Relative paths are interpreted relative to the kitty config +#: directory. The logo is displayed in a corner of every kitty window. +#: The position is controlled by window_logo_position. Individual +#: windows can be configured to have different logos either using the +#: launch action or the remote control +#: facility. -resize_draw_strategy static +# window_logo_position bottom-right -#: Choose how kitty draws a window while a resize is in progress. A -#: value of static means draw the current window contents, mostly -#: unchanged. A value of scale means draw the current window contents -#: scaled. A value of blank means draw a blank window. A value of size -#: means show the window size in cells. +#: Where to position the window logo in the window. The value can be +#: one of: top-left, top, top-right, left, center, right, bottom-left, +#: bottom, bottom-right. + +# window_logo_alpha 0.5 + +#: The amount the logo should be faded into the background. With zero +#: being fully faded and one being fully opaque. + +# window_logo_scale 0 + +#: The percentage (0-100] of the window size to which the logo should +#: scale. Using a single number means the logo is scaled to that +#: percentage of the shortest window dimension, while preserving +#: aspect ratio of the logo image. + +#: Using two numbers means the width and height of the logo are scaled +#: to the respective percentage of the window's width and height. + +#: Using zero as the percentage disables scaling in that dimension. A +#: single zero (the default) disables all scaling of the window logo. + +resize_debounce_time 0.1 0.5 + +#: The time to wait (in seconds) before asking the program running in +#: kitty to resize and redraw the screen during a live resize of the +#: OS window, when no new resize events have been received, i.e. when +#: resizing is either paused or finished. On platforms such as macOS, +#: where the operating system sends events corresponding to the start +#: and end of a live resize, the second number is used for redraw- +#: after-pause since kitty can distinguish between a pause and end of +#: resizing. On such systems the first number is ignored and redraw is +#: immediate after end of resize. On other systems only the first +#: number is used so that kitty is "ready" quickly after the end of +#: resizing, while not also continuously redrawing, to save energy. resize_in_steps no #: Resize the OS window in steps as large as the cells, instead of -#: with the usual pixel accuracy. Combined with an -#: initial_window_width and initial_window_height in number of cells, -#: this option can be used to keep the margins as small as possible -#: when resizing the OS window. Note that this does not currently work -#: on Wayland. +#: with the usual pixel accuracy. Combined with initial_window_width +#: and initial_window_height in number of cells, this option can be +#: used to keep the margins as small as possible when resizing the OS +#: window. Note that this does not currently work on Wayland. + +# visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ + +#: The list of characters for visual window selection. For example, +#: for selecting a window to focus on with focus_visible_window. The +#: value should be a series of unique numbers or alphabets, case +#: insensitive, from the set 0-9A-Z\-=[];',./\\`. Specify your +#: preference as a string of characters. confirm_os_window_close 0 -#: Ask for confirmation when closing an OS window or a tab that has at -#: least this number of kitty windows in it. A value of zero disables -#: confirmation. This confirmation also applies to requests to quit -#: the entire application (all OS windows, via the quit action). +#: Ask for confirmation when closing an OS window or a tab with at +#: least this number of kitty windows in it by window manager (e.g. +#: clicking the window close button or pressing the operating system +#: shortcut to close windows) or by the close_tab action. A value of +#: zero disables confirmation. This confirmation also applies to +#: requests to quit the entire application (all OS windows, via the +#: quit action). Negative values are converted to positive ones, +#: however, with shell_integration enabled, using negative values +#: means windows sitting at a shell prompt are not counted, only +#: windows where some command is currently running. Note that if you +#: want confirmation when closing individual windows, you can map the +#: close_window_with_confirmation action. #: }}} @@ -633,33 +1057,54 @@ confirm_os_window_close 0 tab_bar_edge bottom -#: Which edge to show the tab bar on, top or bottom +#: The edge to show the tab bar on, top or bottom. tab_bar_margin_width 0.0 -#: The margin to the left and right of the tab bar (in pts) +#: The margin to the left and right of the tab bar (in pts). tab_bar_margin_height 0.0 0.0 #: The margin above and below the tab bar (in pts). The first number -#: is the margin between the edge of the OS Window and the tab bar and -#: the second number is the margin between the tab bar and the +#: is the margin between the edge of the OS Window and the tab bar. +#: The second number is the margin between the tab bar and the #: contents of the current tab. tab_bar_style fade -#: The tab bar style, can be one of: fade, separator, powerline, or -#: hidden. In the fade style, each tab's edges fade into the -#: background color, in the separator style, tabs are separated by a -#: configurable separator, and the powerline shows the tabs as a -#: continuous line. If you use the hidden style, you might want to -#: create a mapping for the select_tab action which presents you with -#: a list of tabs and allows for easy switching to a tab. +#: The tab bar style, can be one of: + +#: fade +#: Each tab's edges fade into the background color. (See also tab_fade) +#: slant +#: Tabs look like the tabs in a physical file. +#: separator +#: Tabs are separated by a configurable separator. (See also +#: tab_separator) +#: powerline +#: Tabs are shown as a continuous line with "fancy" separators. +#: (See also tab_powerline_style) +#: custom +#: A user-supplied Python function called draw_tab is loaded from the file +#: tab_bar.py in the kitty config directory. For examples of how to +#: write such a function, see the functions named draw_tab_with_* in +#: kitty's source code: kitty/tab_bar.py. See also +#: this discussion +#: for examples from kitty users. +#: hidden +#: The tab bar is hidden. If you use this, you might want to create +#: a mapping for the select_tab action which presents you with a list of +#: tabs and allows for easy switching to a tab. + +tab_bar_align left + +#: The horizontal alignment of the tab bar, can be one of: left, +#: center, right. tab_bar_min_tabs 2 #: The minimum number of tabs that must exist before the tab bar is -#: shown +#: shown. tab_switch_strategy previous @@ -687,120 +1132,215 @@ tab_powerline_style angled #: The powerline separator style between tabs in the tab bar when #: using powerline as the tab_bar_style, can be one of: angled, -#: slanted, or round. +#: slanted, round. tab_activity_symbol none -#: Some text or a unicode symbol to show on the tab if a window in the -#: tab that does not have focus has some activity. +#: Some text or a Unicode symbol to show on the tab if a window in the +#: tab that does not have focus has some activity. If you want to use +#: leading or trailing spaces, surround the text with quotes. See +#: tab_title_template for how this is rendered. -tab_title_template "{title}" +# tab_title_max_length 0 + +#: The maximum number of cells that can be used to render the text in +#: a tab. A value of zero means that no limit is applied. + +tab_title_template {index}: {title} #: A template to render the tab title. The default just renders the -#: title. If you wish to include the tab-index as well, use something -#: like: {index}: {title}. Useful if you have shortcuts mapped for -#: goto_tab N. If you prefer to see the index as a superscript, use -#: {sup.index}. In addition you can use {layout_name} for the current -#: layout name and {num_windows} for the number of windows in the tab. +#: title with optional symbols for bell and activity. If you wish to +#: include the tab-index as well, use something like: {index}:{title}. +#: Useful if you have shortcuts mapped for goto_tab N. If you prefer +#: to see the index as a superscript, use {sup.index}. All data +#: available is: + +#: title +#: The current tab title. +#: index +#: The tab index usable with goto_tab N goto_tab shortcuts. +#: layout_name +#: The current layout name. +#: num_windows +#: The number of windows in the tab. +#: num_window_groups +#: The number of window groups (a window group is a window and all of its overlay windows) in the tab. +#: tab.active_wd +#: The working directory of the currently active window in the tab +#: (expensive, requires syscall). Use active_oldest_wd to get +#: the directory of the oldest foreground process rather than the newest. +#: tab.active_exe +#: The name of the executable running in the foreground of the currently +#: active window in the tab (expensive, requires syscall). Use +#: active_oldest_exe for the oldest foreground process. +#: max_title_length +#: The maximum title length available. +#: keyboard_mode +#: The name of the current keyboard mode or the empty string if no keyboard mode is active. + #: Note that formatting is done by Python's string formatting #: machinery, so you can use, for instance, {layout_name[:2].upper()} #: to show only the first two letters of the layout name, upper-cased. #: If you want to style the text, you can use styling directives, for -#: example: {fmt.fg.red}red{fmt.fg.default}normal{fmt.bg._00FF00}green -#: bg{fmt.bg.normal}. Similarly, for bold and italic: -#: {fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}. +#: example: +#: `{fmt.fg.red}red{fmt.fg.tab}normal{fmt.bg._00FF00}greenbg{fmt.bg.tab}`. +#: Similarly, for bold and italic: +#: `{fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}`. +#: The 256 eight terminal colors can be used as `fmt.fg.color0` +#: through `fmt.fg.color255`. Note that for backward compatibility, if +#: {bell_symbol} or {activity_symbol} are not present in the template, +#: they are prepended to it. -active_tab_title_template none +# active_tab_title_template none -#: Template to use for active tabs, if not specified falls back to +#: Template to use for active tabs. If not specified falls back to #: tab_title_template. active_tab_foreground #000 -active_tab_background #eee -active_tab_font_style bold-italic +active_tab_background #73D216 +active_tab_font_style italic inactive_tab_foreground #444 inactive_tab_background #999 inactive_tab_font_style normal -#: Tab bar colors and styles +#: Tab bar colors and styles. -tab_bar_background none +# tab_bar_background none #: Background color for the tab bar. Defaults to using the terminal #: background color. +# tab_bar_margin_color none + +#: Color for the tab bar margin area. Defaults to using the terminal +#: background color for margins above and below the tab bar. For side +#: margins the default color is chosen to match the background color +#: of the neighboring tab. + #: }}} #: Color scheme {{{ -foreground #dddddd -background #000000 +# BEGIN_KITTY_THEME +# Gruvbox Dark Soft +include theme.conf +# END_KITTY_THEME -#: The foreground and background colors +# foreground #dddddd +# background #000000 + +#: The foreground and background colors. background_opacity 1.00 -#: The opacity of the background. A number between 0 and 1, where 1 is -#: opaque and 0 is fully transparent. This will only work if +#: The opacity of the background. A number between zero and one, where +#: one is opaque and zero is fully transparent. This will only work if #: supported by the OS (for instance, when using a compositor under #: X11). Note that it only sets the background color's opacity in #: cells that have the same background color as the default terminal -#: background. This is so that things like the status bar in vim, -#: powerline prompts, etc. still look good. But it means that if you -#: use a color theme with a background color in your editor, it will -#: not be rendered as transparent. Instead you should change the -#: default background color in your kitty config and not use a -#: background color in the editor color scheme. Or use the escape -#: codes to set the terminals default colors in a shell script to -#: launch your editor. Be aware that using a value less than 1.0 is a -#: (possibly significant) performance hit. If you want to dynamically -#: change transparency of windows set dynamic_background_opacity to -#: yes (this is off by default as it has a performance cost). Changing -#: this setting when reloading the config will only work if -#: dynamic_background_opacity was enabled in the original config. +#: background, so that things like the status bar in vim, powerline +#: prompts, etc. still look good. But it means that if you use a color +#: theme with a background color in your editor, it will not be +#: rendered as transparent. Instead you should change the default +#: background color in your kitty config and not use a background +#: color in the editor color scheme. Or use the escape codes to set +#: the terminals default colors in a shell script to launch your +#: editor. See also transparent_background_colors. Be aware that using +#: a value less than 1.0 is a (possibly significant) performance hit. +#: When using a low value for this setting, it is desirable that you +#: set the background color to a color the matches the general color +#: of the desktop background, for best text rendering. If you want to +#: dynamically change transparency of windows, set +#: dynamic_background_opacity to yes (this is off by default as it has +#: a performance cost). Changing this option when reloading the config +#: will only work if dynamic_background_opacity was enabled in the +#: original config. + +background_blur 0 + +#: Set to a positive value to enable background blur (blurring of the +#: visuals behind a transparent window) on platforms that support it. +#: Only takes effect when background_opacity is less than one. On +#: macOS, this will also control the blur radius (amount of blurring). +#: Setting it to too high a value will cause severe performance issues +#: and/or rendering artifacts. Usually, values up to 64 work well. +#: Note that this might cause performance issues, depending on how the +#: platform implements it, so use with care. Currently supported on +#: macOS and KDE. background_image none -#: Path to a background image. Must be in PNG format. +#: Path to a background image. Must be in PNG/JPEG/WEBP/TIFF/GIF/BMP +#: format. -background_image_layout tiled +# background_image_layout tiled -#: Whether to tile or scale the background image. +#: Whether to tile, scale or clamp the background image. The value can +#: be one of tiled, mirror-tiled, scaled, clamped, centered or +#: cscaled. The scaled and cscaled values scale the image to the +#: window size, with cscaled preserving the image aspect ratio. -background_image_linear no +# background_image_linear no #: When background image is scaled, whether linear interpolation #: should be used. -dynamic_background_opacity no +# transparent_background_colors + +#: A space separated list of upto 7 colors, with opacity. When the +#: background color of a cell matches one of these colors, it is +#: rendered semi-transparent using the specified opacity. + +#: Useful in more complex UIs like editors where you could want more +#: than a single background color to be rendered as transparent, for +#: instance, for a cursor highlight line background or a highlighted +#: block. Terminal applications can set this color using The kitty +#: color control escape code. + +#: The syntax for specifying colors is: color@opacity, where the +#: @opacity part is optional. When unspecified, the value of +#: background_opacity is used. For example:: + +#: transparent_background_colors red@0.5 #00ff00@0.3 + +dynamic_background_opacity yes #: Allow changing of the background_opacity dynamically, using either #: keyboard shortcuts (increase_background_opacity and #: decrease_background_opacity) or the remote control facility. -#: Changing this setting by reloading the config is not supported. +#: Changing this option by reloading the config is not supported. background_tint 0.0 -#: How much to tint the background image by the background color. The -#: tint is applied only under the text area, not margin/borders. Makes -#: it easier to read the text. Tinting is done using the current -#: background color for each window. This setting applies only if -#: background_opacity is set and transparent windows are supported or -#: background_image is set. +#: How much to tint the background image by the background color. This +#: option makes it easier to read the text. Tinting is done using the +#: current background color for each window. This option applies only +#: if background_opacity is set and transparent windows are supported +#: or background_image is set. + +# background_tint_gaps 1.0 + +#: How much to tint the background image at the window gaps by the +#: background color, after applying background_tint. Since this is +#: multiplicative with background_tint, it can be used to lighten the +#: tint over the window gaps for a *separated* look. dim_opacity 0.75 #: How much to dim text that has the DIM/FAINT attribute set. One #: means no dimming and zero means fully dimmed (i.e. invisible). -selection_foreground #000000 +# selection_foreground #000000 +# selection_background #fffacd -#: The foreground for text selected with the mouse. A value of none -#: means to leave the color unchanged. - -selection_background #fffacd - -#: The background for text selected with the mouse. +#: The foreground and background colors for text selected with the +#: mouse. Setting both of these to none will cause a "reverse video" +#: effect for selections, where the selection will be the cell text +#: color and the text will become the cell background color. Setting +#: only selection_foreground to none will cause the foreground color +#: to be used unchanged. Note that these colors can be overridden by +#: the program running in the terminal. #: The color table {{{ @@ -874,8 +1414,6 @@ selection_background #fffacd #: }}} -include ./theme.conf - #: }}} #: Advanced {{{ @@ -883,113 +1421,351 @@ include ./theme.conf shell . #: The shell program to execute. The default value of . means to use +#: the value of of the SHELL environment variable or if unset, #: whatever shell is set as the default shell for the current user. #: Note that on macOS if you change this, you might need to add -#: --login to ensure that the shell starts in interactive mode and -#: reads its startup rc files. +#: --login and --interactive to ensure that the shell starts in +#: interactive mode and reads its startup rc files. Environment +#: variables are expanded in this setting. editor . -#: The console editor to use when editing the kitty config file or -#: similar tasks. A value of . means to use the environment variables -#: VISUAL and EDITOR in that order. Note that this environment -#: variable has to be set not just in your shell startup scripts but -#: system-wide, otherwise kitty will not see it. +#: The terminal based text editor (such as vim or nano) to use when +#: editing the kitty config file or similar tasks. + +#: The default value of . means to use the environment variables +#: VISUAL and EDITOR in that order. If these variables aren't set, +#: kitty will run your shell ($SHELL -l -i -c env) to see if your +#: shell startup rc files set VISUAL or EDITOR. If that doesn't work, +#: kitty will cycle through various known editors (vim, emacs, etc.) +#: and take the first one that exists on your system. close_on_child_death no -#: Close the window when the child process (shell) exits. If no (the -#: default), the terminal will remain open when the child exits as -#: long as there are still processes outputting to the terminal (for -#: example disowned or backgrounded processes). If yes, the window -#: will close as soon as the child process exits. Note that setting it -#: to yes means that any background processes still using the terminal -#: can fail silently because their stdout/stderr/stdin no longer work. +#: Close the window when the child process (usually the shell) exits. +#: With the default value no, the terminal will remain open when the +#: child exits as long as there are still other processes outputting +#: to the terminal (for example disowned or backgrounded processes). +#: When enabled with yes, the window will close as soon as the child +#: process exits. Note that setting it to yes means that any +#: background processes still using the terminal can fail silently +#: because their stdout/stderr/stdin no longer work. + +# remote_control_password + +#: Allow other programs to control kitty using passwords. This option +#: can be specified multiple times to add multiple passwords. If no +#: passwords are present kitty will ask the user for permission if a +#: program tries to use remote control with a password. A password can +#: also *optionally* be associated with a set of allowed remote +#: control actions. For example:: + +#: remote_control_password "my passphrase" get-colors set-colors focus-window focus-tab + +#: Only the specified actions will be allowed when using this +#: password. Glob patterns can be used too, for example:: + +#: remote_control_password "my passphrase" set-tab-* resize-* + +#: To get a list of available actions, run:: + +#: kitten @ --help + +#: A set of actions to be allowed when no password is sent can be +#: specified by using an empty password. For example:: + +#: remote_control_password "" *-colors + +#: Finally, the path to a python module can be specified that provides +#: a function is_cmd_allowed that is used to check every remote +#: control command. For example:: + +#: remote_control_password "my passphrase" my_rc_command_checker.py + +#: Relative paths are resolved from the kitty configuration directory. +#: See rc_custom_auth for details. allow_remote_control no -#: Allow other programs to control kitty. If you turn this on other +#: Allow other programs to control kitty. If you turn this on, other #: programs can control all aspects of kitty, including sending text #: to kitty windows, opening new windows, closing windows, reading the -#: content of windows, etc. Note that this even works over ssh -#: connections. You can chose to either allow any program running -#: within kitty to control it, with yes or only programs that connect -#: to the socket specified with the kitty --listen-on command line -#: option, if you use the value socket-only. The latter is useful if -#: you want to prevent programs running on a remote computer over ssh -#: from controlling kitty. Changing this option by reloading the -#: config will only affect newly created windows. +#: content of windows, etc. Note that this even works over SSH +#: connections. The default setting of no prevents any form of remote +#: control. The meaning of the various values are: + +#: password +#: Remote control requests received over both the TTY device and the socket +#: are confirmed based on passwords, see remote_control_password. + +#: socket-only +#: Remote control requests received over a socket are accepted +#: unconditionally. Requests received over the TTY are denied. +#: See listen_on. + +#: socket +#: Remote control requests received over a socket are accepted +#: unconditionally. Requests received over the TTY are confirmed based on +#: password. + +#: no +#: Remote control is completely disabled. + +#: yes +#: Remote control requests are always accepted. listen_on none -#: Tell kitty to listen to the specified unix/tcp socket for remote -#: control connections. Note that this will apply to all kitty -#: instances. It can be overridden by the kitty --listen-on command -#: line flag. This option accepts only UNIX sockets, such as -#: unix:${TEMP}/mykitty or (on Linux) unix:@mykitty. Environment -#: variables are expanded. If {kitty_pid} is present then it is -#: replaced by the PID of the kitty process, otherwise the PID of the -#: kitty process is appended to the value, with a hyphen. This option -#: is ignored unless you also set allow_remote_control to enable -#: remote control. See the help for kitty --listen-on for more -#: details. Changing this option by reloading the config is not +#: Listen to the specified socket for remote control connections. Note +#: that this will apply to all kitty instances. It can be overridden +#: by the kitty --listen-on command line option. For UNIX sockets, +#: such as unix:${TEMP}/mykitty or unix:@mykitty (on Linux). +#: Environment variables are expanded and relative paths are resolved +#: with respect to the temporary directory. If {kitty_pid} is present, +#: then it is replaced by the PID of the kitty process, otherwise the +#: PID of the kitty process is appended to the value, with a hyphen. +#: For TCP sockets such as tcp:localhost:0 a random port is always +#: used even if a non-zero port number is specified. See the help for +#: kitty --listen-on for more details. Note that this will be ignored +#: unless allow_remote_control is set to either: yes, socket or +#: socket-only. Changing this option by reloading the config is not #: supported. -# env +# env -#: Specify environment variables to set in all child processes. Note -#: that environment variables are expanded recursively, so if you -#: use:: +#: Specify the environment variables to be set in all child processes. +#: Using the name with an equal sign (e.g. env VAR=) will set it to +#: the empty string. Specifying only the name (e.g. env VAR) will +#: remove the variable from the child process' environment. Note that +#: environment variables are expanded recursively, for example:: -#: env MYVAR1=a -#: env MYVAR2=${MYVAR1}/${HOME}/b +#: env VAR1=a +#: env VAR2=${HOME}/${VAR1}/b -#: The value of MYVAR2 will be a//b. +#: The value of VAR2 will be /a/b. + +# filter_notification + +#: Specify rules to filter out notifications sent by applications +#: running in kitty. Can be specified multiple times to create +#: multiple filter rules. A rule specification is of the form +#: field:regexp. A filter rule can match on any of the fields: title, +#: body, app, type. The special value of all filters out all +#: notifications. Rules can be combined using Boolean operators. Some +#: examples:: + +#: filter_notification title:hello or body:"abc.*def" +#: # filter out notification from vim except for ones about updates, (?i) +#: # makes matching case insensitive. +#: filter_notification app:"[ng]?vim" and not body:"(?i)update" +#: # filter out all notifications +#: filter_notification all + +#: The field app is the name of the application sending the +#: notification and type is the type of the notification. Not all +#: applications will send these fields, so you can also match on the +#: title and body of the notification text. More sophisticated +#: programmatic filtering and custom actions on notifications can be +#: done by creating a notifications.py file in the kitty config +#: directory (~/.config/kitty). An annotated sample is available +#: . + +# watcher + +#: Path to python file which will be loaded for watchers +#: . Can be +#: specified more than once to load multiple watchers. The watchers +#: will be added to every kitty window. Relative paths are resolved +#: relative to the kitty config directory. Note that reloading the +#: config will only affect windows created after the reload. + +# exe_search_path + +#: Control where kitty finds the programs to run. The default search +#: order is: First search the system wide PATH, then ~/.local/bin and +#: ~/bin. If still not found, the PATH defined in the login shell +#: after sourcing all its startup files is tried. Finally, if present, +#: the PATH specified by the env option is tried. + +#: This option allows you to prepend, append, or remove paths from +#: this search order. It can be specified multiple times for multiple +#: paths. A simple path will be prepended to the search order. A path +#: that starts with the + sign will be append to the search order, +#: after ~/bin above. A path that starts with the - sign will be +#: removed from the entire search order. For example:: + +#: exe_search_path /some/prepended/path +#: exe_search_path +/some/appended/path +#: exe_search_path -/some/excluded/path update_check_interval 24 -#: Periodically check if an update to kitty is available. If an update -#: is found a system notification is displayed informing you of the -#: available update. The default is to check every 24 hrs, set to zero -#: to disable. Changing this option by reloading the config is not -#: supported. +#: The interval to periodically check if an update to kitty is +#: available (in hours). If an update is found, a system notification +#: is displayed informing you of the available update. The default is +#: to check every 24 hours, set to zero to disable. Update checking is +#: only done by the official binary builds. Distro packages or source +#: builds do not do update checking. Changing this option by reloading +#: the config is not supported. startup_session none #: Path to a session file to use for all kitty instances. Can be -#: overridden by using the kitty --session command line option for -#: individual instances. See -#: https://sw.kovidgoyal.net/kitty/index.html#sessions in the kitty +#: overridden by using the kitty --session =none command line option +#: for individual instances. See sessions +#: in the kitty #: documentation for details. Note that relative paths are interpreted #: with respect to the kitty config directory. Environment variables #: in the path are expanded. Changing this option by reloading the -#: config is not supported. +#: config is not supported. Note that if kitty is invoked with command +#: line arguments specifying a command to run, this option is ignored. -clipboard_control write-clipboard write-primary + clipboard_control write-clipboard write-primary read-clipboard-ask read-primary-ask #: Allow programs running in kitty to read and write from the #: clipboard. You can control exactly which actions are allowed. The -#: set of possible actions is: write-clipboard read-clipboard write- -#: primary read-primary. You can additionally specify no-append to -#: disable kitty's protocol extension for clipboard concatenation. The +#: possible actions are: write-clipboard, read-clipboard, write- +#: primary, read-primary, read-clipboard-ask, read-primary-ask. The #: default is to allow writing to the clipboard and primary selection -#: with concatenation enabled. Note that enabling the read -#: functionality is a security risk as it means that any program, even -#: one running on a remote server via SSH can read your clipboard. +#: and to ask for permission when a program tries to read from the +#: clipboard. Note that disabling the read confirmation is a security +#: risk as it means that any program, even the ones running on a +#: remote server via SSH can read your clipboard. See also +#: clipboard_max_size. + +clipboard_max_size 512 + +#: The maximum size (in MB) of data from programs running in kitty +#: that will be stored for writing to the system clipboard. A value of +#: zero means no size limit is applied. See also clipboard_control. + +# file_transfer_confirmation_bypass + +#: The password that can be supplied to the file transfer kitten +#: to skip the +#: transfer confirmation prompt. This should only be used when +#: initiating transfers from trusted computers, over trusted networks +#: or encrypted transports, as it allows any programs running on the +#: remote machine to read/write to the local filesystem, without +#: permission. allow_hyperlinks yes -#: Process hyperlink (OSC 8) escape sequences. If disabled OSC 8 +#: Process hyperlink escape sequences (OSC 8). If disabled OSC 8 #: escape sequences are ignored. Otherwise they become clickable -#: links, that you can click by holding down ctrl+shift and clicking -#: with the mouse. The special value of ``ask`` means that kitty will -#: ask before opening the link. +#: links, that you can click with the mouse or by using the hints +#: kitten . The +#: special value of ask means that kitty will ask before opening the +#: link when clicked. + +shell_integration enabled + +#: Enable shell integration on supported shells. This enables features +#: such as jumping to previous prompts, browsing the output of the +#: previous command in a pager, etc. on supported shells. Set to +#: disabled to turn off shell integration, completely. It is also +#: possible to disable individual features, set to a space separated +#: list of these values: no-rc, no-cursor, no-title, no-cwd, no- +#: prompt-mark, no-complete, no-sudo. See Shell integration +#: for details. + +allow_cloning ask + +#: Control whether programs running in the terminal can request new +#: windows to be created. The canonical example is clone-in-kitty +#: . +#: By default, kitty will ask for permission for each clone request. +#: Allowing cloning unconditionally gives programs running in the +#: terminal (including over SSH) permission to execute arbitrary code, +#: as the user who is running the terminal, on the computer that the +#: terminal is running on. + +clone_source_strategies venv,conda,env_var,path + +#: Control what shell code is sourced when running clone-in-kitty in +#: the newly cloned window. The supported strategies are: + +#: venv +#: Source the file $VIRTUAL_ENV/bin/activate. This is used by the +#: Python stdlib venv module and allows cloning venvs automatically. +#: conda +#: Run conda activate $CONDA_DEFAULT_ENV. This supports the virtual +#: environments created by conda. +#: env_var +#: Execute the contents of the environment variable +#: KITTY_CLONE_SOURCE_CODE with eval. +#: path +#: Source the file pointed to by the environment variable +#: KITTY_CLONE_SOURCE_PATH. + +#: This option must be a comma separated list of the above values. +#: Only the first valid match, in the order specified, is sourced. + +notify_on_cmd_finish never + +#: Show a desktop notification when a long-running command finishes +#: (needs shell_integration). The possible values are: + +#: never +#: Never send a notification. + +#: unfocused +#: Only send a notification when the window does not have keyboard focus. + +#: invisible +#: Only send a notification when the window both is unfocused and not visible +#: to the user, for example, because it is in an inactive tab or its OS window +#: is not currently active. + +#: always +#: Always send a notification, regardless of window state. + +#: There are two optional arguments: + +#: First, the minimum duration for what is considered a long running +#: command. The default is 5 seconds. Specify a second argument to set +#: the duration. For example: invisible 15. Do not set the value too +#: small, otherwise a command that launches a new OS Window and exits +#: will spam a notification. + +#: Second, the action to perform. The default is notify. The possible +#: values are: + +#: notify +#: Send a desktop notification. The subsequent arguments are optional and specify when +#: the notification is automatically cleared. The set of possible events when the notification is +#: cleared are: focus and next. focus means that when the notification +#: policy is unfocused or invisible the notification is automatically cleared +#: when the window regains focus. The value of next means that the previous notification +#: is cleared when the next notification is shown. The default when no arguments are specified +#: is: focus next. + +#: bell +#: Ring the terminal bell. + +#: command +#: Run a custom command. All subsequent arguments are the cmdline to run. + +#: Some more examples:: + +#: # Send a notification when a command takes more than 5 seconds in an unfocused window +#: notify_on_cmd_finish unfocused +#: # Send a notification when a command takes more than 10 seconds in a invisible window +#: notify_on_cmd_finish invisible 10.0 +#: # Ring a bell when a command takes more than 10 seconds in a invisible window +#: notify_on_cmd_finish invisible 10.0 bell +#: # Run 'notify-send' when a command takes more than 10 seconds in a invisible window +#: # Here %c is replaced by the current command line and %s by the job exit code +#: notify_on_cmd_finish invisible 10.0 command notify-send "job finished with status: %s" %c +#: # Do not clear previous notification when next command finishes or window regains focus +#: notify_on_cmd_finish invisible 5.0 notify term xterm-kitty #: The value of the TERM environment variable to set. Changing this #: can break many terminal programs, only change it if you know what -#: you are doing, not because you read some advice on Stack Overflow +#: you are doing, not because you read some advice on "Stack Overflow" #: to change it. The TERM variable is used by various programs to get #: information about the capabilities and behavior of the terminal. If #: you change it, depending on what programs you run, and how @@ -998,309 +1774,571 @@ term xterm-kitty #: work. Changing this option by reloading the config will only affect #: newly created windows. +# terminfo_type path + +#: The value of the TERMINFO environment variable to set. This +#: variable is used by programs running in the terminal to search for +#: terminfo databases. The default value of path causes kitty to set +#: it to a filesystem location containing the kitty terminfo database. +#: A value of direct means put the entire database into the env var +#: directly. This can be useful when connecting to containers, for +#: example. But, note that not all software supports this. A value of +#: none means do not touch the variable. + +# forward_stdio no + +#: Forward STDOUT and STDERR of the kitty process to child processes. +#: This is useful for debugging as it allows child processes to print +#: to kitty's STDOUT directly. For example, echo hello world +#: >&$KITTY_STDIO_FORWARDED in a shell will print to the parent +#: kitty's STDOUT. Sets the KITTY_STDIO_FORWARDED=fdnum environment +#: variable so child processes know about the forwarding. Note that on +#: macOS this prevents the shell from being run via the login utility +#: so getlogin() will not work in programs run in this session. + +# menu_map + +#: Specify entries for various menus in kitty. Currently only the +#: global menubar on macOS is supported. For example:: + +#: menu_map global "Actions::Launch something special" launch --hold --type=os-window sh -c "echo hello world" + +#: This will create a menu entry named "Launch something special" in +#: an "Actions" menu in the macOS global menubar. Sub-menus can be +#: created by adding more levels separated by the :: characters. + #: }}} #: OS specific tweaks {{{ wayland_titlebar_color system -#: Change the color of the kitty window's titlebar on Wayland systems -#: with client side window decorations such as GNOME. A value of -#: system means to use the default system color, a value of background -#: means to use the background color of the currently active window +#: The color of the kitty window's titlebar on Wayland systems with +#: client side window decorations such as GNOME. A value of system +#: means to use the default system colors, a value of background means +#: to use the background color of the currently active kitty window #: and finally you can use an arbitrary color, such as #12af59 or red. -macos_titlebar_color system +# macos_titlebar_color system -#: Change the color of the kitty window's titlebar on macOS. A value -#: of system means to use the default system color, a value of -#: background means to use the background color of the currently -#: active window and finally you can use an arbitrary color, such as -#: #12af59 or red. WARNING: This option works by using a hack, as -#: there is no proper Cocoa API for it. It sets the background color -#: of the entire window and makes the titlebar transparent. As such it -#: is incompatible with background_opacity. If you want to use both, -#: you are probably better off just hiding the titlebar with -#: hide_window_decorations. +#: The color of the kitty window's titlebar on macOS. A value of +#: system means to use the default system color, light or dark can +#: also be used to set it explicitly. A value of background means to +#: use the background color of the currently active window and finally +#: you can use an arbitrary color, such as #12af59 or red. WARNING: +#: This option works by using a hack when arbitrary color (or +#: background) is configured, as there is no proper Cocoa API for it. +#: It sets the background color of the entire window and makes the +#: titlebar transparent. As such it is incompatible with +#: background_opacity. If you want to use both, you are probably +#: better off just hiding the titlebar with hide_window_decorations. -macos_option_as_alt no +# macos_option_as_alt no -#: Use the option key as an alt key. With this set to no, kitty will -#: use the macOS native Option+Key = unicode character behavior. This -#: will break any Alt+key keyboard shortcuts in your terminal -#: programs, but you can use the macOS unicode input technique. You -#: can use the values: left, right, or both to use only the left, -#: right or both Option keys as Alt, instead. Changing this setting by -#: reloading the config is not supported. +#: Use the Option key as an Alt key on macOS. With this set to no, +#: kitty will use the macOS native Option+Key to enter Unicode +#: character behavior. This will break any Alt+Key keyboard shortcuts +#: in your terminal programs, but you can use the macOS Unicode input +#: technique. You can use the values: left, right or both to use only +#: the left, right or both Option keys as Alt, instead. Note that +#: kitty itself always treats Option the same as Alt. This means you +#: cannot use this option to configure different kitty shortcuts for +#: Option+Key vs. Alt+Key. Also, any kitty shortcuts using +#: Option/Alt+Key will take priority, so that any such key presses +#: will not be passed to terminal programs running inside kitty. +#: Changing this option by reloading the config is not supported. -macos_hide_from_tasks no +# macos_hide_from_tasks no -#: Hide the kitty window from running tasks (⌘+Tab) on macOS. Changing -#: this setting by reloading the config is not supported. +#: Hide the kitty window from running tasks on macOS (⌘+Tab and the +#: Dock). Changing this option by reloading the config is not +#: supported. -macos_quit_when_last_window_closed no +# macos_quit_when_last_window_closed no -#: Have kitty quit when all the top-level windows are closed. By -#: default, kitty will stay running, even with no open windows, as is -#: the expected behavior on macOS. +#: Have kitty quit when all the top-level windows are closed on macOS. +#: By default, kitty will stay running, even with no open windows, as +#: is the expected behavior on macOS. -macos_window_resizable yes +# macos_window_resizable yes -#: Disable this if you want kitty top-level (OS) windows to not be -#: resizable on macOS. Changing this setting by reloading the config -#: will only affect newly created windows. +#: Disable this if you want kitty top-level OS windows to not be +#: resizable on macOS. -macos_thicken_font 0 +# macos_thicken_font 0 #: Draw an extra border around the font with the given width, to -#: increase legibility at small font sizes. For example, a value of -#: 0.75 will result in rendering that looks similar to sub-pixel -#: antialiasing at common font sizes. +#: increase legibility at small font sizes on macOS. For example, a +#: value of 0.75 will result in rendering that looks similar to sub- +#: pixel antialiasing at common font sizes. Note that in modern kitty, +#: this option is obsolete (although still supported). Consider using +#: text_composition_strategy instead. -macos_traditional_fullscreen no +# macos_traditional_fullscreen no -#: Use the traditional full-screen transition, that is faster, but -#: less pretty. +#: Use the macOS traditional full-screen transition, that is faster, +#: but less pretty. -macos_show_window_title_in all +# macos_show_window_title_in all -#: Show or hide the window title in the macOS window or menu-bar. A -#: value of window will show the title of the currently active window -#: at the top of the macOS window. A value of menubar will show the -#: title of the currently active window in the macOS menu-bar, making -#: use of otherwise wasted space. all will show the title everywhere -#: and none hides the title in the window and the menu-bar. +#: Control where the window title is displayed on macOS. A value of +#: window will show the title of the currently active window at the +#: top of the macOS window. A value of menubar will show the title of +#: the currently active window in the macOS global menu bar, making +#: use of otherwise wasted space. A value of all will show the title +#: in both places, and none hides the title. See +#: macos_menubar_title_max_length for how to control the length of the +#: title in the menu bar. -macos_custom_beam_cursor no +# macos_menubar_title_max_length 0 -#: Enable/disable custom mouse cursor for macOS that is easier to see -#: on both light and dark backgrounds. WARNING: this might make your -#: mouse cursor invisible on dual GPU machines. Changing this setting +#: The maximum number of characters from the window title to show in +#: the macOS global menu bar. Values less than one means that there is +#: no maximum limit. + +# macos_custom_beam_cursor no + +#: Use a custom mouse cursor for macOS that is easier to see on both +#: light and dark backgrounds. Nowadays, the default macOS cursor +#: already comes with a white border. WARNING: this might make your +#: mouse cursor invisible on dual GPU machines. Changing this option #: by reloading the config is not supported. +# macos_colorspace srgb + +#: The colorspace in which to interpret terminal colors. The default +#: of srgb will cause colors to match those seen in web browsers. The +#: value of default will use whatever the native colorspace of the +#: display is. The value of displayp3 will use Apple's special +#: snowflake display P3 color space, which will result in over +#: saturated (brighter) colors with some color shift. Reloading +#: configuration will change this value only for newly created OS +#: windows. + linux_display_server auto #: Choose between Wayland and X11 backends. By default, an appropriate #: backend based on the system state is chosen automatically. Set it -#: to x11 or wayland to force the choice. Changing this setting by +#: to x11 or wayland to force the choice. Changing this option by #: reloading the config is not supported. +wayland_enable_ime no + +#: Enable Input Method Extension on Wayland. This is typically used +#: for inputting text in East Asian languages. However, its +#: implementation in Wayland is often buggy and introduces latency +#: into the input loop, so disable this if you know you dont need it. +#: Changing this option by reloading the config is not supported, it +#: will not have any effect. + #: }}} #: Keyboard shortcuts {{{ -#: Keys are identified simply by their lowercase unicode characters. -#: For example: ``a`` for the A key, ``[`` for the left square bracket -#: key, etc. For functional keys, such as ``Enter or Escape`` the -#: names are present at https://sw.kovidgoyal.net/kitty/keyboard- -#: protocol.html#functional-key-definitions. For a list of modifier -#: names, see: GLFW mods -#: +#: Keys are identified simply by their lowercase Unicode characters. +#: For example: a for the A key, [ for the left square bracket key, +#: etc. For functional keys, such as Enter or Escape, the names are +#: present at Functional key definitions +#: . +#: For modifier keys, the names are ctrl (control, ⌃), shift (⇧), alt +#: (opt, option, ⌥), super (cmd, command, ⌘). -#: On Linux you can also use XKB key names to bind keys that are not -#: supported by GLFW. See XKB keys -#: for a list of key names. The name to use is the part -#: after the XKB_KEY_ prefix. Note that you can only use an XKB key -#: name for keys that are not known as GLFW keys. - -#: Finally, you can use raw system key codes to map keys, again only -#: for keys that are not known as GLFW keys. To see the system key -#: code for a key, start kitty with the kitty --debug-input option. -#: Then kitty will output some debug text for every key event. In that -#: text look for ``native_code`` the value of that becomes the key -#: name in the shortcut. For example: - -#: .. code-block:: none - -#: on_key_input: glfw key: 65 native_code: 0x61 action: PRESS mods: 0x0 text: 'a' - -#: Here, the key name for the A key is 0x61 and you can use it with:: - -#: map ctrl+0x61 something - -#: to map ctrl+a to something. - -#: You can use the special action no_op to unmap a keyboard shortcut -#: that is assigned in the default configuration:: - -#: map kitty_mod+space no_op - -#: You can combine multiple actions to be triggered by a single -#: shortcut, using the syntax below:: - -#: map key combine action1 action2 action3 ... - -#: For example:: +#: Simple shortcut mapping is done with the map directive. For full +#: details on advanced mapping including modal and per application +#: maps, see mapping . Some +#: quick examples to illustrate common tasks:: +#: # unmap a keyboard shortcut, passing it to the program running in kitty +#: map kitty_mod+space +#: # completely ignore a keyboard event +#: map ctrl+alt+f1 discard_event +#: # combine multiple actions #: map kitty_mod+e combine : new_window : next_layout +#: # multi-key shortcuts +#: map ctrl+x>ctrl+y>z action -#: this will create a new window and switch to the next available -#: layout - -#: You can use multi-key shortcuts using the syntax shown below:: - -#: map key1>key2>key3 action - -#: For example:: - -#: map ctrl+f>2 set_font_size 20 +#: The full list of actions that can be mapped to key presses is +#: available here . kitty_mod ctrl+shift -#: The value of kitty_mod is used as the modifier for all default -#: shortcuts, you can change it in your kitty.conf to change the -#: modifiers for all the default shortcuts. +#: Special modifier key alias for default shortcuts. You can change +#: the value of this option to alter all default shortcuts that use +#: kitty_mod. clear_all_shortcuts no -#: You can have kitty remove all shortcut definition seen up to this -#: point. Useful, for instance, to remove the default shortcuts. +#: Remove all shortcut definitions up to this point. Useful, for +#: instance, to remove the default shortcuts. -# kitten_alias hints hints --hints-offset=0 +# action_alias -#: You can create aliases for kitten names, this allows overriding the -#: defaults for kitten options and can also be used to shorten -#: repeated mappings of the same kitten with a specific group of -#: options. For example, the above alias changes the default value of -#: kitty +kitten hints --hints-offset to zero for all mappings, -#: including the builtin ones. +#: E.g. action_alias launch_tab launch --type=tab --cwd=current + +#: Define action aliases to avoid repeating the same options in +#: multiple mappings. Aliases can be defined for any action and will +#: be expanded recursively. For example, the above alias allows you to +#: create mappings to launch a new tab in the current working +#: directory without duplication:: + +#: map f1 launch_tab vim +#: map f2 launch_tab emacs + +#: Similarly, to alias kitten invocation:: + +#: action_alias hints kitten hints --hints-offset=0 + +# kitten_alias + +#: E.g. kitten_alias hints hints --hints-offset=0 + +#: Like action_alias above, but specifically for kittens. Generally, +#: prefer to use action_alias. This option is a legacy version, +#: present for backwards compatibility. It causes all invocations of +#: the aliased kitten to be substituted. So the example above will +#: cause all invocations of the hints kitten to have the --hints- +#: offset=0 option applied. #: Clipboard {{{ -map kitty_mod+c copy_to_clipboard +#: Copy to clipboard -#: There is also a copy_or_interrupt action that can be optionally -#: mapped to Ctrl+c. It will copy only if there is a selection and -#: send an interrupt otherwise. Similarly, copy_and_clear_or_interrupt -#: will copy and clear the selection or send an interrupt if there is -#: no selection. +map kitty_mod+c copy_to_clipboard +# map cmd+c copy_to_clipboard + +#:: There is also a copy_or_interrupt action that can be optionally +#:: mapped to Ctrl+C. It will copy only if there is a selection and +#:: send an interrupt otherwise. Similarly, +#:: copy_and_clear_or_interrupt will copy and clear the selection or +#:: send an interrupt if there is no selection. + +#: Paste from clipboard map kitty_mod+v paste_from_clipboard -map kitty_mod+s paste_from_selection +# map cmd+v paste_from_clipboard + +#: Paste from selection + +map kitty_mod+s paste_from_selection +# map shift+insert paste_from_selection + +#: Pass selection to program + map kitty_mod+o pass_selection_to_program -#: You can also pass the contents of the current selection to any -#: program using pass_selection_to_program. By default, the system's -#: open program is used, but you can specify your own, the selection -#: will be passed as a command line argument to the program, for -#: example:: +#:: You can also pass the contents of the current selection to any +#:: program with pass_selection_to_program. By default, the system's +#:: open program is used, but you can specify your own, the selection +#:: will be passed as a command line argument to the program. For +#:: example:: -#: map kitty_mod+o pass_selection_to_program firefox +#:: map kitty_mod+o pass_selection_to_program firefox -#: You can pass the current selection to a terminal program running in -#: a new kitty window, by using the @selection placeholder:: +#:: You can pass the current selection to a terminal program running +#:: in a new kitty window, by using the @selection placeholder:: -#: map kitty_mod+y new_window less @selection +#:: map kitty_mod+y new_window less @selection #: }}} #: Scrolling {{{ -map kitty_mod+up scroll_line_up -map kitty_mod+down scroll_line_down -map kitty_mod+page_up scroll_page_up +#: Scroll line up + +map kitty_mod+up scroll_line_up +# map kitty_mod+k scroll_line_up +# map opt+cmd+page_up scroll_line_up +# map cmd+up scroll_line_up + +#: Scroll line down + +map kitty_mod+down scroll_line_down +# map kitty_mod+j scroll_line_down +# map opt+cmd+page_down scroll_line_down +# map cmd+down scroll_line_down + +#: Scroll page up + +map kitty_mod+page_up scroll_page_up +# map cmd+page_up scroll_page_up + +#: Scroll page down + map kitty_mod+page_down scroll_page_down -map kitty_mod+home scroll_home -map kitty_mod+end scroll_end -map kitty_mod+h show_scrollback +# map cmd+page_down scroll_page_down -#: You can pipe the contents of the current screen + history buffer as -#: STDIN to an arbitrary program using the ``launch`` function. For -#: example, the following opens the scrollback buffer in less in an -#: overlay window:: +#: Scroll to top -#: map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting --type=overlay less +G -R +map kitty_mod+home scroll_home +# map cmd+home scroll_home -#: For more details on piping screen and buffer contents to external -#: programs, see launch. +#: Scroll to bottom + +map kitty_mod+end scroll_end +# map cmd+end scroll_end + +#: Scroll to previous shell prompt + +# map kitty_mod+z scroll_to_prompt -1 + +#:: Use a parameter of 0 for scroll_to_prompt to scroll to the last +#:: jumped to or the last clicked position. Requires shell +#:: integration +#:: to work. + +#: Scroll to next shell prompt + +# map kitty_mod+x scroll_to_prompt 1 + +#: Browse scrollback buffer in pager + +# map kitty_mod+h show_scrollback + +#:: You can pipe the contents of the current screen and history +#:: buffer as STDIN to an arbitrary program using launch --stdin- +#:: source. For example, the following opens the scrollback buffer in +#:: less in an overlay window:: + +#:: map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting --type=overlay less +G -R + +#:: For more details on piping screen and buffer contents to external +#:: programs, see launch . + +#: Browse output of the last shell command in pager + +# map kitty_mod+g show_last_command_output + +#:: You can also define additional shortcuts to get the command +#:: output. For example, to get the first command output on screen:: + +#:: map f1 show_first_command_output_on_screen + +#:: To get the command output that was last accessed by a keyboard +#:: action or mouse action:: + +#:: map f1 show_last_visited_command_output + +#:: You can pipe the output of the last command run in the shell +#:: using the launch action. For example, the following opens the +#:: output in less in an overlay window:: + +#:: map f1 launch --stdin-source=@last_cmd_output --stdin-add-formatting --type=overlay less +G -R + +#:: To get the output of the first command on the screen, use +#:: @first_cmd_output_on_screen. To get the output of the last jumped +#:: to command, use @last_visited_cmd_output. + +#:: Requires shell integration +#:: to work. #: }}} #: Window management {{{ +#: New window + map kitty_mod+enter new_window +# map cmd+enter new_window -#: You can open a new window running an arbitrary program, for -#: example:: +#:: You can open a new kitty window running an arbitrary program, for +#:: example:: -#: map kitty_mod+y launch mutt +#:: map kitty_mod+y launch mutt -#: You can open a new window with the current working directory set to -#: the working directory of the current window using:: +#:: You can open a new window with the current working directory set +#:: to the working directory of the current window using:: -#: map ctrl+alt+enter launch --cwd=current +#:: map ctrl+alt+enter launch --cwd=current -#: You can open a new window that is allowed to control kitty via the -#: kitty remote control facility by prefixing the command line with @. -#: Any programs running in that window will be allowed to control -#: kitty. For example:: +#:: You can open a new window that is allowed to control kitty via +#:: the kitty remote control facility with launch --allow-remote- +#:: control. Any programs running in that window will be allowed to +#:: control kitty. For example:: -#: map ctrl+enter launch --allow-remote-control some_program +#:: map ctrl+enter launch --allow-remote-control some_program -#: You can open a new window next to the currently active window or as -#: the first window, with:: +#:: You can open a new window next to the currently active window or +#:: as the first window, with:: -#: map ctrl+n launch --location=neighbor some_program -#: map ctrl+f launch --location=first some_program +#:: map ctrl+n launch --location=neighbor +#:: map ctrl+f launch --location=first -#: For more details, see launch. +#:: For more details, see launch +#:: . -map kitty_mod+n new_os_window +#: New OS window -#: Works like new_window above, except that it opens a top level OS -#: kitty window. In particular you can use new_os_window_with_cwd to -#: open a window with the current working directory. +# map kitty_mod+n new_os_window +# map cmd+n new_os_window + +#:: Works like new_window above, except that it opens a top-level OS +#:: window. In particular you can use new_os_window_with_cwd to open +#:: a window with the current working directory. + +#: Close window + +map kitty_mod+x close_window +# map shift+cmd+d close_window + +#: Next window + +map kitty_mod+m next_window + +#: Previous window + +map kitty_mod+j previous_window + +#: Move window forward -map kitty_mod+w close_window -map kitty_mod+] next_window -map kitty_mod+[ previous_window map kitty_mod+f move_window_forward + +#: Move window backward + map kitty_mod+b move_window_backward -map kitty_mod+` move_window_to_top + +#: Move window to top + +# map kitty_mod+` move_window_to_top + +#: Start resizing window + map kitty_mod+r start_resizing_window -map kitty_mod+1 first_window -map kitty_mod+2 second_window -map kitty_mod+3 third_window -map kitty_mod+4 fourth_window -map kitty_mod+5 fifth_window -map kitty_mod+6 sixth_window -map kitty_mod+7 seventh_window -map kitty_mod+8 eighth_window -map kitty_mod+9 ninth_window -map kitty_mod+0 tenth_window +# map cmd+r start_resizing_window + +#: First window + +# map kitty_mod+1 first_window +# map cmd+1 first_window + +#: Second window + +# map kitty_mod+2 second_window +# map cmd+2 second_window + +#: Third window + +# map kitty_mod+3 third_window +# map cmd+3 third_window + +#: Fourth window + +# map kitty_mod+4 fourth_window +# map cmd+4 fourth_window + +#: Fifth window + +# map kitty_mod+5 fifth_window +# map cmd+5 fifth_window + +#: Sixth window + +# map kitty_mod+6 sixth_window +# map cmd+6 sixth_window + +#: Seventh window + +# map kitty_mod+7 seventh_window +# map cmd+7 seventh_window + +#: Eighth window + +# map kitty_mod+8 eighth_window +# map cmd+8 eighth_window + +#: Ninth window + +# map kitty_mod+9 ninth_window +# map cmd+9 ninth_window + +#: Tenth window + +# map kitty_mod+0 tenth_window + +#: Visually select and focus window + +# map kitty_mod+f7 focus_visible_window + +#:: Display overlay numbers and alphabets on the window, and switch +#:: the focus to the window when you press the key. When there are +#:: only two windows, the focus will be switched directly without +#:: displaying the overlay. You can change the overlay characters and +#:: their order with option visual_window_select_characters. + +#: Visually swap window with another + +# map kitty_mod+f8 swap_with_window + +#:: Works like focus_visible_window above, but swaps the window. + #: }}} #: Tab management {{{ +#: Next tab + map kitty_mod+right next_tab -map kitty_mod+left previous_tab -map kitty_mod+t new_tab -map kitty_mod+q close_tab -map shift+cmd+w close_os_window -map kitty_mod+. move_tab_forward -map kitty_mod+, move_tab_backward +# map shift+cmd+] next_tab +# map ctrl+tab next_tab + +#: Previous tab + +map kitty_mod+left previous_tab +# map shift+cmd+[ previous_tab +# map ctrl+shift+tab previous_tab + +#: New tab + +map kitty_mod+t new_tab +# map cmd+t new_tab + +#: Close tab + +map kitty_mod+q close_tab +# map cmd+w close_tab + +#: Close OS window + +# map shift+cmd+w close_os_window + +#: Move tab forward + +# map kitty_mod+. move_tab_forward + +#: Move tab backward + +# map kitty_mod+, move_tab_backward + +#: Set tab title + map kitty_mod+alt+t set_tab_title +# map shift+cmd+i set_tab_title + #: You can also create shortcuts to go to specific tabs, with 1 being #: the first tab, 2 the second tab and -1 being the previously active -#: tab, and any number larger than the last tab being the last tab:: +#: tab, -2 being the tab active before the previously active tab and +#: so on. Any number larger than the number of tabs goes to the last +#: tab and any number less than the number of previously used tabs in +#: the history goes to the oldest previously used tab in the history:: #: map ctrl+alt+1 goto_tab 1 #: map ctrl+alt+2 goto_tab 2 #: Just as with new_window above, you can also pass the name of -#: arbitrary commands to run when using new_tab and use -#: new_tab_with_cwd. Finally, if you want the new tab to open next to -#: the current tab rather than at the end of the tabs list, use:: +#: arbitrary commands to run when using new_tab and new_tab_with_cwd. +#: Finally, if you want the new tab to open next to the current tab +#: rather than at the end of the tabs list, use:: #: map ctrl+t new_tab !neighbor [optional cmd to run] #: }}} #: Layout management {{{ +#: Next layout + map kitty_mod+l next_layout + #: You can also create shortcuts to switch to specific layouts:: #: map ctrl+alt+t goto_layout tall @@ -1308,7 +2346,14 @@ map kitty_mod+l next_layout #: Similarly, to switch back to the previous layout:: -#: map ctrl+alt+p last_used_layout +#: map ctrl+alt+p last_used_layout + +#: There is also a toggle_layout action that switches to the named +#: layout or back to the previous layout if in the named layout. +#: Useful to temporarily "zoom" the active window by switching to the +#: stack layout:: + +#: map ctrl+alt+z toggle_layout stack #: }}} #: Font sizes {{{ @@ -1316,9 +2361,27 @@ map kitty_mod+l next_layout #: You can change the font size for all top-level kitty OS windows at #: a time or only the current one. -map kitty_mod+equal change_font_size all +2.0 -map kitty_mod+minus change_font_size all -2.0 -map kitty_mod+backspace change_font_size all 0 +#: Increase font size + +map kitty_mod+equal change_font_size all +2.0 +map kitty_mod+plus change_font_size all +2.0 +# map kitty_mod+kp_add change_font_size all +2.0 +# map cmd+plus change_font_size all +2.0 +# map cmd+equal change_font_size all +2.0 +# map shift+cmd+equal change_font_size all +2.0 + +#: Decrease font size + +map kitty_mod+minus change_font_size all -2.0 +# map kitty_mod+kp_subtract change_font_size all -2.0 +# map cmd+minus change_font_size all -2.0 +# map shift+cmd+minus change_font_size all -2.0 + +#: Reset font size + +# map kitty_mod+backspace change_font_size all 0 +# map cmd+0 change_font_size all 0 + #: To setup shortcuts for specific font sizes:: @@ -1336,137 +2399,265 @@ map kitty_mod+backspace change_font_size all 0 #: external program or insert it into the terminal or copy it to the #: clipboard. -map kitty_mod+e kitten hints +#: Open URL -#: Open a currently visible URL using the keyboard. The program used -#: to open the URL is specified in open_url_with. +map kitty_mod+e open_url_with_hints -map kitty_mod+p>f kitten hints --type path --program - +#:: Open a currently visible URL using the keyboard. The program used +#:: to open the URL is specified in open_url_with. -#: Select a path/filename and insert it into the terminal. Useful, for -#: instance to run git commands on a filename output from a previous -#: git command. +#: Insert selected path -map kitty_mod+p>shift+f kitten hints --type path +# map kitty_mod+p>f kitten hints --type path --program - -#: Select a path/filename and open it with the default open program. +#:: Select a path/filename and insert it into the terminal. Useful, +#:: for instance to run git commands on a filename output from a +#:: previous git command. -map kitty_mod+p>l kitten hints --type line --program - +#: Open selected path -#: Select a line of text and insert it into the terminal. Use for the -#: output of things like: ls -1 +# map kitty_mod+p>shift+f kitten hints --type path -map kitty_mod+p>w kitten hints --type word --program - +#:: Select a path/filename and open it with the default open program. -#: Select words and insert into terminal. +#: Insert selected line -map kitty_mod+p>h kitten hints --type hash --program - +# map kitty_mod+p>l kitten hints --type line --program - -#: Select something that looks like a hash and insert it into the -#: terminal. Useful with git, which uses sha1 hashes to identify -#: commits +#:: Select a line of text and insert it into the terminal. Useful for +#:: the output of things like: `ls -1`. -map kitty_mod+p>n kitten hints --type linenum +#: Insert selected word -#: Select something that looks like filename:linenum and open it in -#: vim at the specified line number. +# map kitty_mod+p>w kitten hints --type word --program - -map kitty_mod+p>y kitten hints --type hyperlink +#:: Select words and insert into terminal. -#: Select a hyperlink (i.e. a URL that has been marked as such by the -#: terminal program, for example, by ls --hyperlink=auto). +#: Insert selected hash + +# map kitty_mod+p>h kitten hints --type hash --program - + +#:: Select something that looks like a hash and insert it into the +#:: terminal. Useful with git, which uses SHA1 hashes to identify +#:: commits. + +#: Open the selected file at the selected line + +# map kitty_mod+p>n kitten hints --type linenum + +#:: Select something that looks like filename:linenum and open it in +#:: your default editor at the specified line number. + +#: Open the selected hyperlink + +# map kitty_mod+p>y kitten hints --type hyperlink + +#:: Select a hyperlink (i.e. a URL that has been marked as such by +#:: the terminal program, for example, by `ls --hyperlink=auto`). #: The hints kitten has many more modes of operation that you can map -#: to different shortcuts. For a full description see kittens/hints. +#: to different shortcuts. For a full description see hints kitten +#: . #: }}} #: Miscellaneous {{{ -map kitty_mod+f11 toggle_fullscreen -map kitty_mod+f10 toggle_maximized -map kitty_mod+u kitten unicode_input -map kitty_mod+f2 edit_config_file -map kitty_mod+escape kitty_shell window +#: Show documentation -#: Open the kitty shell in a new window/tab/overlay/os_window to -#: control kitty using commands. +map kitty_mod+f1 show_kitty_doc overview + +#: Toggle fullscreen + +map kitty_mod+f11 toggle_fullscreen +# map ctrl+cmd+f toggle_fullscreen + +#: Toggle maximized + +map kitty_mod+f10 toggle_maximized + +#: Toggle macOS secure keyboard entry + +# map opt+cmd+s toggle_macos_secure_keyboard_entry + +#: Unicode input + +# map kitty_mod+u kitten unicode_input +# map ctrl+cmd+space kitten unicode_input + +#: Edit config file + +map kitty_mod+f2 edit_config_file +# map cmd+, edit_config_file + +#: Open the kitty command shell + +# map kitty_mod+escape kitty_shell window + +#:: Open the kitty shell in a new window / tab / overlay / os_window +#:: to control kitty using commands. + +#: Increase background opacity + +map kitty_mod+a>m set_background_opacity +0.1 + +#: Decrease background opacity + +map kitty_mod+a>l set_background_opacity -0.1 + +#: Make background fully opaque + +map kitty_mod+a>f set_background_opacity 1 + +#: Reset background opacity + +map kitty_mod+a>r set_background_opacity default + +#: Reset the terminal -map kitty_mod+a>m set_background_opacity +0.1 -map kitty_mod+a>l set_background_opacity -0.1 -map kitty_mod+a>1 set_background_opacity 1 -map kitty_mod+a>d set_background_opacity default map kitty_mod+delete clear_terminal reset active +# map opt+cmd+r clear_terminal reset active -#: You can create shortcuts to clear/reset the terminal. For example:: +#:: You can create shortcuts to clear/reset the terminal. For +#:: example:: -#: # Reset the terminal -#: map kitty_mod+f9 clear_terminal reset active -#: # Clear the terminal screen by erasing all contents -#: map kitty_mod+f10 clear_terminal clear active -#: # Clear the terminal scrollback by erasing it -#: map kitty_mod+f11 clear_terminal scrollback active -#: # Scroll the contents of the screen into the scrollback -#: map kitty_mod+f12 clear_terminal scroll active +#:: # Reset the terminal +#:: map f1 clear_terminal reset active +#:: # Clear the terminal screen by erasing all contents +#:: map f1 clear_terminal clear active +#:: # Clear the terminal scrollback by erasing it +#:: map f1 clear_terminal scrollback active +#:: # Scroll the contents of the screen into the scrollback +#:: map f1 clear_terminal scroll active +#:: # Clear everything on screen up to the line with the cursor or the start of the current prompt (needs shell integration) +#:: map f1 clear_terminal to_cursor active +#:: # Same as above except cleared lines are moved into scrollback +#:: map f1 clear_terminal to_cursor_scroll active -#: If you want to operate on all windows instead of just the current -#: one, use all instead of active. +#:: If you want to operate on all kitty windows instead of just the +#:: current one, use all instead of active. -#: It is also possible to remap Ctrl+L to both scroll the current -#: screen contents into the scrollback buffer and clear the screen, -#: instead of just clearing the screen, for example, for ZSH add the -#: following to ~/.zshrc: +#:: Some useful functions that can be defined in the shell rc files +#:: to perform various kinds of clearing of the current window: -#: .. code-block:: sh +#:: .. code-block:: sh -#: scroll-and-clear-screen() { -#: printf '\n%.0s' {1..$LINES} -#: zle clear-screen -#: } -#: zle -N scroll-and-clear-screen -#: bindkey '^l' scroll-and-clear-screen +#:: clear-only-screen() { +#:: printf "\e[H\e[2J" +#:: } + +#:: clear-screen-and-scrollback() { +#:: printf "\e[H\e[3J" +#:: } + +#:: clear-screen-saving-contents-in-scrollback() { +#:: printf "\e[H\e[22J" +#:: } + +#:: For instance, using these escape codes, it is possible to remap +#:: Ctrl+L to both scroll the current screen contents into the +#:: scrollback buffer and clear the screen, instead of just clearing +#:: the screen. For ZSH, in ~/.zshrc, add: + +#:: .. code-block:: zsh + +#:: ctrl_l() { +#:: builtin print -rn -- $'\r\e[0J\e[H\e[22J' >"$TTY" +#:: builtin zle .reset-prompt +#:: builtin zle -R +#:: } +#:: zle -N ctrl_l +#:: bindkey '^l' ctrl_l + +#:: Alternatively, you can just add map ctrl+l clear_terminal +#:: to_cursor_scroll active to kitty.conf which works with no changes +#:: to the shell rc files, but only clears up to the prompt, it does +#:: not clear anytext at the prompt itself. + +#: Clear up to cursor line + +# map cmd+k clear_terminal to_cursor active + +#: Reload kitty.conf map kitty_mod+f5 load_config_file +# map ctrl+cmd+, load_config_file -#: Reload kitty.conf, applying any changes since the last time it was -#: loaded. Note that a handful of settings cannot be dynamically -#: changed and require a full restart of kitty. You can also map a -#: keybinding to load a different config file, for example:: +#:: Reload kitty.conf, applying any changes since the last time it +#:: was loaded. Note that a handful of options cannot be dynamically +#:: changed and require a full restart of kitty. Particularly, when +#:: changing shortcuts for actions located on the macOS global menu +#:: bar, a full restart is needed. You can also map a keybinding to +#:: load a different config file, for example:: -#: map f5 load_config /path/to/alternative/kitty.conf +#:: map f5 load_config /path/to/alternative/kitty.conf -#: Note that all setting from the original kitty.conf are discarded, -#: in other words the new conf settings *replace* the old ones. +#:: Note that all options from the original kitty.conf are discarded, +#:: in other words the new configuration *replace* the old ones. + +#: Debug kitty configuration map kitty_mod+f6 debug_config +# map opt+cmd+, debug_config -#: Show details about exactly what configuration kitty is running with -#: and its host environment. Useful for debugging issues. +#:: Show details about exactly what configuration kitty is running +#:: with and its host environment. Useful for debugging issues. +#: Send arbitrary text on key presses -#: You can tell kitty to send arbitrary (UTF-8) encoded text to the -#: client program when pressing specified shortcut keys. For example:: +#:: E.g. map ctrl+shift+alt+h send_text all Hello World -#: map ctrl+alt+a send_text all Special text +#:: You can tell kitty to send arbitrary (UTF-8) encoded text to the +#:: client program when pressing specified shortcut keys. For +#:: example:: -#: This will send "Special text" when you press the ctrl+alt+a key -#: combination. The text to be sent is a python string literal so you -#: can use escapes like \x1b to send control codes or \u21fb to send -#: unicode characters (or you can just input the unicode characters -#: directly as UTF-8 text). The first argument to send_text is the -#: keyboard modes in which to activate the shortcut. The possible -#: values are normal or application or kitty or a comma separated -#: combination of them. The special keyword all means all modes. The -#: modes normal and application refer to the DECCKM cursor key mode -#: for terminals, and kitty refers to the special kitty extended -#: keyboard protocol. +#:: map ctrl+alt+a send_text all Special text -#: Another example, that outputs a word and then moves the cursor to -#: the start of the line (same as pressing the Home key):: +#:: This will send "Special text" when you press the Ctrl+Alt+A key +#:: combination. The text to be sent decodes ANSI C escapes +#:: so you can use escapes like \e to send control +#:: codes or \u21fb to send Unicode characters (or you can just input +#:: the Unicode characters directly as UTF-8 text). You can use +#:: `kitten show-key` to get the key escape codes you want to +#:: emulate. -#: map ctrl+alt+a send_text normal Word\x1b[H -#: map ctrl+alt+a send_text application Word\x1bOH +#:: The first argument to send_text is the keyboard modes in which to +#:: activate the shortcut. The possible values are normal, +#:: application, kitty or a comma separated combination of them. The +#:: modes normal and application refer to the DECCKM cursor key mode +#:: for terminals, and kitty refers to the kitty extended keyboard +#:: protocol. The special value all means all of them. + +#:: Some more examples:: + +#:: # Output a word and move the cursor to the start of the line (like typing and pressing Home) +#:: map ctrl+alt+a send_text normal Word\e[H +#:: map ctrl+alt+a send_text application Word\eOH +#:: # Run a command at a shell prompt (like typing the command and pressing Enter) +#:: map ctrl+alt+a send_text normal,application some command with arguments\r + +#: Open kitty Website + +# map shift+cmd+/ open_url https://sw.kovidgoyal.net/kitty/ + +#: Hide macOS kitty application + +# map cmd+h hide_macos_app + +#: Hide macOS other applications + +# map opt+cmd+h hide_macos_other_apps + +#: Minimize macOS window + +# map cmd+m minimize_macos_window + +#: Quit kitty + +# map cmd+q quit #: }}} #: }}} + diff --git a/private_dot_config/kitty/symlink_theme.conf.tmpl b/private_dot_config/kitty/symlink_theme.conf.tmpl deleted file mode 100644 index 92802f6..0000000 --- a/private_dot_config/kitty/symlink_theme.conf.tmpl +++ /dev/null @@ -1 +0,0 @@ -{{ .chezmoi.homeDir }}/.config/kitty/kitty-themes/themes/gruvbox_dark.conf diff --git a/private_dot_config/nvim/lua/autocmds.lua b/private_dot_config/nvim/lua/autocmds.lua index 4583e42..e797d97 100644 --- a/private_dot_config/nvim/lua/autocmds.lua +++ b/private_dot_config/nvim/lua/autocmds.lua @@ -68,3 +68,12 @@ vim.api.nvim_create_autocmd({ "UIEnter", "BufReadPost", "BufNewFile" }, { end end, }) + +-- fix lspsaga codeaction causing buffer issues +vim.api.nvim_create_autocmd("BufAdd", { + callback = function(args) + if vim.bo[args.buf].buflisted then + print(args.buf) + end + end, +}) diff --git a/private_dot_config/nvim/lua/chadrc.lua b/private_dot_config/nvim/lua/chadrc.lua index 0bcb399..43bfd50 100644 --- a/private_dot_config/nvim/lua/chadrc.lua +++ b/private_dot_config/nvim/lua/chadrc.lua @@ -143,6 +143,7 @@ local options = { virt_text = "󱓻 ", highlight = { hex = true, lspvars = true }, }, + } local status, chadrc = pcall(require, "chadrc") diff --git a/private_dot_config/nvim/lua/configs/lspconfig.lua b/private_dot_config/nvim/lua/configs/lspconfig.lua index cfa3a73..e988482 100644 --- a/private_dot_config/nvim/lua/configs/lspconfig.lua +++ b/private_dot_config/nvim/lua/configs/lspconfig.lua @@ -5,10 +5,22 @@ local lspconfig = require("lspconfig") local nvlsp = require("nvchad.configs.lspconfig") local servers = { "jdtls", "html", "cssls", "clangd", "pylsp", "basedpyright", "ruff" } +local nomap = vim.keymap.del + for _, lsp in ipairs(servers) do lspconfig[lsp].setup({ on_init = nvlsp.on_init, - on_attach = nvlsp.on_attach, + on_attach = function(client, bufnr) + nvlsp.on_attach(client, bufnr) + nomap("n", "gD", { buffer = bufnr }) + nomap("n", "gd", { buffer = bufnr }) + nomap("n", "gi", { buffer = bufnr }) + nomap("n", "sh", { buffer = bufnr }) + nomap("n", "D", { buffer = bufnr }) + nomap("n", "ra", { buffer = bufnr }) + nomap("n", "ca", { buffer = bufnr }) + nomap("n", "gr", { buffer = bufnr }) + end, capabilities = nvlsp.capabilities, }) end diff --git a/private_dot_config/nvim/lua/mappings.lua b/private_dot_config/nvim/lua/mappings.lua index 761a30e..4bd977f 100644 --- a/private_dot_config/nvim/lua/mappings.lua +++ b/private_dot_config/nvim/lua/mappings.lua @@ -1,12 +1,5 @@ local map = vim.keymap.set -map("i", "", "^i", { desc = "Move Beginning of line" }) -map("i", "", "", { desc = "Move End of line" }) -map("i", "", "", { desc = "Move Left" }) -map("i", "", "", { desc = "Move Right" }) -map("i", "", "", { desc = "Move Down" }) -map("i", "", "", { desc = "Move Up" }) - map("n", "", "noh", { desc = "General Clear highlights" }) map("n", "", "w", { desc = "File Save" }) @@ -21,22 +14,14 @@ map("n", "fm", function() end, { desc = "Format Files" }) -- lsp mappings -map("n", "", "Lspsaga code_action", { desc = "Lsp code action" }) -map("v", "", "Lspsaga code_action", { desc = "Lsp code action" }) -map("n", "", "Lspsaga peek_definition", { desc = "Lsp peek definition" }) -map("n", "", "Lspsaga peek_type_definition", { desc = "Lsp peek type definition" }) -map("v", "", "Lspsaga peek_definition", { desc = "Lsp peek definition" }) -map("v", "", "Lspsaga peek_type_definition", { desc = "Lsp peek type definition" }) -map("n", "", "Lspsaga goto_definition", { desc = "Lsp goto definition" }) -map("n", "", "Lspsaga goto_type_definition", { desc = "Lsp goto type definition" }) -map("v", "", "Lspsaga goto_definition", { desc = "Lsp goto definition" }) -map("v", "", "Lspsaga goto_type_definition", { desc = "Lsp goto type definition" }) -map("n", "", "Lspsaga rename ++project", { desc = "Lsp rename" }) -map("v", "", "Lspsaga rename ++project", { desc = "Lsp rename" }) -map("n", "", "Lspsaga diagnostic_jump_next", { desc = "Lsp diagnostic next" }) -map("v", "", "Lspsaga diagnostic_jump_next", { desc = "Lsp diagnostic next" }) -map("n", "", "Lspsaga diagnostic_jump_prev", { desc = "Lsp diagnostic previous" }) -map("v", "", "Lspsaga diagnostic_jump_prev", { desc = "Lsp diagnostic previous" }) +map({ "n", "v" }, "", "Lspsaga code_action", { desc = "LSP code action" }) +map({ "n", "v" }, "", "Lspsaga peek_definition", { desc = "LSP peek definition" }) +map({ "n", "v" }, "", "Lspsaga peek_type_definition", { desc = "LSP peek type definition" }) +map({ "n", "v" }, "", "Lspsaga goto_definition", { desc = "LSP goto definition" }) +map({ "n", "v" }, "", "Lspsaga goto_type_definition", { desc = "LSP goto type definition" }) +map({ "n", "v" }, "", "Lspsaga rename ++project", { desc = "LSP rename" }) +map({ "n", "v" }, "", "Lspsaga diagnostic_jump_next", { desc = "LSP diagnostic next" }) +map({ "n", "v" }, "", "Lspsaga diagnostic_jump_prev", { desc = "LSP diagnostic previous" }) -- tabufline map("n", "b", "enew", { desc = "Buffer New" }) @@ -53,17 +38,16 @@ map("n", "x", function() require("nvchad.tabufline").close_buffer() end, { desc = "Buffer Close" }) +map("n", "t", "tabnew", { desc = "Tab New" }) + -- Comment map("n", "/", "gcc", { desc = "Comment toggle", remap = true }) map("v", "/", "gc", { desc = "Comment toggle", remap = true }) -- Spider nvim movement -map("n", "w", "lua require('spider').motion('w')", {desc = "Spider Move to next word"}) -map("n", "b", "lua require('spider').motion('b')", {desc = "Spider Move to previous word"}) -map("n", "e", "lua require('spider').motion('e')", {desc = "Spider Move to end of word"}) -map("v", "w", "lua require('spider').motion('w')", {desc = "Spider Move to next word"}) -map("v", "b", "lua require('spider').motion('b')", {desc = "Spider Move to previous word"}) -map("v", "e", "lua require('spider').motion('e')", {desc = "Spider Move to end of word"}) +map({ "n", "v" }, "w", "lua require('spider').motion('w')", {desc = "Spider Move to next word"}) +map({ "n", "v" }, "b", "lua require('spider').motion('b')", {desc = "Spider Move to previous word"}) +map({ "n", "v" }, "e", "lua require('spider').motion('e')", {desc = "Spider Move to end of word"}) -- nvimtree map("n", "", "NvimTreeToggle", { desc = "Nvimtree Toggle window" }) @@ -91,33 +75,33 @@ map( -- terminal map("t", "", "", { desc = "Terminal Escape terminal mode" }) --- new terminals -map("n", "h", function() - require("nvchad.term").new { pos = "sp", size = 0.3 } -end, { desc = "Terminal New horizontal term" }) - -map("n", "v", function() - require("nvchad.term").new { pos = "vsp", size = 0.3 } -end, { desc = "Terminal New vertical window" }) - --- toggleable -map({ "n", "t" }, "", function() - require("nvchad.term").toggle { pos = "vsp", id = "vtoggleTerm", size = 0.3 } -end, { desc = "Terminal Toggleable vertical term" }) - -map({ "n", "t" }, "", function() - require("nvchad.term").toggle { pos = "sp", id = "htoggleTerm", size = 0.3 } -end, { desc = "Terminal New horizontal term" }) - -map({ "n", "t" }, "", function() - require("nvchad.term").toggle { pos = "float", id = "floatTerm" } -end, { desc = "Terminal Toggle Floating term" }) - map("t", "", function() local win = vim.api.nvim_get_current_win() vim.api.nvim_win_close(win, true) end, { desc = "Terminal Close term in terminal mode" }) +-- new terminals +map("n", "h", function() + require("nvchad.term").new { pos = "sp", size = 0.4 } +end, { desc = "Terminal New horizontal term" }) + +map("n", "v", function() + require("nvchad.term").new { pos = "vsp", size = 0.5 } +end, { desc = "Terminal New vertical window" }) + +-- toggleable +-- map({ "n", "t" }, "", function() +-- require("nvchad.term").toggle { pos = "vsp", id = "vtoggleTerm", size = 0.3 } +-- end, { desc = "Terminal Toggleable vertical term" }) +-- +-- map({ "n", "t" }, "", function() +-- require("nvchad.term").toggle { pos = "sp", id = "htoggleTerm", size = 0.3 } +-- end, { desc = "Terminal New horizontal term" }) +-- +-- map({ "n", "t" }, "", function() +-- require("nvchad.term").toggle { pos = "float", id = "floatTerm" } +-- end, { desc = "Terminal Toggle Floating term" }) + -- whichkey map("n", "wK", "WhichKey ", { desc = "Whichkey all keymaps" }) @@ -142,24 +126,33 @@ map("n", "cc", function() end, { desc = "Blankline Jump to current context" }) -- copilotchat -map("n", "cch", function() - local actions = require("CopilotChat.actions") - require("CopilotChat.integrations.telescope").pick(actions.help_actions()) -end, { desc = "CopilotChat - Help actions" }) -map("n", "ccp", function() - local actions = require("CopilotChat.actions") - require("CopilotChat.integrations.telescope").pick(actions.prompt_actions()) -end, { desc = "CopilotChat - Prompt actions" }) -map("v", "cch", function() - local actions = require("CopilotChat.actions") - require("CopilotChat.integrations.telescope").pick(actions.help_actions()) -end, { desc = "CopilotChat - Help actions" }) -map("v", "ccp", function() +map({ "n", "v" }, "ccp", function() local actions = require("CopilotChat.actions") require("CopilotChat.integrations.telescope").pick(actions.prompt_actions()) end, { desc = "CopilotChat - Prompt actions" }) +map({ "n", "v" }, "ccq", function() + local input = vim.fn.input("Quick Chat: ") + if input ~= "" then + require("CopilotChat").ask(input, { selection = require("CopilotChat.select").buffer }) + end +end, { desc = "CopilotChat - Quick chat" }) +map({ "n", "v" }, "ccf", function() + require("CopilotChat").ask("Fix this, using the lsp diagnostics if needed", { selection = require("CopilotChat.select").visual }) +end, { desc = "CopilotChat - Fix this" }) + +-- menu +-- vim.keymap.set("n", "", function() +-- require("menu").open("default") +-- end, {}) +-- +-- vim.keymap.set("n", "", function() +-- vim.cmd.exec '"normal! \\"' +-- +-- local options = vim.bo.ft == "NvimTree" and "nvimtree" or "default" +-- require("menu").open(options, { mouse = true }) +-- end, {}) -- Custom mappings @@ -188,14 +181,21 @@ map({ "n", "v" }, "P", "\"+P") map("n", "a", function() require("treesj").toggle() end, { desc = "Extends or retracts an instruction block" }) -map("n", "gb", "Gitsigns blame", { desc = "Git blame" }) -map("v", "gb", "Gitsigns blame", { desc = "Git blame" }) -map("i", "jj", "", { desc = "Go into normal mode" }) +map({ "n", "v" }, "gb", "Gitsigns blame", { desc = "Git blame" }) +map("i", "jj", "", { desc = "Enter normal mode" }) map("i", "", "ddi", { desc = "Delete a line" }) +map("i", "", "^i", { desc = "Move Beginning of line" }) +map("i", "", "", { desc = "Move End of line" }) +map("i", "", "", { desc = "Move Left" }) +map("i", "", "", { desc = "Move Right" }) +map("i", "", "", { desc = "Move Down" }) +map("i", "", "", { desc = "Move Up" }) -- Disable mappings -- local nomap = vim.keymap.del +-- LSP unmappings are set in configs/lspconfig.lua + -- nomap("n", "h") -- nomap("n", "j") -- nomap("n", "k") diff --git a/private_dot_config/nvim/lua/options.lua b/private_dot_config/nvim/lua/options.lua index 0b427c4..cdd9673 100644 --- a/private_dot_config/nvim/lua/options.lua +++ b/private_dot_config/nvim/lua/options.lua @@ -9,5 +9,7 @@ vim.opt.softtabstop = 4 vim.opt.shell = "/usr/local/bin/fish" +vim.opt.foldmethod = "marker" + -- local o = vim.o -- o.cursorlineopt ='both' -- to enable cursorline! diff --git a/private_dot_config/nvim/lua/plugins/init.lua b/private_dot_config/nvim/lua/plugins/init.lua index 3b4c5ea..d1f4d3e 100644 --- a/private_dot_config/nvim/lua/plugins/init.lua +++ b/private_dot_config/nvim/lua/plugins/init.lua @@ -37,7 +37,9 @@ return { config = function() require('lspsaga').setup({ lightbulb = { + enabled = false, virtual_text = false, + sign = false, }, code_action = { extend_gitsigns = true, diff --git a/private_dot_config/nvim/lua/plugins/plugins.lua b/private_dot_config/nvim/lua/plugins/plugins.lua index f307967..734db32 100644 --- a/private_dot_config/nvim/lua/plugins/plugins.lua +++ b/private_dot_config/nvim/lua/plugins/plugins.lua @@ -271,26 +271,10 @@ local plugins = { model = "claude-3.5-sonnet", }, keys = { - { - "ccq", - function() - local input = vim.fn.input("Quick Chat: ") - if input ~= "" then - require("CopilotChat").ask(input, { selection = require("CopilotChat.select").buffer }) - end - end, - desc = "CopilotChat - Quick chat", - }, - { - "ccf", - function() - require("CopilotChat").ask("Fix this, using the lsp diagnostics if needed", { selection = require("CopilotChat.select").visual }) - end, - desc = "CopilotChat - Fix this", - }, }, config = function () require('CopilotChat').setup({ + model = "claude-3.5-sonnet", highlight_headers = false, separator = '---', error_header = '> [!ERROR] Error', diff --git a/private_dot_config/starship.toml b/private_dot_config/starship.toml new file mode 100644 index 0000000..fd914d4 --- /dev/null +++ b/private_dot_config/starship.toml @@ -0,0 +1,171 @@ +"$schema" = 'https://starship.rs/config-schema.json' + +continuation_prompt = '▶▶ ' + +format = """ +[](color_orange)\ +$os\ +$username\ +[](bg:color_yellow fg:color_orange)\ +$directory\ +[](fg:color_yellow bg:color_aqua)\ +$git_branch\ +$git_status\ +[](fg:color_aqua bg:color_blue)\ +$c\ +$rust\ +$golang\ +$nodejs\ +$php\ +$java\ +$kotlin\ +$haskell\ +$python\ +[](fg:color_blue bg:color_bg3)\ +$docker_context\ +$conda\ +[](fg:color_bg3 bg:color_bg1)\ +$time\ +[ ](fg:color_bg1)\ +$line_break$character""" + +palette = 'gruvbox_dark' + +[palettes.gruvbox_dark] +color_fg0 = '#fbf1c7' +color_bg1 = '#3c3836' +color_bg3 = '#665c54' +color_blue = '#458588' +color_aqua = '#689d6a' +color_green = '#98971a' +color_orange = '#d65d0e' +color_purple = '#b16286' +color_red = '#cc241d' +color_yellow = '#d79921' + +[os] +disabled = false +style = "bg:color_orange fg:color_fg0" + +[os.symbols] +Windows = "󰍲" +Ubuntu = "󰕈" +SUSE = "" +Raspbian = "󰐿" +Mint = "󰣭" +Macos = "󰀵" +Manjaro = "" +Linux = "󰌽" +Gentoo = "󰣨" +Fedora = "󰣛" +Alpine = "" +Amazon = "" +Android = "" +Arch = "󰣇" +Artix = "󰣇" +EndeavourOS = "" +CentOS = "" +Debian = "󰣚" +Redhat = "󱄛" +RedHatEnterprise = "󱄛" +Pop = "" + +[username] +show_always = true +style_user = "bg:color_orange fg:color_fg0" +style_root = "bg:color_orange fg:color_fg0" +format = '[ $user ]($style)' + +[directory] +style = "fg:color_fg0 bg:color_yellow" +format = "[ $path ]($style)" +truncation_length = 3 +truncation_symbol = "…/" + +[directory.substitutions] +"Documents" = "󰈙 " +"Downloads" = " " +"Music" = "󰝚 " +"Pictures" = " " +"Developer" = "󰲋 " + +[git_branch] +symbol = "" +style = "bg:color_aqua" +format = '[[ $symbol $branch ](fg:color_fg0 bg:color_aqua)]($style)' + +[git_status] +style = "bg:color_aqua" +format = '[[($all_status$ahead_behind )](fg:color_fg0 bg:color_aqua)]($style)' + +[nodejs] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[c] +symbol = " " +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[rust] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[golang] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[php] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[java] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[kotlin] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[haskell] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[python] +symbol = "" +style = "bg:color_blue" +format = '[[ $symbol( $version) ](fg:color_fg0 bg:color_blue)]($style)' + +[docker_context] +symbol = "" +style = "bg:color_bg3" +format = '[[ $symbol( $context) ](fg:#83a598 bg:color_bg3)]($style)' + +[conda] +style = "bg:color_bg3" +format = '[[ $symbol( $environment) ](fg:#83a598 bg:color_bg3)]($style)' + +[time] +disabled = false +time_format = "%R" +style = "bg:color_bg1" +format = '[[  $time ](fg:color_fg0 bg:color_bg1)]($style)' + +[line_break] +disabled = false + +[character] +disabled = false +success_symbol = '[](bold fg:color_green)' +error_symbol = '[](bold fg:color_red)' +vimcmd_symbol = '[](bold fg:color_green)' +vimcmd_replace_one_symbol = '[](bold fg:color_purple)' +vimcmd_replace_symbol = '[](bold fg:color_purple)' +vimcmd_visual_symbol = '[](bold fg:color_yellow)' diff --git a/private_dot_config/topgrade.d/topgrade.toml b/private_dot_config/topgrade.d/topgrade.toml index f382df6..e9f48ec 100644 --- a/private_dot_config/topgrade.d/topgrade.toml +++ b/private_dot_config/topgrade.d/topgrade.toml @@ -121,7 +121,7 @@ arch_package_manager = "pacman" # aura_pacman_arguments = "" # garuda_update_arguments = "" -# show_arch_news = true +show_arch_news = true # trizen_arguments = "--devel" @@ -202,7 +202,7 @@ arch_package_manager = "pacman" [firmware] # Offer to update firmware; if false just check for and display available updates -# upgrade = true +upgrade = true [vagrant] diff --git a/scripts/shells.sh b/scripts/shells.sh index 863f68c..90d1d01 100644 --- a/scripts/shells.sh +++ b/scripts/shells.sh @@ -16,6 +16,9 @@ mkdir -p ~/.config/fish/ echo -e "${BLUE}Installing Oh-My-Posh...${DEFAULT}" check_installation "yay -S --noconfirm --needed" "oh-my-posh" +echo -e "${BLUE}Installing Starship...${DEFAULT}" +check_installation "sudo pacman -S --noconfirm --needed" "starship" + # Installing navigation and search tools echo -e "${GREEN}Installing navigation and search tools...${DEFAULT}" @@ -73,6 +76,10 @@ check_installation "yay -S --noconfirm --needed" "sshs" echo -e "${BLUE}Installing Atuin...${DEFAULT}" check_installation "pacman -S --noconfirm --needed" "atuin" +# Vivid - A tool for generating LS_COLORS +echo -e "${BLUE}Installing Vivid...${DEFAULT}" +check_installation "sudo pacman -S --noconfirm --needed" "vivid" + # Changing the default shell to Fish echo -e "${GREEN}Setting Fish as default shell...${DEFAULT}" chsh -s $(which fish) diff --git a/utils/packages b/utils/packages index 5b36fd9..6e8c127 100644 --- a/utils/packages +++ b/utils/packages @@ -54,6 +54,7 @@ zsh powerline fish oh-my-posh +starship zoxide fzf lsd rm-improved-git @@ -66,3 +67,4 @@ tealdeer git-delta sshs atuin +vivid