OhCrab! 🦀

ohcrab 是将知名的 CLI 工具 thefuck 移植到我们心爱的 Rust 语言。

目录

1. 安装
2. 用法
3. 贡献
4. 路线图

安装

目前，有两种安装方法

1. 下载二进制文件
2. 使用 cargo 安装

以下是如何使用这些方法之一进行安装的说明。

下载二进制文件

按照以下步骤下载并使用您操作系统和架构的预编译二进制文件安装软件包

下载文件

二进制文件可在 发布页面 的 资源 部分找到。根据您的系统下载相应的二进制文件

• ohcrab_x86_64_unknown_linux_gnu_vx.x.x.bin：此二进制文件适用于具有 64 位英特尔处理器的 Linux 设备。
• ohcrab_i686_unknown_linux_gnu_vx.x.x.bin：此二进制文件适用于具有 32 位英特尔处理器的 Linux 设备。
• ohcrab_aarch64_unknown_linux_gnu_vx.x.x.bin：此二进制文件适用于具有 ARM 64 位处理器的 Linux 设备（如 Raspberry Pi 3/4）。
• ohcrab_x86_64_apple_darwin_vx.x.x.bin：此二进制文件适用于运行 macOS 的具有 64 位英特尔处理器的 Apple 设备。
• ohcrab_aarch64_apple_darwin_vx.x.x.bin：此二进制文件适用于运行 macOS 的 Apple 设备（如 M1 Mac）。
• ohcrab_i686_unknown_freebsd_vx.x.x.bin：此二进制文件适用于具有 32 位英特尔处理器的 FreeBSD 设备。
• ohcrab_x86_64_unknown_freebsd_vx.x.x.bin：此二进制文件适用于具有 64 位英特尔处理器的 FreeBSD 设备。

使二进制文件可执行

下载二进制文件后，您需要使其可执行。使用以下命令

chmod +x <BINARY_NAME>

将 <BINARY_NAME> 替换为您的下载二进制文件的名称。

将二进制文件移动到 /opt

我们建议将二进制文件移动到 /opt 目录，并将其重命名为 ohcrab。使用以下命令

sudo mv <BINARY_NAME> /opt/ohcrab

创建符号链接

最后，从您的 PATH 目录之一（如 /usr/local/bin）创建一个指向二进制文件的符号链接。使用以下命令

sudo ln -s /opt/<BINARY_NAME> /usr/local/bin/

现在，您应该能够通过在终端中键入 ohcrab 来运行您的程序。

前往将ohcrab添加到您的环境中以完成安装。

从cargo安装

先决条件

目前，您只能通过cargo来安装ohcrab。如果您还没有安装cargo，可以按照https://doc.rust-lang.net.cn/cargo/getting-started/installation.html的说明进行安装。

安装软件包

您可以使用cargo来安装ohcrab

cargo install ohcrab

将ohcrab添加到您的环境中

为了让ohcrab在您的终端中工作，您需要导出正确的shell函数。目前，我们支持bash和zsh。将相应的命令复制并粘贴到您的终端中

• 对于bash，使用

eval $(ohcrab --shell bash)

• 对于zsh，使用

eval $(ohcrab --shell zsh)

注意：为了让每次打开终端时都加载ohcrab，请将上面的eval命令添加到您的.bash_profile、.bashrc、.zshrc或其他启动脚本中。

更改别名

上面的命令使用默认别名（crab）从终端调用ohcrab。您可以通过传递--alias NEW_ALIAS来使用自己的别名NEW_ALIAS。例如，如果您想在zsh中使用shinycrab作为别名，请使用

eval $(ohcrab --shell zsh --alias shinycrab)

用法

在终端中，输入错误命令后，输入crab（或您在导出ohcrab步骤中选择的别名）。它将显示一个菜单，从中选择正确的命令。

贡献

如果您喜欢ohcrab并/或想学习rust，您可以通过添加新规则或改进crate来做出贡献。

路线图

• 添加sudo支持
• 为Linux、MacOs和Windows分发二进制文件。
• 制作其功能的简短屏幕记录
• 当生成ohcrab shell功能时，通知用户正在使用哪种shell类型。
• 添加对用户shell别名的支持。
• 添加对PowerShell的支持
• 减少依赖项的数量/大小
• 通过软件包管理器提供
• 与thefuck进行基准测试
• 添加交互式菜单以设置ohcrab（参见问题#74）
• 添加集成测试（参见问题#81）

规则