Starship

https://starship.rs/
Admin
A minimal, blazing-fast, and infinitely customizable prompt for any shell, built with Rust for speed...
Tokens:451,487
Snippets:3,299
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Pure preset with starship preset command

Source: https://starship.rs/ar-SA/presets/pure-preset

Run this command to install the Pure preset by writing its configuration to ~/.config/starship.toml.

```sh
starship preset pure-preset -o ~/.config/starship.toml
```

--------------------------------

### Network Namespace module configuration example

Source: https://starship.rs/ko-KR/config

Example configuration for the Network Namespace module, setting format and style.

```toml
[netns]
format = '[$symbol \[$name\]]($style)'
style = 'blue bold dimmed'
```

--------------------------------

### Container module example configuration

Source: https://starship.rs/pl-PL/config

Example TOML configuration for the container module in ~/.config/starship.toml, setting a custom format string.

```toml
# ~/.config/starship.toml

[container]
format = '[$symbol\[$name\]]($style) '
```

--------------------------------

### Install starship with Chocolatey

Source: https://starship.rs/bn-BD/installing

Installs the starship binary using the Chocolatey package manager on Windows. Requires Chocolatey to be installed first.

```powershell
choco install starship
```

--------------------------------

### Incomplete Fortran example

Source: https://starship.rs/ar-SA/config

This is a code fence label, not actual code. It appears before the Fortran module example, but the example content is missing.

```text
toml
```

--------------------------------

### os module configuration example

Source: https://starship.rs/ar-SA/config

Example configuration for the os module. Sets format, style, and custom symbols for Windows and Arch. The format uses the name variable and style.

```toml
# ~/.config/starship.toml

[os]
format = "on [($name )]($style)"
style = "bold blue"
disabled = false

[os.symbols]
Windows = " "
Arch = "Arch is the best! "
```

--------------------------------

### Configure Go module format

Source: https://starship.rs/pt-PT/config

Example configuration for the Go (golang) module, setting a custom format that displays the version in bold cyan.

```toml
# ~/.config/starship.toml

[golang]
format = 'via [🐹 $version](bold cyan) '
```

--------------------------------

### Install Starship to user-writable directory with -b

Source: https://starship.rs/ar-SA/faq

Use this command to install Starship without sudo by setting the installation directory to ~/.local/bin. The -b option overrides the default directory, which is $BIN_DIR or /usr/local/bin. Add -y for non-interactive installation.

```bash
curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin
```

--------------------------------

### Install Starship with Winget

Source: https://starship.rs/

Installs Starship via Winget on Windows.

```powershell
winget install starship
```

--------------------------------

### Install Starship with Homebrew

Source: https://starship.rs/

Installs Starship via Homebrew on macOS or Linux.

```sh
brew install starship
```

--------------------------------

### Fill module configuration and output

Source: https://starship.rs/ar-SA/config

Example configuration for the fill module, which fills extra space with a symbol. The format uses two fill modules to align other modules. The output shows the resulting prompt.

```toml
# ~/.config/starship.toml
format = 'AA $fill BB $fill CC'

[fill]
symbol = '-'
style = 'bold green'
```

```text
AA -------------------------------------------- BB -------------------------------------------- CC
```

--------------------------------

### Install starship imperatively with nix-env

Source: https://starship.rs/bn-BD/installing

Imperatively installs starship on NixOS using nix-env.

```sh
nix-env -iA nixos.starship
```
Tokens:
Raw