mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-18 11:05:19 +00:00
420 lines
16 KiB
Markdown
420 lines
16 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="깃헙 액션 워크풀로 상태"
|
||
/></a>
|
||
<a href="https://crates.io/crates/starship"
|
||
><img
|
||
src="https://img.shields.io/crates/v/starship?style=flat-square"
|
||
alt="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="패키징 상태" /></a
|
||
><br />
|
||
<a href="https://discord.gg/starship"
|
||
><img
|
||
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
|
||
alt="디스코드에 채팅을 하세요"
|
||
/></a>
|
||
<a href="https://twitter.com/StarshipPrompt"
|
||
><img
|
||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||
alt="트위터에서 @StarshipPrompt를 팔로우 하세요"
|
||
/></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs">웹사이트</a>
|
||
·
|
||
<a href="#🚀-installation">설치</a>
|
||
·
|
||
<a href="https://starship.rs/config/">설정</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/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 with iTerm2 and the Snazzy theme"
|
||
width="50%"
|
||
align="right"
|
||
/>
|
||
|
||
**The minimal, blazing-fast, and infinitely customizable prompt for any shell!**
|
||
|
||
- ** Fast:** 빨라요 – _엄청 엄청_ 빠릅니다! 🚀
|
||
- ** Customizable:** 프롬프트의 모든 측면을 커스텀 가능합니다.
|
||
- **Universal:** 어떤 쉘 위에서도, 어떤 운영체제 위에서도 동작합니다.
|
||
- **Intelligent:** 관련 정보를 한눈에 보여줍니다.
|
||
- **Feature rich:** 원하는 모든 도구를 지원합니다.
|
||
- **Easy:** 빠른 설치 - 몇 분 안에 사용할 수 있습니다.
|
||
|
||
<p align="center">
|
||
<a href="https://starship.rs/config/"><strong>Starship 문서 보기 ▶</strong></a>
|
||
</p>
|
||
|
||
<a name="🚀-installation"></a>
|
||
|
||
## 🚀 설치
|
||
|
||
### 준비 사항
|
||
|
||
- 터미널에 [Nerd Font](https://www.nerdfonts.com/)가 설치되어 있고 사용 가능해야 합니다. (ex. [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads))
|
||
|
||
### Step 1. Starship 설치하기
|
||
|
||
아래의 목록 중 해당하는 운영체제를 골라 설치 지침을 확인하세요:
|
||
|
||
<details>
|
||
<summary>Android</summary>
|
||
|
||
Install Starship using any of the following package managers:
|
||
|
||
| Repository | Instructions |
|
||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>BSD</summary>
|
||
|
||
Install Starship using any of the following package managers:
|
||
|
||
| Distribution | Repository | Instructions |
|
||
| ------------ | -------------------------------------------------------- | --------------------------------- |
|
||
| **_Any_** | **[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>
|
||
|
||
Install the latest version for your system:
|
||
|
||
```sh
|
||
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
|
||
```
|
||
|
||
Alternatively, install Starship using any of the following package managers:
|
||
|
||
| Distribution | Repository | Instructions |
|
||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||
| _Any_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||
| _Any_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` |
|
||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||
| Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/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` |
|
||
| Fedora 31+ | [Fedora Packages](https://src.fedoraproject.org/rpms/rust-starship) | `dnf install starship` |
|
||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixos.starship` |
|
||
| Gentoo | [Gentoo Packages](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` |
|
||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>macOS</summary>
|
||
|
||
Install the latest version for your system:
|
||
|
||
```sh
|
||
sh -c "$(curl -fsSL https://starship.rs/install.sh)"
|
||
```
|
||
|
||
Alternatively, install Starship using any of the following package managers:
|
||
|
||
| Repository | 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 Starship using any of the following package managers:
|
||
|
||
| Repository | 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` |
|
||
|
||
</details>
|
||
|
||
### Step 2. 쉘에 Starship 적용하기
|
||
|
||
쉘에 Starship 초기 설정을 합니다. 아래의 리스트 중에 해당하는 것을 고르세요:
|
||
|
||
<details>
|
||
<summary>Bash</summary>
|
||
|
||
`~/.bashrc`의 끝부분에 아래 라인을 추가:
|
||
|
||
```sh
|
||
eval "$(starship init bash)"
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Cmd</summary>
|
||
|
||
Cmd를 이용하려면 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 를 사용해야 합니다. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
|
||
|
||
```lua
|
||
load(io.popen('starship init cmd'):read("*a"))()
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Elvish</summary>
|
||
|
||
`~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가:
|
||
|
||
```sh
|
||
eval (starship init elvish)
|
||
```
|
||
|
||
Note: Only Elvish v0.17+ is supported
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Fish</summary>
|
||
|
||
`~/.config/fish/config.fish`의 끝부분에 아래 라인을 추가:
|
||
|
||
```fish
|
||
starship init fish | source
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Ion</summary>
|
||
|
||
`~/.config/ion/initrc` 의 끝부분에 아래 라인을 추가:
|
||
|
||
```sh
|
||
eval $(starship init ion)
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Nushell</summary>
|
||
|
||
Add the following to the end of your Nushell configuration (find it by running `config path`):
|
||
|
||
```toml
|
||
startup = [
|
||
"mkdir ~/.cache/starship",
|
||
"starship init nu | save ~/.cache/starship/init.nu",
|
||
"source ~/.cache/starship/init.nu",
|
||
]
|
||
prompt = "starship_prompt"
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Powershell</summary>
|
||
|
||
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):
|
||
|
||
```powershell
|
||
Invoke-Expression (&starship init powershell)
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Tcsh</summary>
|
||
|
||
`~/.tcshrc` 의 끝부분에 아래 라인을 추가:
|
||
|
||
```sh
|
||
eval `starship init tcsh`
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Xonsh</summary>
|
||
|
||
`~/.xonshrc` 의 끝부분에 아래 라인을 추가:
|
||
|
||
```python
|
||
execx($(starship init xonsh))
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Zsh</summary>
|
||
|
||
`~/.zshrc`의 끝부분에 아래 라인을 추가
|
||
|
||
```sh
|
||
eval "$(starship init zsh)"
|
||
```
|
||
|
||
</details>
|
||
|
||
### Step 3. Starship 설정하기
|
||
|
||
새로운 쉘 인스턴스를 시작하면 아름다운 새 쉘 프롬프트를 볼 수 있습니다. 기본 설정에 만족한다면, 즐기세요!
|
||
|
||
Starship을 추가로 커스터마이징 하고싶다면:
|
||
|
||
- **[Configuration](https://starship.rs/config/)** – 원하는대로 프롬프트를 수정할 수 있도록 Starship 설정을 배울 수 있습니다.
|
||
|
||
- **[Presets](https://starship.rs/presets/)** – 다른 사람들이 만들어둔 설정들을 보고 영감을 받을 수 있습니다.
|
||
|
||
## 🤝 기여
|
||
|
||
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. 👋
|
||
|
||
## 💭 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 로켓 아이콘">
|
||
</p>
|
||
|
||
## 📝라이선스
|
||
|
||
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.
|