mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-25 14:17:42 +00:00
343 lines
11 KiB
Markdown
343 lines
11 KiB
Markdown
<p align="center">
|
|
<img
|
|
width="400"
|
|
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
|
alt="Starship - een 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-werkwijze status"
|
|
/></a>
|
|
<a href="https://crates.io/crates/starship"
|
|
><img
|
|
src="https://img.shields.io/crates/v/starship?style=flat-square"
|
|
alt="Crates.io-versie"
|
|
/></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="Verpakkingsstatus" /></a
|
|
><br />
|
|
<a href="https://discord.gg/starship"
|
|
><img
|
|
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
|
|
alt="Chat via Discord"
|
|
/></a>
|
|
<a href="https://twitter.com/StarshipPrompt"
|
|
><img
|
|
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
|
alt="Volg @StarshipPrompt op Twitter"
|
|
/></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://starship.rs">Website</a>
|
|
<a href="#🚀-installation">Installatie</a>
|
|
<a href="https://starship.rs/config/">Configuratie</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://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/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>
|
|
</p>
|
|
|
|
<h1></h1>
|
|
|
|
<img
|
|
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
|
alt="Starship met iTerm2 en het thema Snazzy"
|
|
width="50%"
|
|
align="right"
|
|
/>
|
|
|
|
**De minimalistische, razend snelle en oneindig aanpasbare prompt voor elke shell!**
|
|
|
|
- **Snel:** het is snel -_echt heel erg_ snel! 🚀
|
|
- **Aanpasbaar:** configureer elk aspect van je prompt.
|
|
- **Universeel:** werkt op elke shell, op elk besturingssysteem.
|
|
- **Intelligent:** toont relevante informatie in een oogopslag.
|
|
- **Rijk aan functies:** ondersteuning voor al je favoriete tools.
|
|
- **Makkelijk:** snel te installeren - begin in een handomdraai met het te gebruiken.
|
|
|
|
<p align="center">
|
|
<a href="https://starship.rs/config/"><strong>Verken de Starship-documentatie ▶</strong></a>
|
|
</p>
|
|
|
|
<a name="🚀-installation"></a>
|
|
|
|
## 🚀 Installatie
|
|
|
|
### Benodigdheden
|
|
|
|
- Een [Nerd Font](https://www.nerdfonts.com/) is geïnstalleerd en ingeschakeld in je terminal (bijvoorbeeld probeer het [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
|
|
|
|
### Aan de slag
|
|
|
|
**Opmerking:**: als gevolg van de groei van verschillende platforms, worden slechts bepaalde ondersteunde platforms hieronder weergegeven. Staat de jouwe er niet tussen? Neem een kijkje in de [extra platforminstructies](https://starship.rs/installing/).
|
|
|
|
1. Installeer de **Starship** binary:
|
|
|
|
|
|
#### Installeer de nieuwste versie
|
|
|
|
|
|
##### Vooraf gebouwde binary, met shell:
|
|
|
|
```sh
|
|
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
|
|
```
|
|
Om Starship zelf bij te werken, voer je het bovenstaande script opnieuw uit. Deze vervangt de huidige versie zonder de configuratie van Starship aan te passen.
|
|
|
|
|
|
**Opmerking** - De standaardinstellingen van het installatiescript kunnen overschreven worden; zie de ingebouwde hulp.
|
|
|
|
```sh
|
|
sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help
|
|
```
|
|
|
|
|
|
#### Installeren via pakketbeheerder
|
|
|
|
|
|
##### Voorbeeld: [Homebrew](https://brew.sh/):
|
|
|
|
```sh
|
|
brew install starship
|
|
```
|
|
|
|
|
|
##### Met [Scoop](https://scoop.sh):
|
|
|
|
```powershell
|
|
scoop install starship
|
|
```
|
|
|
|
2. Voeg het initscript toe aan het configuratiebestand van uw shell:
|
|
|
|
|
|
#### Bash
|
|
|
|
Voeg het volgende toe aan het einde van `~/.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 `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.
|
|
|
|
```powershell
|
|
Invoke-Expression (&starship init powershell)
|
|
```
|
|
|
|
|
|
#### Ion
|
|
|
|
Add the following to the end of `~/.config/ion/initrc`:
|
|
|
|
```sh
|
|
# ~/.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`:
|
|
|
|
```sh
|
|
# ~/.elvish/rc.elv
|
|
|
|
eval (starship init elvish)
|
|
```
|
|
|
|
|
|
#### Tcsh
|
|
|
|
Add the following to the end of `~/.tcshrc`:
|
|
|
|
```sh
|
|
# ~/.tcshrc
|
|
|
|
eval `starship init tcsh`
|
|
```
|
|
|
|
|
|
#### Xonsh
|
|
|
|
Add the following to the end of `~/.xonshrc`:
|
|
|
|
```sh
|
|
# ~/.xonshrc
|
|
|
|
execx($(starship init xonsh))
|
|
```
|
|
|
|
|
|
#### Nushell
|
|
|
|
**Warning** This will change in the future. Only nu version v0.33 or higher is supported. Add the following to your nu config file. You can check the location of this file by running `config path` in nu.
|
|
|
|
```toml
|
|
startup = [
|
|
"mkdir ~/.cache/starship",
|
|
"starship init nu | save ~/.cache/starship/init.nu",
|
|
"source ~/.cache/starship/init.nu"
|
|
]
|
|
prompt = "starship_prompt"
|
|
```
|
|
|
|
## 🤝 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 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](https://translate.starship.rs/).
|
|
|
|
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. 👋
|
|
|
|
### Code Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)].
|
|
<a href="https://github.com/starship/starship/graphs/contributors"><img src="https://opencollective.com/starship/contributors.svg?width=890&button=false" /></a>
|
|
|
|
### Financial Contributors
|
|
|
|
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/contribute)]
|
|
|
|
#### Individuals
|
|
|
|
<a href="https://opencollective.com/starship"><img src="https://opencollective.com/starship/individuals.svg?width=890"></a>
|
|
|
|
#### Organizations
|
|
|
|
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/starship/contribute)]
|
|
|
|
<a href="https://opencollective.com/starship/organization/0/website"><img src="https://opencollective.com/starship/organization/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/1/website"><img src="https://opencollective.com/starship/organization/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/2/website"><img src="https://opencollective.com/starship/organization/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/3/website"><img src="https://opencollective.com/starship/organization/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/4/website"><img src="https://opencollective.com/starship/organization/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/5/website"><img src="https://opencollective.com/starship/organization/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/6/website"><img src="https://opencollective.com/starship/organization/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/7/website"><img src="https://opencollective.com/starship/organization/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/8/website"><img src="https://opencollective.com/starship/organization/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/starship/organization/9/website"><img src="https://opencollective.com/starship/organization/9/avatar.svg"></a>
|
|
|
|
## 💭 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.
|