Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-30 20:59:13 +00:00
Code Issues Releases Activity
The minimal, blazing-fast, and infinitely customizable prompt for any shell!
835 Commits 5 Branches 116 Tags 42 MiB
Rust 95.4%
Shell 2.9%
PowerShell 1.1%
Lua 0.2%
Xonsh 0.1%
9924af55db
Go to file
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
.github chore: update "ask a question" to direct to the new discussion page 2020-04-02 00:10:09 -04:00
docs feat(aws): Use AWS_VAULT as the profile if set (#984) 2020-04-06 16:59:56 +02:00
install feat(installer): Ask for permission escalation during installation, if needed (#914) 2020-02-12 21:13:21 -05:00
media chore(bump): v0.35.0 2020-02-06 09:56:39 -05:00
src feat(aws): Use AWS_VAULT as the profile if set (#984) 2020-04-06 16:59:56 +02:00
starship_module_config_derive docs: Replace project tagline 2020-02-12 21:46:00 -05:00
tests feat(aws): Use AWS_VAULT as the profile if set (#984) 2020-04-06 16:59:56 +02:00
.gitignore chore: Cleanup after the config refactor (#453) 2019-09-30 23:56:05 +09:00
Cargo.lock build(deps): bump serde_json from 1.0.50 to 1.0.51 2020-04-06 06:03:11 +00:00
Cargo.toml build(deps): bump serde_json from 1.0.50 to 1.0.51 2020-04-06 06:03:11 +00:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#42) 2019-04-30 23:30:42 -04:00
CONTRIBUTING.md fix: possible fix for Intermittent Test Failures in GH Actions (#987) 2020-03-15 12:12:25 -05:00
crowdin.yml docs: Fix link to Japanese README 2019-10-11 17:32:52 +09:00
LICENSE docs: Attribute copyright to Starship Contributors (#115) 2019-07-25 12:50:29 -04:00
README.md docs: Add twitter badge to README 2020-02-13 15:49:40 -05:00
snapcraft.yaml docs: Replace project tagline 2020-02-12 21:46:00 -05:00

README.md

Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord Follow @StarshipPrompt on Twitter

Website · Installation · Configuration

English   日本語   繁體中文   Русский   Deutsch   简体中文   Español   Français

Starship with iTerm2 and the Snazzy theme

The minimal, blazing-fast, and infinitely customizable prompt for any shell!

  • Fast: it's fast – really really fast! 🚀
  • Customizable: configure every aspect of your prompt.
  • Universal: works on any shell, on any operating system.
  • Intelligent: shows relevant information at a glance.
  • Feature rich: support for all your favorite tools.
  • Easy: quick to install – start using it in minutes.

Explore the Starship docs  ▶

🚀 Installation

Prerequisites

Getting Started

  1. Install the starship binary:

    Install Latest Version

    From prebuilt binary, with Shell:
    curl -fsSL https://starship.rs/install.sh | bash
    From source on crates.io:
    cargo install starship

    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):

    Invoke-Expression (&starship init powershell)

    Ion

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

    # ~/.config/ion/initrc

eval $(starship init ion)

🤝 Contributing

We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a good first issue.

If you are interested in helping contribute to starship, please take a look at our Contributing Guide. Also, feel free to drop into our Discord server and say hi. 👋

💭 Inspired By

Please check out these previous works that helped inspire the creation of starship. 🙏


Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.