brandon/oam
1
0
Fork 0
mirror of https://gitea.com/mcereda/oam.git synced 2026-02-08 21:34:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
oam/knowledge base/starship.md
Michele Cereda 0cd9a9ef52 chore(starship): improve configuration notes
2024-05-20 13:45:42 +02:00

1.7 KiB
Raw Permalink Blame History

Starship

Fast and customizable prompt for most shells.

  1. TL;DR
  2. Configuration
  3. Further readings

TL;DR

Installation and configuration 
# Installation.
brew install 'starship'
zypper in 'starship'

# Start when the shell starts.
eval "$(starship init bash)" | tee -a ~'/.bashrc'
eval "$(starship init zsh)" | tee -a ~'/.zshrc'
echo 'starship init fish | source' | tee -a ~'/.config/fish/config.fish'

# Initialize starship configuration.
mkdir -p ~'/.config' && touch ~'/.config/starship.toml'

# Change configuration.
starship config
vim ~'/.config/starship.toml'

# Print the whole configuration.
starship print-config
cat ~'/.config/starship.toml'
Usage 
# List available presets (prompt styles).
starship preset -l

Configuration

# Change configuration.
starship config
vim ~'/.config/starship.toml'

# Print the whole configuration.
starship print-config
cat ~'/.config/starship.toml'

# ~/.config/starship.toml

# Get editor completions based on the config schema.
"$schema" = 'https://starship.rs/config-schema.json'
command_timeout = 750

# Replace the default '❯' symbol in the prompt with '$'.
# The '$' character needs to be escaped.
[character]
success_symbol = '[\$](bold green)'
error_symbol = '[\$](bold red)'

Further readings