Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2025-01-26 08:38:28 +00:00
Code Issues Releases Activity
starship/docs
History
Thomas O'Donnell 7b09c86b0f
docs(git_status): Update git_status module docs (#1667) 
* docs: Update git_status module docs

Have updated the configuration docs for the `git_status` to remove a
non-existing option and to add an example for how to achieve the same
effect as with the new format strings.

* Add git_status changes to migration guide

Have added the change to the sync count to the migration guide. I also
corrected a few typos in the configuration.
2020-09-26 19:15:52 +02:00
..
.vuepress
docs: fix code block overflow on mobile (#1492)
2020-07-19 19:53:23 -04:00
advanced-config
docs: show current directory in terminal window title (#1415)
2020-07-01 20:46:40 -04:00
config
docs(git_status): Update git_status module docs (#1667)
2020-09-26 19:15:52 +02:00
de-DE
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
es-ES
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
faq
docs: Improvements in docs for custom modules (#1615)
2020-09-01 19:07:12 +02:00
fr-FR
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
guide
docs: Add vuepress with initial docs (#99)
2019-07-19 16:18:52 -04:00
ja-JP
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
migrating-to-0.45.0
docs(git_status): Update git_status module docs (#1667)
2020-09-26 19:15:52 +02:00
presets
docs: Add perl official logo in NerdFont (#1558)
2020-08-04 23:15:58 +02:00
pt-BR
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
pt-PT
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
ru-RU
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
zh-CN
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
zh-TW
docs(i18n): New Crowdin translations (#1366)
2020-07-23 17:07:10 -04:00
package-lock.json
build(deps-dev): bump @vuepress/plugin-google-analytics in /docs (#1613)
2020-08-25 10:50:57 -04:00
package.json
build(deps-dev): bump @vuepress/plugin-google-analytics in /docs (#1613)
2020-08-25 10:50:57 -04:00
README.md
revert: "docs: add Netlify link to footer"
2020-02-22 12:57:49 -05:00

README.md

home heroImage heroText tagline actionText actionLink features footer metaTitle description
true /logo.svg null The minimal, blazing-fast, and infinitely customizable prompt for any shell! 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, and PowerShell.

Quick Install

  1. Install the starship binary:

    Install Latest Version

    With Shell:

    curl -fsSL https://starship.rs/install.sh | bash

    Install via Package Manager

    With Homebrew:

    brew install starship

    With Scoop:

    scoop 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 ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 (or ~/.config/powershell/Microsoft.PowerShell_profile.ps1 on -Nix):

    # ~\Documents\PowerShell\Profile.ps1

Invoke-Expression (&starship init powershell)

    Ion

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

    # ~/.config/ion/initrc

eval $(starship init ion)