Configurazione Avanzata
Nonostante Starship sia una shell versatile, a volte devi fare qualche modifica in più in starship.toml
per ottenere alcune cose. Questa pagina descrive alcune tecniche di configurazione avanzate utilizzate in Starship.
WARNING
Le configurazioni in questa sezione sono soggette a modifiche nelle future versioni di Starship.
TransientPrompt su PowerShell
È possibile rimpiazzare il prompt precedente con una stringa di testo personalizzata. È utile nei casi in cui alcune informazioni sulla shell non ci servono. Per attivarlo, esegui Enable-TransientPrompt
sulla shell. Per mantenerlo permanente, metti questa dichiarazione nel tuo $PROFILE
. Può essere disattivata al volo con Disable-TransientPrompt
.
Per impostazione predefinita, il simbolo predefinito prima dell'input sarà rimpiazzato con >
. Per personalizzarlo, definisci una nuova funzione chiamata Invoke-Starship-TransientFunction
. Ad esempio, per mostrare il modulo dei character
, dovresti fare
function Invoke-Starship-TransientFunction {
&starship module character
}
Invoke-Expression (&starship init powershell)
Enable-TransientPrompt
TransientPrompt e TransientRightPrompt in Cmd
È possibile rimpiazzare il prompt precedente con una stringa di testo personalizzata. È utile nei casi in cui alcune informazioni sulla shell non ci servono. Per attivarlo, esegui clink set prompt.transient <value>
dove <value> può essere uno tra:
always
: sostituisce sempre il prompt precedentesame_dir
: sostituisce il prompt precedente solo se la directory di lavoro è la stessaoff
: non sostituisce il prompt (cioè disattiva la transizione)
Devi fare questo solo una volta. Fai le seguenti modifiche alla tua starship.lua
per personalizzare ciò che viene visualizzato a sinistra e a destra:
- Per impostazione predefinita, il simbolo predefinito prima dell'input sarà rimpiazzato con
>
. To customize this, define a new function calledstarship_transient_prompt_func
. This function receives the current prompt as a string that you can utilize. Ad esempio, per mostrare il modulo deicharacter
, dovresti fare
function starship_transient_prompt_func(prompt)
return io.popen("starship module character"
.." --keymap="..rl.getvariable('keymap')
):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
- By default, the right side of input is empty. To customize this, define a new function called
starship_transient_rprompt_func
. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
function starship_transient_rprompt_func(prompt)
return io.popen("starship module time"):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
TransientPrompt and TransientRightPrompt in Fish
È possibile rimpiazzare il prompt precedente con una stringa di testo personalizzata. È utile nei casi in cui alcune informazioni sulla shell non ci servono. To enable this, run enable_transience
in the shell session. To make it permanent, put this statement in your ~/.config/fish/config.fish
. Transience can be disabled on-the-fly with disable_transience
.
Note that in case of Fish, the transient prompt is only printed if the commandline is non-empty, and syntactically correct.
- By default, the left side of input gets replaced with a bold-green
❯
. To customize this, define a new function calledstarship_transient_prompt_func
. Ad esempio, per mostrare il modulo deicharacter
, dovresti fare
function starship_transient_prompt_func
starship module character
end
starship init fish | source
enable_transience
- By default, the right side of input is empty. To customize this, define a new function called
starship_transient_rprompt_func
. For example, to display the time at which the last command was started here, you would do
function starship_transient_rprompt_func
starship module time
end
starship init fish | source
enable_transience
TransientPrompt and TransientRightPrompt in Bash
The Ble.sh framework at v0.4 or higher allows you to replace the previous-printed prompt with custom strings. This is useful in cases where all the prompt information is not always needed. To enable this, put this in ~/.bashrc
bleopt prompt_ps1_transient=<value>
:
The <value> here is a colon-separated list of always
, same-dir
and trim
. When prompt_ps1_final
is empty and the option prompt_ps1_transient
has a non-empty <value>, the prompt specified by PS1
is erased on leaving the current command line. If <value> contains a field trim
, only the last line of multiline PS1
is preserved and the other lines are erased. Otherwise, the command line will be redrawn as if PS1=
is specified. When a field same-dir
is contained in <value> and the current working directory is different from the final directory of the previous command line, this option prompt_ps1_transient
is ignored.
Make the following changes to your ~/.blerc
(or in ~/.config/blesh/init.sh
) to customize what gets displayed on the left and on the right:
- To customize what the left side of input gets replaced with, configure the
prompt_ps1_final
Ble.sh option. For example, to display Starship'scharacter
module here, you would do
bleopt prompt_ps1_final='$(starship module character)'
- To customize what the right side of input gets replaced with, configure the
prompt_rps1_final
Ble.sh option. For example, to display the time at which the last command was started here, you would do
bleopt prompt_rps1_final='$(starship module time)'
Custom pre-prompt and pre-execution Commands in Cmd
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands in Cmd shell. It is fairly simple to use with Starship. Make the following changes to your starship.lua
file as per your requirements:
- To run a custom function right before the prompt is drawn, define a new function called
starship_preprompt_user_func
. This function receives the current prompt as a string that you can utilize. For example, to draw a rocket before the prompt, you would do
function starship_preprompt_user_func(prompt)
print("🚀")
end
load(io.popen('starship init cmd'):read("*a"))()
- To run a custom function right before a command is executed, define a new function called
starship_precmd_user_func
. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do
function starship_precmd_user_func(line)
print("Executing: "..line)
end
load(io.popen('starship init cmd'):read("*a"))()
Comandi personalizzati di pre-prompt e pre-esecuzione per Bash
Bash non ha un framework preexec/precmd formale come la maggior parte delle altre shell. Per questo motivo, è difficile fornire hook completamente personalizzabile in bash
. Tuttavia, Starship dà la limitata possibilità di inserire le tue funzioni nella procedura prompt-rendering:
- Per eseguire una funzione personalizzata a destra del prompt prima che venga disegnato, definisci una nuova funzione e assegna il suo nome a
starship_precmd_user_func
. Per esempio, per visualizzare l'icona di un razzo prima del prompt, si può usare il codice seguente
function blastoff(){
echo "🚀"
}
starship_precmd_user_func="blastoff"
- Per eseguire una funzione personalizzata prima dell'esecuzione di un comando, è possibile utilizzare il meccanismo trappola
DEBUG
. Tuttavia, devi intrappolare il segnale DEBUG prima di inizializzare Starship! Starship può preservare il valore trappola di DEBUG, ma se la trappola viene sovrascritta dopo l'avvio di Starship, alcune funzionalità non funzioneranno.
function blastoff(){
echo "🚀"
}
trap blastoff DEBUG # Trap DEBUG *before* running starship
set -o functrace
eval $(starship init bash)
set +o functrace
Custom pre-prompt and pre-execution Commands in PowerShell
PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in powershell
. Tuttavia, Starship dà la limitata possibilità di inserire le tue funzioni nella procedura prompt-rendering:
Create a function named Invoke-Starship-PreCommand
function Invoke-Starship-PreCommand {
$host.ui.Write("🚀")
}
Cambia il titolo della finestra
Alcune shell prompt cambieranno automaticamente il titolo della finestra (ad esempio per riflettere la directory di lavoro). Fish lo fa per impostazione predefinita. Starship does not do this, but it's fairly straightforward to add this functionality to bash
, zsh
, cmd
or powershell
.
Innanzitutto, bisogna definire una funzione per il cambio del titolo della finestra (identica sia per bash che zsh):
function set_win_title(){
echo -ne "\033]0; IL_TUO_TITOLO_QUI \007"
}
Puoi usare delle variabili per personalizzare questo titolo ($USER
, $HOSTNAME
, e $PWD
sono le scelte più popolari).
In bash
, impostare questa funzione per essere la precmd Starship function:
starship_precmd_user_func="set_win_title"
In zsh
, aggiungi questo precmd_functions
all'array:
precmd_functions+=(set_win_title)
Se ti piace il risultato, aggiungi queste righe al tuo file shell di configurazione (~/.bashrc
o ~/.zshrc
) per renderlo permanente.
Ad esempio, se desideri visualizzare la directory corrente nel titolo della scheda del terminale, aggiungi la seguente snippet al tuo ~/.bashrc
or ~/.zshrc
:
function set_win_title(){
echo -ne "\033]0; $(basename "$PWD") \007"
}
starship_precmd_user_func="set_win_title"
For Cmd, you can change the window title using the starship_preprompt_user_func
function.
function starship_preprompt_user_func(prompt)
console.settitle(os.getenv('USERNAME').."@"..os.getenv('COMPUTERNAME')..": "..os.getcwd())
end
load(io.popen('starship init cmd'):read("*a"))()
You can also set a similar output with PowerShell by creating a function named Invoke-Starship-PreCommand
.
# edit $PROFILE
function Invoke-Starship-PreCommand {
$host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
}
Invoke-Expression (&starship init powershell)
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, xonsh, cmd, nushell, bash.
Note: The Ble.sh framework v0.4 or higher should be installed in order to use right prompt in bash.
Esempio
# ~/.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
Continuation Prompt
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
Starship can set the continuation prompt using the continuation_prompt
option. The default prompt is '[∙](bright-black) '
.
Note: continuation_prompt
should be set to a literal string without any variables.
Note: Continuation prompts are only available in the following shells:
bash
zsh
PowerShell
Esempio
# ~/.config/starship.toml
# A continuation prompt that displays two filled-in arrows
continuation_prompt = '▶▶ '
Stile delle Stringhe
Le stringhe di stile sono un elenco di parole, separate da spazi bianchi. Le parole non sono sensibili alle maiuscole (cioè grassetto
e BoLd
sono considerate la stessa stringa). Ogni parola può essere una delle seguenti:
bold
italic
underline
dimmed
inverted
blink
hidden
strikethrough
bg:<color>
fg:<color>
<color>
none
dove <color>
è un colore specifico (discusso in seguito). fg:<color>
e <color>
attualmente fanno la stessa cosa, anche se questo potrebbe cambiare in futuro. <color>
can also be set to prev_fg
or prev_bg
which evaluates to the previous item's foreground or background color respectively if available or none
otherwise. inverted
scambia lo sfondo e i colori in primo piano. L'ordine delle parole nella stringa non conta.
Il token none
sovrascrive tutti gli altri token in una stringa se non fa parte di uno specificatore bg:
, così ad esempio fg:red none fg:blue
creerà una stringa senza stile. bg:none
imposta come colore di sfondo quello predefinito così fg:red bg:none
è equivalente a red
o fg:red
e bg:green fg:red bg:none
è equivalente a fg:red
o red
. Potrà diventare un errore usare none
in combinazione con altri token in futuro.
Uno colore specifico può essere uno di questi:
- One of the standard terminal colors:
black
,red
,green
,blue
,yellow
,purple
,cyan
,white
. You can optionally prefix these withbright-
to get the bright version (e.g.bright-white
). - Un
#
seguito da un valore esadecimale a sei cifre. Questo specifica un colore esagesimale in RGB. - Un numero compreso tra 0-255. Specifica un codice colore ANSI a 8 bit.
Se sono specificati più colori per il primo piano/sfondo, l'ultimo nella stringa avrà la priorità.
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
- Many terminals disable support for
blink
by default. hidden
is not supported on iTerm.strikethrough
is not supported by the default macOS Terminal.app.