Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
362 lines (289 sloc) 37.4 KB


Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
加入 Discord 所有贡献者


网站 · 安装 · 配置

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

Starship 可以适配于任何 shell,是一种轻量,快速,高度可定制化的提示符工具!
它在可以你工作时展示你所需要的信息,兼备的流畅的使用体验。


使用 iTerm 和 Snazz 主题的 Starship

🍬 特性

  • 当上一个命令以非 0 状态退出时,提示字符会变为红色
  • Current Elm version (🌳)
  • 当前 Go 版本 (🐹)
  • 显示当前 Haskell 版本(λ)
  • 当前 Java 版本(☕)
  • 当前 Node.js 版本(⬢)
  • 显示当前 PHP 版本(🐘)
  • 显示当前 Python 版本(🐍)
  • 当前 Ruby 版本 (💎)
  • 当前 Rust 版本 (🦀)
  • 显示当前 .NET 版本(•NET)
  • Current Crystal version (🔮).
  • 显示当前目录中项目的版本(📦)
    • npm (Node.js)
    • cargo (Rust)
    • poetry (Python)
    • composer(PHP)
  • 当前 Git 分支与一应俱全的仓库状态
    • = —— 修改冲突
    • ⇡ —— 领先于远程分支
    • ⇣ —— 落后于远程分支
    • ⇕ —— 与远程分支存在分歧
    • ? —— 存在未记录的文件
    • $ —— 存在 stash 快照
    • ! —— 存在被修改的文件
    • + —— 暂存区中存在内容
    • » —— 文件重命名
    • ✘ —— 文件被删除
  • 显示当前的 Mercurial 分支
  • 当前电池剩余容量与状态
    • ⇡ —— 电池充电中
    • ⇣ —— 电池耗电中
    • • —— 电池已充满
  • 显示后台运行进程数(✦)
  • 显示当前 Kubernetes 集群与命名空间(☸)
  • 显示当前 AWS 配置(☁️)
  • 显示上一条命令的执行用时
  • 自定义环境变量值
  • Nix-shell 环境检测
  • 非当前登录用户的用户名
  • 12/24 小时格式的时间显示(可选)
  • 显示 Terraform 工作区和当前版本(💠)
  • 显示当前 Conda 环境(C)

🚀 安装

前置要求

开始安装

  1. 安装 starship 二进制文件:

    安装最新版本

    下载预构建的二进制文件,使用 Shell 命令:
    curl -fsSL https://starship.rs/install.sh | bash
    直接从 crates.io 获取源代码编译:
    cargo install starship

    通过软件包管理器安装

    使用 Homebrew
    brew install starship
    使用 Scoop:
    scoop install starship
  2. 将初始化脚本添加到您的 shell 的配置文件:

    Bash

    在 ~/.bashhrc 的最后,添加以下内容:

    # ~/.bashrc
    
    eval "$(starship init bash)"

    Fish

    在 ~/.config/fish/config.fish 的最后,添加以下内容:

    # ~/.config/fish/config.fish
    
    starship init fish | source

    Zsh

    在 ~/.zshrc 的最后,添加以下内容:

    # ~/.zshrc
    
    eval "$(starship init zsh)"

    PowerShell

    将以下内容添加到~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 (或~/.config/powershell/Microsoft.PowerShell_profile.ps1,对于 *nix 系统):

    # ~\Documents\PowerShell\Profile.ps1
    
    Invoke-Expression (&starship init powershell)

    Ion

    在 ~/.config/ion/initrc 的最后,添加以下内容:

    # ~/.config/ion/initrc
    
    eval $(starship init ion)

🔧 配置

关于如何配置 Starship ,详情请查看我们的文档。

🤝 贡献

我们一直在寻求各种形式的贡献!不论您的技能水平如何,您都可以为项目做出贡献。 如果您希望快速为项目作出贡献,请尝试解决 good first issue。

急需

  • 👩‍💼 项目经理
    • 我们有一个GitHub项目,有许多未经整理或没有被置于优先地位的新功能,还有许多想法没有被列入 issues。 我们需要人来为项目发展方向指路!
  • 👩‍🎨 设计师
    • 想制作吸引人的网站吗? 太棒了! 我们正想要制作一个漂亮的主页,以彰显 Starship 的与众不同。 帮助设计 Starship 的品牌是尝试你新点子的一个巨大机会!
  • 👩‍💻 Rust 开发者
    • 我们需要符合语言习惯的,高效的代码,需要性能优化与跨平台编译优化……你可以在这里收获_大量_的成果! 我 (@matchai) 是一枚 Rust 新手. 快来为我们指点迷津!

如果您有兴趣贡献于 Starship,请查看我们的贡献指南。 另外,你可以自由加入我们的 Discord 服务器 。 👋

贡献者

感谢这些优秀的人 (emoji key):


Matan Kushner

💻 🎨 🤔 🚇 🚧 👀 ⚠️

John Letey

💻 🤔 👀 ⚠️

Tim Mulqueen

💻 🤔 👀 ⚠️

Tiffany Le-Nguyen

🤔 🚧 👀 📖

​Snuggle

🎨 🤔 🚧 👀

Ryan Leckey

👀

Youssef Habri

💻 📖 ⚠️

Kevin Song

🐛 💻 📖 ⚠️

Andrew Dassonville

🐛 💻

MaT1g3R

💻 📖 ⚠️

André Zanellato

💻 📖 ⚠️

Saghm Rossi

💻 📖 ⚠️

Shu Kutsuzawa

💻 📖 ⚠️ 🌍

Saurav Sharma

💻 📖

Thomas O'Donnell

💻 ⚠️ 📖 👀

Bruno Bigras

💻 👀

Neil Kistner

💻 ⚠️ 👀

Quinn Strahl

💻 ⚠️

Titouan Vervack

💻 ⚠️

Francisco Lopes

💻

Andrew Houts

💻 📖 ⚠️

Nick Young

💻 📖 ⚠️ 👀

Gabriel de Perthuis

💻

Hofer-Julian

📖

Yuji Ueki

🖋 🌍

谢祯晖

💻 📖 🌍 👀

Kutsuzawa Ryo

👀 💻 ⚠️ 🌍

hdevalke

🤔

Kuba Clark

💻 📖 ⚠️

Gimbar

💻 ⚠️ 📖

Tom Hotston

💻 📖

Bijan Chokoufe Nejad

💻 ⚠️ 👀

yuri

💻 📖 ⚠️

TsubasaKawajiri

🌍

Ryo Yamashita

💻

Thomas Lee

💻

(´⌣`ʃƪ)

💻

Barnaby Keene

💻

Keith Wade

💻 ⚠️

LukeAI

📖

Zach Mertes

💻 📖 ⚠️

David Knaack

💻 📖 ⚠️

Carl Summers

📖

Yushan Lin

🌍

Weihang Lo

🌍

pinshan

🌍

Brian Low

💻 📖 ⚠️

Matias Kotlik

💻

marblenix

🚇 💻 ⚠️

Raidou

💻 ⚠️

Luca Greco

💻 📖 ⚠️

Luca Rinaldi

💻

Stephen Ball

💻 ⚠️ 📖

Qingping Hou

💻 📖 ⚠️

Dan Wendorf

💻 ⚠️

Alan Pope

🚇

BuggStream

💻 📖

Jon Grythe Stødle

💻 ⚠️

Jason Etcovitch

🐛

Etienne Mabille

💻

AppleTheGolden

💻 📖

Mike Sampson

💻 📖 ⚠️

Dominik Braun

💻

David Hewson

💻

Gennady Koshkin

🌍

Oleksii Filonenko

🌍

Artem Ivanov

🌍

Peter Bull

💻 ⚠️

Andrew Prokhorenkov

💻 📖 ⚠️

chirsz

🌍

此项目遵循 all-contributors 标准。 任何形式的贡献都将受到欢迎!

💭该项目受以下项目启发

请参考这些曾经为 Starship 提供启发的工程。 🙏


Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.

You can’t perform that action at this time.