starship/docs
renovate[bot] 91c1b4f661
build(deps): update dependency vitepress to ^1.0.2
2024-04-08 01:44:28 +00:00
..
.vitepress feat(docs): move to vitepress (#5785) 2024-03-03 17:55:30 +01:00
advanced-config docs: document ble.sh version requirement (#5861) 2024-03-24 08:04:11 +01:00
ar-SA docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
bn-BD docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
ckb-IR docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
config feat(k8s): Add detect env vars option (#4488) 2024-04-06 15:30:19 +02:00
de-DE docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
es-ES docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
faq docs(faq): fix typo (#5905) 2024-04-04 21:33:14 +02:00
fr-FR docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
guide docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
id-ID docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
installing feat(docs): move to vitepress (#5785) 2024-03-03 17:55:30 +01:00
it-IT docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
ja-JP docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
ko-KR docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
migrating-to-0.45.0 ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
nl-NL docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
no-NO docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
pl-PL docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
presets feat(docs): move to vitepress (#5785) 2024-03-03 17:55:30 +01:00
pt-BR docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
pt-PT docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
public feat(gleam): Add Gleam module (#5886) 2024-04-05 23:56:15 +02:00
ru-RU docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
tr-TR docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
uk-UA docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
vi-VN docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
zh-CN docs(i18n): new Crowdin updates (#5869) 2024-03-24 18:52:26 +09:00
zh-TW docs(i18n): new Crowdin updates (#5883) 2024-03-30 00:42:36 +09:00
README.md feat(docs): move to vitepress (#5785) 2024-03-03 17:55:30 +01:00
package-lock.json build(deps): update dependency vitepress to ^1.0.2 2024-04-08 01:44:28 +00:00
package.json build(deps): update dependency vitepress to ^1.0.2 2024-04-08 01:44:28 +00:00

README.md

layout hero features footer metaTitle description
home
image text tagline actions
/logo.svg null The minimal, blazing-fast, and infinitely customizable prompt for any shell!
theme text link
brand Get Started → ./guide/
title details
Compatibility First Works on the most common shells on the most common operating systems. Use it everywhere!
title details
Rust-Powered Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
title details
Customizable Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
ISC Licensed | Copyright © 2019-present Starship Contributors Starship: Cross-Shell Prompt Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.

Prerequisites

  • A Nerd Font installed and enabled in your terminal.

Quick Install

  1. Install the starship binary:

    Install Latest Version

    With Shell:

    curl -sS https://starship.rs/install.sh | sh
    

    To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.

    Install via Package Manager

    With Homebrew:

    brew install starship
    

    With Winget:

    winget install starship
    
  2. Add the init script to your shell's config file:

    Bash

    Add the following to the end of ~/.bashrc:

    # ~/.bashrc
    
    eval "$(starship init bash)"
    

    Fish

    Add the following to the end of ~/.config/fish/config.fish:

    # ~/.config/fish/config.fish
    
    starship init fish | source
    

    Zsh

    Add the following to the end of ~/.zshrc:

    # ~/.zshrc
    
    eval "$(starship init zsh)"
    

    Powershell

    Add the following to the end of Microsoft.PowerShell_profile.ps1. You can check the location of this file by querying the $PROFILE variable in PowerShell. Typically the path is ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 or ~/.config/powershell/Microsoft.PowerShell_profile.ps1 on -Nix.

    Invoke-Expression (&starship init powershell)
    

    Ion

    Add the following to the end of ~/.config/ion/initrc:

    # ~/.config/ion/initrc
    
    eval $(starship init ion)
    

    Elvish

    ::: warning

    Only elvish v0.18 or higher is supported.

    :::

    Add the following to the end of ~/.elvish/rc.elv:

    # ~/.elvish/rc.elv
    
    eval (starship init elvish)
    

    Tcsh

    Add the following to the end of ~/.tcshrc:

    # ~/.tcshrc
    
    eval `starship init tcsh`
    

    Nushell

    ::: warning

    This will change in the future. Only Nushell v0.78+ is supported.

    :::

    Add the following to the end of your Nushell env file (find it by running $nu.env-path in Nushell):

    mkdir ~/.cache/starship
    starship init nu | save -f ~/.cache/starship/init.nu
    

    And add the following to the end of your Nushell configuration (find it by running $nu.config-path):

    use ~/.cache/starship/init.nu
    

    Xonsh

    Add the following to the end of ~/.xonshrc:

    # ~/.xonshrc
    
    execx($(starship init xonsh))
    

    Cmd

    You need to use Clink (v1.2.30+) with Cmd. Add the following to a file starship.lua and place this file in Clink scripts directory:

    -- starship.lua
    
    load(io.popen('starship init cmd'):read("*a"))()