Shelby 项目使用教程

1. 项目介绍

Shelby 是一个快速、轻量级、最小化的壳提示符，使用纯 Go 语言编写。它提供了丰富的功能，包括显示当前 Git 分支、虚拟环境信息，以及根据命令执行结果改变提示符颜色等。

2. 项目快速启动

安装

Linux 和 macOS 用户

可以通过以下步骤安装 Shelby：

1. 使用 curl 命令下载安装脚本：

   curl -sf https://gobinaries.com/athul/shelby | sh
   

2. 或者，对于 macOS 用户，可以使用 Homebrew 安装：

   brew install athul/tap/shelby
   

3. 如果是从源代码构建，首先克隆仓库：

   git clone https://github.com/athul/shelby.git
   cd shelby
   

   然后，编译项目：

   go build
   

   最后，将编译好的二进制文件移动到 ~/.local/bin/shelby 目录。

4. 你可能需要使二进制文件可执行：

   chmod +x <binary_name>
   

配置

为了使 Shelby 正常工作，需要将以下代码添加到 .bashrc、.zshrc 或 .profile 文件中：

对于 Bash 用户：

eval "$(shelby init bash)"

对于 Zsh 用户：

eval "$(shelby init zsh)"

3. 应用案例和最佳实践

配置 Git 分支提示

Shelby 可以显示当前 Git 分支，如果存在未暂存或未跟踪的文件，也会在提示符中显示相应的标记。

例如，可以在 .bashrc 或 .zshrc 文件中添加自定义的提示符配置，来展示 Git 状态：

PS1="❯ $(shelby git_branch) "

自定义提示符样式

Shelby 允许用户自定义提示符样式，例如改变颜色、添加额外的信息等。可以通过编辑 .bashrc 或 .zshrc 文件中的 PS1 变量来实现。

4. 典型生态项目

目前，Shelby 是一个独立的项目，没有特定的生态项目。但是，由于其开源和可扩展性，社区中可能有其他开发者基于 Shelby 开发出相关的插件或工具。可以关注 GitHub 上的相关仓库，了解最新的社区贡献。