mirror of
https://github.com/starship/starship.git
synced 2024-12-29 02:28:54 +01:00
7485c90c9f
* feat(docs): move to vitepress * change up hero styles to match existing site * A bit more style tweaking * Replace stylus with plain CSS * improve unicode-range value for nerdfont --------- Co-authored-by: Matan Kushner <hello@matchai.dev>
446 lines
17 KiB
Markdown
446 lines
17 KiB
Markdown
<p align="center">
|
||
<img
|
||
width="400"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||
alt="Starship – Prompt Shell multi-platformes"
|
||
/>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/starship/starship/actions"
|
||
><img
|
||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||
alt="Statut du workflow actions GitHub"
|
||
/></a>
|
||
<a href="https://crates.io/crates/starship"
|
||
><img
|
||
src="https://img.shields.io/crates/v/starship?style=flat-square"
|
||
alt="Version Crates.io"
|
||
/></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="Statut du package" /></a
|
||
><br />
|
||
<a href="https://discord.gg/starship"
|
||
><img
|
||
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
|
||
alt="Discuter sur Discord"
|
||
/></a>
|
||
<a href="https://twitter.com/StarshipPrompt"
|
||
><img
|
||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||
alt="Suivez @StarshipPrompt sur Twitter"
|
||
/></a>
|
||
<a href="https://stand-with-ukraine.pp.ua"
|
||
><img
|
||
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
|
||
alt="Soutenez l'Ukraine"
|
||
/></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs/fr-FR">Site web</a>
|
||
·
|
||
<a href="#🚀-installation">Installation</a>
|
||
·
|
||
<a href="https://starship.rs/fr-FR/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/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/es-ES/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
|
||
alt="Español"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
|
||
alt="Français"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/id-ID/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
|
||
alt="Bahasa Indonesia"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/it-IT/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
|
||
alt="Italiano"
|
||
/></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/pt-BR/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
|
||
alt="Português do Brasil"
|
||
/></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/uk-UA/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ua.png"
|
||
alt="Українська"
|
||
/></a>
|
||
|
||
<a
|
||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||
><img
|
||
height="20"
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
|
||
alt="Tiếng Việt"
|
||
/></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://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>
|
||
</p>
|
||
|
||
<h1></h1>
|
||
|
||
<img
|
||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||
alt="Starship avec iTerm2 et le thème Snazzy"
|
||
width="50%"
|
||
align="right"
|
||
/>
|
||
|
||
**L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !**
|
||
|
||
- **Rapide** : il est rapide - _vraiment vraiment_ rapide ! 🚀
|
||
- **Personnalisable:** configurez chaque élément de votre invite.
|
||
- **Universel:** fonctionne avec n'importe quel shell, sur n'importe quel système d'exploitation.
|
||
- **Intelligent:** affiche les informations utiles en un coup d'œil.
|
||
- **Riche en fonctionnalités:** supporte tous vos outils favoris.
|
||
- **Facile:** rapide à installer – commencez à l'utiliser en quelques minutes.
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs/fr-FR/config/"><strong>Consultez la documentation de Starship ▶</strong></a>
|
||
</p>
|
||
|
||
<a name="🚀-installation"></a>
|
||
|
||
## 🚀 Installation
|
||
|
||
### Pré-requis
|
||
|
||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)).
|
||
|
||
### Étape 1. Installer Starship
|
||
|
||
Sélectionnez votre système d'exploitation dans la liste ci-dessous pour voir les instructions d'installation:
|
||
|
||
<details>
|
||
<summary>Android</summary>
|
||
|
||
Installez Starship en utilisant l’un de ces gestionnaires de paquets:
|
||
|
||
| Dépôt | Instructions |
|
||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>BSD</summary>
|
||
|
||
Installez Starship en utilisant l’un de ces gestionnaires de paquets:
|
||
|
||
| Distribution | Dépôt | Instructions |
|
||
| ------------ | -------------------------------------------------------- | --------------------------------- |
|
||
| **_Toutes_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
|
||
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Linux</summary>
|
||
|
||
Installez la dernière version pour votre système:
|
||
|
||
```sh
|
||
curl -sS https://starship.rs/install.sh | sh
|
||
```
|
||
|
||
Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de paquets:
|
||
|
||
| Distribution | Dépôt | Instructions |
|
||
| ------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||
| **_Toutes_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| _Toutes_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||
| _Toutes_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||
| Alpine Linux 3.13+ | [Paquets Alpine Linux](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||
| Gentoo | [Paquets Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||
| Manjaro | | `pacman -S starship` |
|
||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||
| Void Linux | [Paquets Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>macOS</summary>
|
||
|
||
Installez la dernière version pour votre système:
|
||
|
||
```sh
|
||
curl -sS https://starship.rs/install.sh | sh
|
||
```
|
||
|
||
Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de paquets:
|
||
|
||
| Dépôt | Instructions |
|
||
| -------------------------------------------------------- | --------------------------------------- |
|
||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Windows</summary>
|
||
|
||
Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest).
|
||
|
||
Installez Starship en utilisant l’un de ces gestionnaires de paquets:
|
||
|
||
| Dépôt | Instructions |
|
||
| --------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
|
||
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
|
||
| [aileron](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
|
||
|
||
</details>
|
||
|
||
### Étape 2. Set up your shell to use Starship
|
||
|
||
Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous:
|
||
|
||
<details>
|
||
<summary>Bash</summary>
|
||
|
||
Ajouter ce qui suit à la fin de `~/.bashrc`:
|
||
|
||
```sh
|
||
eval "$(starship init bash)"
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Cmd</summary>
|
||
|
||
Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Créez le fichier `%LocalAppData%\clink\starship.lua` avec le contenu suivant:
|
||
|
||
```lua
|
||
load(io.popen('starship init cmd'):read("*a"))()
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Elvish</summary>
|
||
|
||
Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`:
|
||
|
||
```sh
|
||
eval (starship init elvish)
|
||
```
|
||
|
||
Note: Seul Elvish v0.18+ est supporté
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Fish</summary>
|
||
|
||
Ajoute ce qui suit à la fin de `~/.config/fish/config.fish`:
|
||
|
||
```fish
|
||
starship init fish | source
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Ion</summary>
|
||
|
||
Ajouter ce qui suit à la fin de `~/.config/ion/initrc`:
|
||
|
||
```sh
|
||
eval $(starship init ion)
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Nushell</summary>
|
||
|
||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
||
|
||
```sh
|
||
mkdir ~/.cache/starship
|
||
starship init nu | save -f ~/.cache/starship/init.nu
|
||
```
|
||
|
||
Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`):
|
||
|
||
```sh
|
||
use ~/.cache/starship/init.nu
|
||
```
|
||
|
||
Note: Seul Nushell v0.78+ est supporté
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>PowerShell</summary>
|
||
|
||
Ajoutez le code suivant à la fin de votre configuration de PowerShell (trouvez-la en exécutant `$PROFILE`):
|
||
|
||
```powershell
|
||
Invoke-Expression (&starship init powershell)
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Tcsh</summary>
|
||
|
||
Ajoutez ce qui suit à la fin de `~/.tcshrc`:
|
||
|
||
```sh
|
||
eval `starship init tcsh`
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Xonsh</summary>
|
||
|
||
Ajouter ce qui suit à la fin de `~/.xonshrc`:
|
||
|
||
```python
|
||
execx($(starship init xonsh))
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Zsh</summary>
|
||
|
||
Ajouter ce qui suit à la fin de `~/.zshrc`:
|
||
|
||
```sh
|
||
eval "$(starship init zsh)"
|
||
```
|
||
|
||
</details>
|
||
|
||
### Étape 3. Configurer Starship
|
||
|
||
Démarrez une nouvelle instance de votre shell, et vous devriez voir votre magnifique nouveau prompt. Si vous êtes satisfait des valeurs par défaut, profitez-en !
|
||
|
||
Si vous cherchez à personnaliser davantage Starship :
|
||
|
||
- **[Configuration](https://starship.rs/config/)** – apprenez à configurer Starship pour ajuster votre prompt à vos préférences
|
||
|
||
- **[Préréglages](https://starship.rs/presets/)** – inspirez vous des configuration préfaites par d’autres
|
||
|
||
## 🤝 Contribuer
|
||
|
||
Nous sommes toujours à la recherche de contributeurs de **tous niveaux de compétence**! Si vous cherchez à faciliter votre entrée dans le projet, essayez un [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||
|
||
Si vous parlez couramment une langue autre que l'anglais, nous apprécions grandement toute aide pour traduire et mettre à jour notre documentation dans d'autres langues. Si vous souhaitez nous aider, les traductions se font sur le [Crowdin Starship](https://translate.starship.rs/).
|
||
|
||
Si vous êtes intéressé pour aider et contribuer à Starship, veuillez jeter un coup d'œil à notre [Guide de contribution](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Aussi, n'hésitez pas à nous rendre sur notre [serveur Discord](https://discord.gg/8Jzqu3T) pour dire bonjour. 👋
|
||
|
||
## 💭Inspiré par
|
||
|
||
Voyez ces travaux précédents qui ont contribué à inspirer la création de Starship. 🙏
|
||
|
||
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Un prompt ZSH pour les astronautes.
|
||
|
||
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – Thème robbyrussell multi-shell écrit en JavaScript.
|
||
|
||
- **[reujab/silver](https://github.com/reujab/silver)** – Prompt multi-shell personnalisable, dans le style de powerline avec des icones.
|
||
|
||
## ❤️ Collaborateurs
|
||
|
||
Soutenez ce projet en [devenant un collaborateur](https://github.com/sponsors/starship). Votre nom ou logo apparaîtra ici avec un lien vers votre site Web.
|
||
|
||
**Palier Collaborateur**
|
||
|
||
- [Appwrite](https://appwrite.io/)
|
||
|
||
<p align="center">
|
||
<br>
|
||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Icône de roquette de Starship">
|
||
</p>
|
||
|
||
## 📝 License
|
||
|
||
Copyright © 2019-présent, [contributeurs de Starship](https://github.com/starship/starship/graphs/contributors).<br /> Ce projet est sous licence [ISC](https://github.com/starship/starship/blob/master/LICENSE).
|