.. | ||
README.md |
Configuration avancée
Même si Starship est un shell polyvalent, éditer starship.toml
ne suffit parfois pas pour faire certaines choses. Cette page détaille quelques techniques de configuration avancées utilisées dans starship.
::: warning
Les configurations dans cette section sont sujettes à modification dans les futures versions de Starship.
:::
Commandes pré-commande et pré-exécution personnalisées en Bash
Bash n'a pas de structure officielle préexec/précmd comme la plupart des autres shells. C'est pourquoi il est difficile de fournir des hooks entièrement personnalisables dans bash
. Cependant, Starship vous permet dans une certaine mesure d'insérer vos propres fonctions dans la procédure de rendu du prompt :
- Pour exécuter une fonction personnalisée juste avant que le prompt ne soit dessiné, définissez une nouvelle fonction et assignez son nom à
starship_precmd_user_func
. Par exemple, pour dessiner une fusée avant la commande, vous feriez
function blastoff(){
echo "🚀"
}
starship_precmd_user_func="blastoff"
- Pour exécuter une fonction personnalisée juste avant l'exécution d'une commande, vous pouvez utiliser le mécanisme d'interruption du signal
DEBUG
. Cependant, vous devez piéger le signal DEBUG avant l'initialisation de Starship ! Starship peut préserver la valeur du piège DEBUG, mais si le piège est écrasé après le démarrage de Starship, certaines fonctionnalités vont casser.
function blastoff(){
echo "🚀"
}
trap blastoff DEBUG # Pièger DEBUG *avant* l'initialisation de starship
eval $(starship init bash)
Modifier le titre des fenêtres
Certaines commandes du shell changeront automatiquement le titre de la fenêtre (par exemple, pour refléter votre répertoire de travail). Fish le fait même par défaut. Starship ne le fait pas, mais il est assez simple d'ajouter cette fonctionnalité à bash
ou zsh
.
Tout d'abord, définissez une fonction de changement de titre de fenêtre (identique en bash et zsh) :
function set_titre_fenetre(){
echo -ne "\033]0; VOTRE_TITRE_ICI\007"
}
Vous pouvez utiliser des variables pour personnaliser ce titre ($USER
, $HOSTNAME
, et $PWD
sont des choix populaires).
Dans bash
, définissez cette fonction comme la fonction précommande Starship :
starship_precmd_user_func="set_titre_fenetre"
Dans zsh
, ajoutez ceci au tableau precmd_functions
:
precmd_functions+=(set_titre_fenetre)
Si vous aimez le résultat, ajoutez ces lignes à votre fichier de configuration shell (~/.bashrc
ou ~/.zshrc
) pour le rendre permanent.
Par exemple, si vous voulez afficher votre répertoire actuel dans le titre de l'onglet de votre terminal, ajoutez le code suivant à votre ~/.bashrc
ou ~/.zshrc
:
function set_win_title(){
echo -ne "\033]0; $(basename "$PWD") \007"
}
starship_precmd_user_func="set_win_title"
Enable Right Prompt
Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the right_format
option. Any module that can be used in format
is also supported in right_format
. The $all
variable will only contain modules not explicitly used in either format
or right_format
.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the fill module.
right_format
is currently supported for the following shells: elvish, fish, zsh.
Exemple
# ~/.config/starship.toml
# A minimal left prompt
format = """$character"""
# move the rest of the prompt to the right
right_format = """$all"""
Produces a prompt like the following:
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
Chaînes de style
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. bold
and BoLd
are considered the same string). Each word can be one of the following:
bold
italic
underline
dimmed
inverted
bg:<couleur>
fg:<couleur>
<couleur>
none
where <color>
is a color specifier (discussed below). fg:<color>
and <color>
currently do the same thing, though this may change in the future. inverted
swaps the background and foreground colors. The order of words in the string does not matter.
The none
token overrides all other tokens in a string if it is not part of a bg:
specifier, so that e.g. fg:red none fg:blue
will still create a string with no styling. bg:none
sets the background to the default color so fg:red bg:none
is equivalent to red
or fg:red
and bg:green fg:red bg:none
is also equivalent to fg:red
or red
. It may become an error to use none
in conjunction with other tokens in the future.
A color specifier can be one of the following:
- Une des couleurs standard du terminal :
black
,red
,green
,blue
,yellow
,purple
,cyan
,white
. Vous pouvez éventuellement les préfixer avecbright-
pour obtenir la version lumineuse (par exemplebright-white
). - Un
#
suivi d'un nombre hexadécimal de six chiffres. Ceci spécifie un Code hexadécimal de couleur RVB . - Un nombre entre 0 et 255. Ceci spécifie un code de couleur ANSI 8 bits.
If multiple colors are specified for foreground/background, the last one in the string will take priority.