extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-11-25 17:54:08 +01:00
Code Issues Packages Projects Releases Wiki Activity
☄🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
1,406 Commits 9 Branches 144 Tags 167 MiB
Rust 95.6%
Shell 2.9%
PowerShell 1.1%
Lua 0.1%
28170f62b0
Go to file
dependabot-preview[bot] 28170f62b0
build(deps-dev): bump vuepress from 1.8.1 to 1.8.2 in /docs (#2368) 
Bumps [vuepress](https://github.com/vuejs/vuepress/tree/HEAD/packages/vuepress) from 1.8.1 to 1.8.2.
- [Release notes](https://github.com/vuejs/vuepress/releases)
- [Changelog](https://github.com/vuejs/vuepress/blob/master/CHANGELOG.md)
- [Commits](https://github.com/vuejs/vuepress/commits/v1.8.2/packages/vuepress)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-02-22 14:49:21 -05:00
.cargo ci: ignore RUSTSEC-2020-0100 (#2179) 2021-01-20 11:01:55 -05:00
.github ci(docs): only publish site on release (#2322) 2021-02-16 17:41:21 -05:00
docs build(deps-dev): bump vuepress from 1.8.1 to 1.8.2 in /docs (#2368) 2021-02-22 14:49:21 -05:00
install build: add x86_64 freebsd build (#2233) 2021-01-30 12:50:38 +01:00
media docs(i18n): add Vietnamese doc translations 2021-01-26 17:25:25 -05:00
src feat(helm): Configure when the module is shown (#2352) 2021-02-21 19:57:23 +01:00
starship_module_config_derive chore(release): release starship_module_config_derive v0.1.2 2020-09-30 16:13:42 -04: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 nix from 0.19.1 to 0.20.0 2021-02-22 05:36:34 +00:00
Cargo.toml build(deps): bump nix from 0.19.1 to 0.20.0 2021-02-22 05:36:34 +00:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#42) 2019-04-30 23:30:42 -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 chore: update Discord link to use vanity URL 2021-02-08 14:54:28 -05:00
snapcraft.yaml fix: snap build failure (#1177) 2020-05-06 20:29:09 -04: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:
    curl -fsSL https://starship.rs/install.sh | bash

    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)

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