mirror of
https://github.com/starship/starship.git
synced 2024-12-26 17:18:49 +01:00
36351e4b2f
* docs: Update Nix installation documentation This changes the documentation to show the provided Home Manager module instead of manual Home Manager installation instructions. Also fixes a typo in the NixOS instructions and removes the unfinished and now unnecessary section on zsh integration via Home manager (since that is included in the provided module). * docs: Change example Home Manager configuration |
||
|---|---|---|
| .. | ||
| README.md | ||
🚀 Advanced Installation
To install starship, you need to do two things:
- Get the starship binary onto your computer
- Tell your shell to use the starship binary as its prompt by modifying its init scripts
For most users, the instructions on the main page will work great. However, for some more specialized platforms, different instructions are needed.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
termux
Prerequisites
pkg install getconf
Installation
curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin
Nix
Getting the Binary
Imperatively
nix-env -iA nixos.starship
Declarative, single user, via home-manager
Enable the programs.starship module in your home.nix file, and add your settings
{
programs.starship = {
enable = true;
enableZshIntegration = true;
# Configuration written to ~/.config/starship.toml
settings = {
# add_newline = false;
# character = {
# success_symbol = "[➜](bold green)";
# error_symbol = "[➜](bold red)";
# };
# package.disabled = true;
};
};
}
then run
home-manager switch
Declarative, system-wide, with NixOS
Add pkgs.starship to environment.systemPackages in your configuration.nix,
then run
sudo nixos-rebuild switch