Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<languages/>
<div lang="en" dir="ltr" class="mw-content-ltr">
[https://starship.rs/ Starship] is a fast, customizable, and minimal prompt for any shell. written in Rust, It displays relevant information like the current directory, Git status, runtime versions, and more, adapting to the context with minimal configuration. It supports multiple shells, including '''Bash''', [https://wiki.nixos.org/wiki/Zsh '''Zsh'''], [https://wiki.nixos.org/wiki/Fish '''Fish'''], '''PowerShell''' and a lot of other shells, and your configuration will stay persistent across all these shells and is designed for speed and efficiency.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Installation ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Using nix-shell ===
</div>

<syntaxhighlight lang="bash" start="3">
nix-shell -p starship
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Using Global Configuration ===
</div>

<syntaxhighlight lang="nix">
environment.systemPackages = [
  pkgs.starship
];
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
After modifying your configuration, apply the changes by running:
</div>

<syntaxhighlight lang="bash">
sudo nixos-rebuild switch
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Using Home Configuration ===
</div>

<syntaxhighlight lang="nix">
home.packages = [ 
  pkgs.starship 
];
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
After updating your configuration, apply the changes by running:
</div>

<syntaxhighlight lang="bash">
home-manager switch
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Configuration ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Basic ===
</div>

<syntaxhighlight lang="nix">
  programs.starship.enable = true; #enable starship
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
after you have installed starship you need to source it in your shell
</div>

Bash:
<syntaxhighlight lang="bash">
eval "$(starship init bash)"
</syntaxhighlight>
zsh:
<syntaxhighlight lang="zsh">
eval "$(starship init zsh)"
</syntaxhighlight>
fish:
<syntaxhighlight lang="fish">
starship init fish | source
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
if you use other shells than what I just mentioned please head to this [https://starship.rs/guide/#step-2-set-up-your-shell-to-use-starship page]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Advanced ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
you can customize starship with Nix (here's a snippet to understand)
<nowiki>:</nowiki>
</div>
<syntaxhighlight lang="nix">
programs.starship = {
      enable = true;
      settings = {
        add_newline = true;
        command_timeout = 1300;
        scan_timeout = 50;
        format= "$all$nix_shell$nodejs$lua$golang$rust$php$git_branch$git_commit$git_state$git_status\n$username$hostname$directory";
        character = {
          success_symbol = "[](bold green) ";
          error_symbol = "[✗](bold red) ";
        };
      };
};
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
since we can't include every option on Starship here's a GitHub link [https://gist.github.com/s-a-c/0e44dc7766922308924812d4c019b109#file-starship-nix/ containing every configuration option]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
and here's the official documentation to explain each option [https://starship.rs/config/ starship configuration guide]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
good luck
</div> :D

[[Category:Shell]]