Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord All Contributors


Site web · Installation · Configuration

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

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
The prompt shows information you need while you're working, while staying sleek and out of the way.


Starship with iTerm2 and the Snazzy theme

## 🍬 Fonctionnalités - Le symbole de prompt devient rouge si la dernière commande a retournée un code différent de zéro - Version actuelle de Go (`🐹`) - Version actuelle de Java (`☕`) - Version actuelle de Node.js (`⬢`) - Current PHP version (`🐘`) - Version actuelle de Python (`🐍`) - Version actuelle de Ruby (`💎`) - Version actuelle de Rust (`🦀`) - Current .NET version (`•NET`) - Version actuelle du paquet dans le répertoire courant (`📦`) - npm (Node.js) - cargo (Rust) - poetry (Python) - Branche Git actuelle et affichage "riche" du statut du dépôt: - `=` — Conflits dans les changements - `⇡` — En avance sur la branche distante - `⇣` — En retard sur la branche distante - `⇕` — Changements divergeant - `?` — Changements non-suivis - `$` — Changements remisés - `!` — Fichiers modifiés - `+` — Fichiers ajoutés - `»` — Fichiers renommés - `✘` — Fichiers supprimés - Current Mercurial branch - Niveau et état actuels de la batterie - `⇡` – charging - `⇣` – discharging - `•` – fully charged - Indicateur pour les tâches en arrière-plan (`✦`) - Cluster et namespace Kubernetes actuels (`☸`) - Current Amazon Web Services (AWS) profile (`☁️`) - Execution time of the last command - Custom environment variable value - Détection de l'environnement Nix-shell - Affiche le nom de l'utilisateur courant s'il est différent de celui connecté - Optional current time in 12/24hr format ## 🚀 Installation ### Pré-requis - Une [police d'écriture Powerline](https://github.com/powerline/fonts) installée et activée dans votre terminal (Par exemple, essayez [Fira Code](https://github.com/tonsky/FiraCode)). ### Getting Started 1. Installer le binaire **starship** : #### Install Latest Version ##### With Shell: ```sh curl -fsSL https://starship.rs/install.sh | sh ``` #### 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 # ~\Documents\PowerShell\Profile.ps1 Invoke-Expression (&starship init powershell) ``` ## 🔧 Configuration For details on how to configure Starship, check out our [documentation](https://starship.rs/config/). ## 🤝 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). ### High Priority Needs - 👩‍💼 **Product Manager** - We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction! - 👩‍🎨 **Designer** - Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas! - 👩‍💻 **Rust Developer** - There is _a lot_ of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I ([@matchai](https://github.com/matchai)) am a beginner to Rust. Come point us in the right direction! 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. 👋 ### Contributors Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Matan Kushner
Matan Kushner

💻 🎨 🤔 🚇 🚧 👀 ⚠️
John Letey
John Letey

💻 🤔 👀 ⚠️
Tim Mulqueen
Tim Mulqueen

💻 🤔 👀 ⚠️
Tiffany Le-Nguyen
Tiffany Le-Nguyen

🤔 🚧 👀 📖
​Snuggle
​Snuggle

🎨 🤔 🚧 👀
Ryan Leckey
Ryan Leckey

👀
Youssef Habri
Youssef Habri

💻
Kevin Song
Kevin Song

🐛 💻 📖 ⚠️
Andrew Dassonville
Andrew Dassonville

🐛 💻
MaT1g3R
MaT1g3R

💻 📖 ⚠️
André Zanellato
André Zanellato

💻 📖 ⚠️
Saghm Rossi
Saghm Rossi

💻 📖 ⚠️
Shu Kutsuzawa
Shu Kutsuzawa

💻 📖 ⚠️ 🌍
Saurav Sharma
Saurav Sharma

💻 📖
Thomas O'Donnell
Thomas O'Donnell

💻 ⚠️ 📖 👀
Bruno Bigras
Bruno Bigras

💻 👀
Neil Kistner
Neil Kistner

💻 ⚠️ 👀
Quinn Strahl
Quinn Strahl

💻 ⚠️
Titouan Vervack
Titouan Vervack

💻 ⚠️
Francisco Lopes
Francisco Lopes

💻
Andrew Houts
Andrew Houts

💻 📖 ⚠️
Nick Young
Nick Young

💻 📖 ⚠️ 👀
Gabriel de Perthuis
Gabriel de Perthuis

💻
Hofer-Julian
Hofer-Julian

📖
Yuji Ueki
Yuji Ueki

🖋 🌍
谢祯晖
谢祯晖

💻 📖 🌍 👀
Kutsuzawa Ryo
Kutsuzawa Ryo

👀 💻 ⚠️ 🌍
hdevalke
hdevalke

🤔
Kuba Clark
Kuba Clark

💻 📖 ⚠️
Gimbar
Gimbar

💻 ⚠️ 📖
Tom Hotston
Tom Hotston

💻 📖
Bijan Chokoufe Nejad
Bijan Chokoufe Nejad

💻 ⚠️ 👀
yuri
yuri

💻 📖 ⚠️
TsubasaKawajiri
TsubasaKawajiri

🌍
Ryo Yamashita
Ryo Yamashita

💻
Thomas Lee
Thomas Lee

💻
(´⌣`ʃƪ)
(´⌣`ʃƪ)

💻
Barnaby Keene
Barnaby Keene

💻
Keith Wade
Keith Wade

💻 ⚠️
LukeAI
LukeAI

📖
Zach Mertes
Zach Mertes

💻 📖 ⚠️
David Knaack
David Knaack

💻 📖 ⚠️
Carl Summers
Carl Summers

📖
Yushan Lin
Yushan Lin

🌍
Weihang Lo
Weihang Lo

🌍
pinshan
pinshan

🌍
Brian Low
Brian Low

💻 📖 ⚠️
Matias Kotlik
Matias Kotlik

💻
marblenix
marblenix

🚇
Raidou
Raidou

💻 ⚠️
Luca Greco
Luca Greco

💻 📖 ⚠️
Luca Rinaldi
Luca Rinaldi

💻
Stephen Ball
Stephen Ball

💻 ⚠️ 📖
Qingping Hou
Qingping Hou

💻 📖 ⚠️
Dan Wendorf
Dan Wendorf

💻 ⚠️
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## 💭 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.


Starship rocket icon

## 📝 License Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.