Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-05 04:47:58 +00:00
Code Issues Releases Activity
9924af55db
starship/docs
History
Kevin Pullin 9924af55db
feat(aws): Use AWS_VAULT as the profile if set (#984) 
* Use AWS_VAULT as the profile if set

[aws-vault](https://github.com/99designs/aws-vault) sets
the `AWS_VAULT` env var instead of `AWS_PROFILE` when an
aws-vault session is active.

This PR adds support for reading the AWS profile value from
the `AWS_VAULT` env var, giving priority to `AWS_VAULT` if both
it and `AWS_PROFILE` are set.

* Update docs for AWS_VAULT
2020-04-06 16:59:56 +02:00
..
.vuepress revert: "docs: add Netlify link to footer" 2020-02-22 12:57:49 -05:00
advanced-config docs: Add extra newlines around custom containers 2019-09-28 20:20:18 +09:00
config feat(aws): Use AWS_VAULT as the profile if set (#984) 2020-04-06 16:59:56 +02:00
de-DE docs(i18n): new Crowdin translations (#919) 2020-04-03 12:35:39 -04:00
es-ES docs(i18n): new Crowdin translations (#919) 2020-04-03 12:35:39 -04:00
faq docs: Correct a typo in the FAQs (#732) 2019-12-13 15:26:23 -05:00
fr-FR docs(i18n): new Crowdin translations (#919) 2020-04-03 12:35:39 -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 (#919) 2020-04-03 12:35:39 -04:00
presets docs: Add a "Presets" page to the website (#783) 2019-12-23 22:32:48 -05:00
ru-RU docs(i18n): new Crowdin translations (#919) 2020-04-03 12:35:39 -04:00
zh-CN docs(i18n): new Crowdin translations (#919) 2020-04-03 12:35:39 -04:00
zh-TW docs(i18n): new Crowdin translations (#919) 2020-04-03 12:35:39 -04:00
package-lock.json build(deps): bump acorn from 6.4.0 to 6.4.1 in /docs (#1008) 2020-03-15 21:06:16 -04:00
package.json docs: Improve description meta tag for SEO 2020-02-02 19:51:48 -05: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)