mirror of
https://github.com/starship/starship.git
synced 2024-11-23 16:53:23 +01:00
246 lines
6.9 KiB
Markdown
246 lines
6.9 KiB
Markdown
<p align="center">
|
||
<img
|
||
width="400"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||
alt="Starship – Cross-shell prompt"
|
||
/>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/starship/starship/actions"
|
||
><img
|
||
src="https://img.shields.io/github/workflow/status/starship/starship/Main workflow/master?label=workflow&style=flat-square"
|
||
alt="GitHub Actions workflow status"
|
||
/></a>
|
||
<a href="https://crates.io/crates/starship"
|
||
><img
|
||
src="https://img.shields.io/crates/v/starship?style=flat-square"
|
||
alt="Crates.io version"
|
||
/></a>
|
||
<a href="https://repology.org/project/starship/versions"
|
||
><img
|
||
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
|
||
alt="Packaging status"/></a
|
||
><br />
|
||
<a href="https://discord.gg/8Jzqu3T"
|
||
><img
|
||
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
|
||
alt="Chat on Discord"
|
||
/></a>
|
||
<a href="https://twitter.com/StarshipPrompt"
|
||
><img
|
||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||
alt="Follow @StarshipPrompt on Twitter"
|
||
/></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs">Website</a>
|
||
·
|
||
<a href="#-installation">Installation</a>
|
||
·
|
||
<a href="https://starship.rs/config/">Configuration</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||
alt="English"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/ja-JP/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
|
||
alt="日本語"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/zh-TW/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
|
||
alt="繁體中文"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/ru-RU/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
|
||
alt="Русский"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/de-DE/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
|
||
alt="Deutsch"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/zh-CN/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
|
||
alt="简体中文"
|
||
/></a>
|
||
|
||
<a href="https://translate.starship.rs/project/starship-prompt/es"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
|
||
alt="Español"
|
||
/></a>
|
||
|
||
<a href="https://translate.starship.rs/project/starship-prompt/fr"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
|
||
alt="Français"
|
||
/></a>
|
||
</p>
|
||
|
||
<h1></h1>
|
||
|
||
<img
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||
alt="Starship with iTerm2 and the Snazzy theme"
|
||
width="50%"
|
||
align="right"
|
||
/>
|
||
|
||
|
||
**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.
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs/"><strong>Explore the Starship docs ▶</strong></a>
|
||
</p>
|
||
|
||
|
||
## 🚀 Installation
|
||
|
||
### Prerequisites
|
||
|
||
- A [Powerline font](https://github.com/powerline/fonts) installed and enabled in your terminal (for example, try [Fira Code](https://github.com/tonsky/FiraCode)).
|
||
|
||
### Getting Started
|
||
|
||
1. Install the **starship** binary:
|
||
|
||
#### Install Latest Version
|
||
|
||
##### From prebuilt binary, with Shell:
|
||
|
||
```sh
|
||
curl -fsSL https://starship.rs/install.sh | bash
|
||
```
|
||
|
||
##### From source on [crates.io](https://crates.io/):
|
||
|
||
```sh
|
||
cargo install starship
|
||
```
|
||
|
||
#### Install via Package Manager
|
||
|
||
##### With [Homebrew](https://brew.sh/):
|
||
|
||
```sh
|
||
brew install starship
|
||
```
|
||
|
||
##### With [Scoop](https://scoop.sh):
|
||
|
||
```powershell
|
||
scoop install starship
|
||
```
|
||
|
||
1. Add the init script to your shell's config file:
|
||
|
||
#### Bash
|
||
|
||
Add the following to the end of `~/.bashrc`:
|
||
|
||
```sh
|
||
# ~/.bashrc
|
||
|
||
eval "$(starship init bash)"
|
||
```
|
||
|
||
#### Fish
|
||
|
||
Add the following to the end of `~/.config/fish/config.fish`:
|
||
|
||
```sh
|
||
# ~/.config/fish/config.fish
|
||
|
||
starship init fish | source
|
||
```
|
||
|
||
#### Zsh
|
||
|
||
Add the following to the end of `~/.zshrc`:
|
||
|
||
```sh
|
||
# ~/.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):
|
||
|
||
```sh
|
||
Invoke-Expression (&starship init powershell)
|
||
```
|
||
|
||
#### Ion
|
||
|
||
Add the following to the end of `~/.config/ion/initrc`:
|
||
|
||
```sh
|
||
# ~/.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](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||
|
||
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
|
||
|
||
## 💭 Inspired By
|
||
|
||
Please check out these previous works that helped inspire the creation of starship. 🙏
|
||
|
||
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts.
|
||
|
||
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript.
|
||
|
||
- **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons.
|
||
|
||
<p align="center">
|
||
<br>
|
||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
|
||
</p>
|
||
|
||
## 📝 License
|
||
|
||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.
|