1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-25 11:20:01 +00:00
starship/docs/installing
Dani d009db528d
docs(installation): add advanced installation (#1643)
Adds an "Advanced Installation" page to the documentation website.
2021-01-05 17:05:03 -06:00
..
README.md docs(installation): add advanced installation (#1643) 2021-01-05 17:05:03 -06:00

🚀 Advanced Installation

To install starship, you need to do two things:

  1. Get the starship binary onto your computer
  2. 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!

Nix

Getting the Binary

Imperatively

nix-env -iA nixos.starship

Declarative, single user, via home-manager

Add pkgs.starship to your home.packages in your home.nix file, then run

home-manager switch

Declarative, system-wide, with NixOS

Add pkgs.starship to environment.packages in your configuration.nix, then run

sudo nixos-rebuild switch

Modifying Init Scripts

With Nix and home-manager, using zsh:

Add the following to programs.zsh.initExtra in your home.nix file, then run

home-manager switch