starship/docs/ru-RU/advanced-config

Расширенная конфигурация

Хотя Starship - это универсальная оболочка, иногда вам нужно сделать больше, чем просто редактировать starship.toml, для того чтобы сделать определенные вещи. Эта страница описывает некоторые из дополнительных техник конфигурации, используемых в Starship.

::: warning

Конфигурации в этом разделе могут быть изменены в будущих выпусках Starship.

:::

TransientPrompt для PowerShell

It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run Enable-TransientPrompt in the shell session. To make it permanent, put this statement in your $PROFILE. Transience can be disabled on-the-fly with Disable-TransientPrompt.

By default, the left side of input gets replaced with >. To customize this, define a new function called Invoke-Starship-TransientFunction. For example, to display Starship's character module here, you would do

function Invoke-Starship-TransientFunction {
  &starship module character
}

Invoke-Expression (&starship init powershell)

Enable-TransientPrompt

TransientPrompt and TransientRightPrompt in Cmd

Clink 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, run clink set prompt.transient <value> where <value> can be one of:

• always: always replace the previous prompt
• same_dir: replace the previous prompt only if the working directory is same
• off: do not replace the prompt (i.e. turn off transience)

You need to do this only once. Make the following changes to your starship.lua to customize what gets displayed on the left and on the right:

• By default, the left side of input gets replaced with >. To customize this, define a new function called starship_transient_prompt_func. This function receives the current prompt as a string that you can utilize. For example, to display Starship's character module here, you would do

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

It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. 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 called starship_transient_prompt_func. For example, to display Starship's character module here, you would do

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 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 this option has a non-empty value, the prompt specified by PS1 is erased on leaving the current command line. If the 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 the 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 ~/.bashrc 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's character 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"))()

Пользовательские команды перед командной строкой и перед запуском Bash

Bash не имеет формальной среды preexec/precmd, как и большинство других оболочек. Из-за этого трудно предоставить полностью настраиваемые хуки в bash. Тем не менее, Starship дает вам ограниченную возможность вставить собственные функции в процедуру отображения подсказки:

• Чтобы запустить пользовательскую функцию прямо перед отображением подсказки, определите новую функцию и затем назначьте ей имя starship_precmd_user_func. Например, чтобы нарисовать ракету перед появлением подсказки, сделайте

function blastoff(){
    echo "🚀"
}
starship_precmd_user_func="blastoff"

• To run a custom function right before a command runs, you can use the DEBUG trap mechanism. Тем не менее, вы должны поймать сигнал DEBUG перед инициализацией Starship! Starship может сохранить значение ловушки DEBUG, но если ловушка перезаписана после запуска Starship, некоторая функциональность сломается.

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. Из-за этого трудно предоставить полностью настраиваемые хуки в powershell. Тем не менее, Starship дает вам ограниченную возможность вставить собственные функции в процедуру отображения подсказки:

Create a function named Invoke-Starship-PreCommand

function Invoke-Starship-PreCommand {
    $host.ui.Write("🚀")
}

Изменение заголовка окна

Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish даже делает это по умолчанию. Starship does not do this, but it's fairly straightforward to add this functionality to bash, zsh, cmd or powershell.

Сначала задайте функцию изменения заголовка окна (идентичную в bash и zsh):

function set_win_title(){
    echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
}

Вы можете использовать переменные для настройки этого заголовка ($USER, $HOSTNAME, и $PWD являются популярными вариантами).

В bash, установите эту функцию как функцию precmd в Starship:

starship_precmd_user_func="set_win_title"

В zsh, добавьте это в массив precmd_functions:

precmd_functions+=(set_win_title)

If you like the result, add these lines to your shell configuration file (~/.bashrc or ~/.zshrc) to make it permanent.

Например, если вы хотите отобразить ваш текущий каталог в заголовке вкладки терминала, добавьте следующие строки в ~/. bashrc или ~/.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 should be installed in order to use right prompt in bash.

Пример

# ~/.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

Пример

# ~/.config/starship.toml

# A continuation prompt that displays two filled in arrows
continuation_prompt = '▶▶ '

Строки стиля

Строки стиля - это список слов, разделенных пробелами. Слова не чувствительны к регистру (то есть bold и BoLd считаются одной строкой). Каждое слово может быть одним из следующих:

• bold
• italic
• underline
• dimmed
• inverted
• blink
• hidden
• strikethrough
• bg:<color>
• fg:<color>
• <color>
• none

где <color> является цветовым спецификатором (обсуждается ниже). fg:<color> and <color> currently do the same thing, though this may change in the future. inverted swaps the background and foreground colors. Порядок слов в строке не имеет значения.

Токен none переопределяет все остальные токены в строке, если он не является частью спецификатора bg: так, например, fg:red none fg:blue все равно создаст строку без стиля. 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. Использование none в сочетании с другими токенами может стать ошибкой в будущем.

Цветовой спецификатор может быть одним из следующих:

• Один из стандартных цветов терминалов: black, red, green, blue, gellow, purple, cyan, white. You can optionally prefix these with bright- to get the bright version (e.g. bright-white).
• #, за которой следует шестизначное шестнадцатеричное число. Это определяет шестнадцатеричный код цвета RGB.
• Число от 0 до 255. Это определяет 8-битный код цвета ANSI.

Если для переднего плана/фона задано несколько цветов, то последняя из строк будет иметь приоритет.

Не все строки стиля будут корректно отображаться в терминале. В частности, существуют следующие известные ошибки:

• Во многих терминалах по умолчанию отключена поддержка blink
• hidden не поддерживается в iTerm.
• strikethrough по умолчанию не поддерживается в macOS Terminal.app