mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-09-28 13:19:00 +00:00
d21400a478
* feat: add support for tcsh * add tcsh to install.sh install message * list tcsh in bug_report.rs and main.rs * quote starship path Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * fix job count * add tcsh support to shell module * fix STARSHIP_START_TIME undefined error * preserve existing user precmd and postcmd, remove jobs support * remove unnecessary parentheses * minor script improvement * removes parens from install script message * Update docs/config/README.md Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com> Co-authored-by: David Knaack <davidkna@users.noreply.github.com> Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
128 lines
2.9 KiB
Markdown
128 lines
2.9 KiB
Markdown
---
|
|
home: true
|
|
heroImage: /logo.svg
|
|
heroText: null
|
|
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
|
|
actionText: Get Started →
|
|
actionLink: ./guide/
|
|
features:
|
|
- title: Compatibility First
|
|
details: Works on the most common shells on the most common operating systems. Use it everywhere!
|
|
- title: Rust-Powered
|
|
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
|
|
- title: Customizable
|
|
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
|
|
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
|
|
|
|
# Used for the description meta tag, for SEO
|
|
metaTitle: "Starship: Cross-Shell Prompt"
|
|
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, and PowerShell.
|
|
---
|
|
|
|
<div class="center">
|
|
<video class="demo-video" muted autoplay loop playsinline>
|
|
<source src="/demo.webm" type="video/webm">
|
|
<source src="/demo.mp4" type="video/mp4">
|
|
</video>
|
|
</div>
|
|
|
|
### Quick Install
|
|
|
|
1. Install the **starship** binary:
|
|
|
|
#### Install Latest Version
|
|
|
|
With Shell:
|
|
|
|
```sh
|
|
curl -fsSL https://starship.rs/install.sh | bash
|
|
```
|
|
|
|
#### 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 `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.
|
|
|
|
```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)
|
|
```
|
|
#### 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`"
|
|
```
|
|
|