extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-11-22 08:14:10 +01:00
Code Issues Packages Projects Releases Wiki Activity
☄🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
1,509 Commits 9 Branches 144 Tags 163 MiB
Rust 95.6%
Shell 2.9%
PowerShell 1.1%
Lua 0.1%
dd9e7323d6
Go to file
Michel Alexandre Salim dd9e7323d6
fix: [install.sh] if glibc >= 2.18, use the dynamically linked binary 
`install.sh` previously uses the statically linked `unknown-linux-musl` build
for every Linux installation. If the host's `libc` is a recent enough
GNU libc, however,  it should use this rather than the statically linked build.

Includes documentation from the PR conversation about how to recompute the
minimum version as needed.

Signed-off-by: Michel Alexandre Salim <michel@michel-slm.name>
2021-04-21 16:35:00 -07:00
.github ci: remove AUR deploy (#2411) 2021-03-04 15:54:41 -05:00
docs docs: Document the command_timeout option (#2604) 2021-04-18 19:32:00 +02:00
install fix: [install.sh] if glibc >= 2.18, use the dynamically linked binary 2021-04-21 16:35:00 -07:00
media docs(i18n): add Vietnamese doc translations 2021-01-26 17:25:25 -05:00
src feat(battery): Add a symbol option to battery.display (#2475) 2021-04-17 13:52:46 +02:00
starship_module_config_derive feat(config): print a suggestion for unknown fields (#2560) 2021-04-06 22:12:37 +02:00
.gitignore feat(package): Add Maven pom.xml version support (#1511) 2020-07-31 09:54:03 +02:00
.rustfmt.toml style: make rustfmt use the default configuration (#1661) 2020-09-19 08:45:17 +02:00
build.rs build: Add additional build information to version and bug report (#2124) 2021-01-22 20:14:51 +01:00
Cargo.lock build(deps): bump open from 1.6.0 to 1.7.0 2021-04-19 05:46:15 +00:00
Cargo.toml build(deps): bump open from 1.6.0 to 1.7.0 2021-04-19 05:46:15 +00:00
CODE_OF_CONDUCT.md Update to Contributor Covenant v2.0 2021-04-14 17:47:08 -04:00
CONTRIBUTING.md feat: allow changing default command timeout (#2283) 2021-02-11 21:34:47 +01:00
Cross.toml build: add x86_64 freebsd build (#2233) 2021-01-30 12:50:38 +01:00
crowdin.yml chore: update Crowdin PR title 2021-01-29 16:53:32 -05:00
LICENSE docs: update license to include 2021 (#2207) 2021-01-26 22:43:20 +01:00
README.md docs: update install instructions (#2553) 2021-04-08 19:42:45 +02:00
snapcraft.yaml build: Update snapcraft.yaml (#2535) 2021-04-01 18:54:50 +02: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   Tiếng Việt

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

Note: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the extra platform instructions.

  1. Install the starship binary:

    Install Latest Version

    From prebuilt binary, with Shell:
    sh -c "$(curl -fsSL https://starship.rs/install.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

    Example: 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 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.15 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`

🤝 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 fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the Starship Crowdin.

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. 👋

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

💭 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.