OhCrab! 🦀

ohcrab is a port of the well known CLI tool thefuck to our beloved Rust language.

Table of contents

1. Installation
2. Usage
3. Contributing
4. Road map

Installation

Currently, there are two methods of installation:

1. Downloading the binary
2. Install using cargo

See below how to install using any of these methods.

Downloading the binary

Follow these steps to download and install the package using the pre-compiled binaries for your OS and architecture:

Download the file

The binaries are available in the Assets section from the release page. Download the binary according to your system:

• ohcrab_x86_64_unknown_linux_gnu_vx.x.x.bin: This binary is for Linux devices with 64-bit Intel processors.
• ohcrab_i686_unknown_linux_gnu_vx.x.x.bin: This binary is for Linux devices with 32-bit Intel processors.
• ohcrab_aarch64_unknown_linux_gnu_vx.x.x.bin: This binary is for Linux devices with ARM 64-bit processors (like Raspberry Pi 3/4).
• ohcrab_x86_64_apple_darwin_vx.x.x.bin: This binary is for Apple devices with 64-bit Intel processors running macOS.
• ohcrab_aarch64_apple_darwin_vx.x.x.bin: This binary is for Apple devices (like the M1 Macs) running macOS.
• ohcrab_i686_unknown_freebsd_vx.x.x.bin: This binary is for FreeBSD devices with 32-bit Intel processors.
• ohcrab_x86_64_unknown_freebsd_vx.x.x.bin: This binary is for FreeBSD devices with 64-bit Intel processors.

Make the binary executable

After downloading the binary, you need to make it executable. Use the following command:

chmod +x <BINARY_NAME>

Replace <BINARY_NAME> with the name of your downloaded binary file.

Move the binary to /opt

We recommend moving the binary to the /opt directory and renaming it to ohcrab. Use the following command:

sudo mv <BINARY_NAME> /opt/ohcrab

Create a symbolic link

Finally, create a symbolic link to the binary from a directory that's in your PATH, like /usr/local/bin. Use the following command:

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

Now, you should be able to run your program from the terminal by typing ohcrab.

Proceed to adding ohcrab to your environment to finalize the installation.

Install from cargo

Prerequisite

For now, it is only possible to install ohcrab through cargo. If you don't have cargo installed, you can install it following the instructions from https://doc.rust-lang.org/cargo/getting-started/installation.html.

Installing the package

You can install ohcrab using cargo:

cargo install ohcrab

Adding ohcrab to your environment

In order for ohcrab to work in your terminal, you need to export the correct function for your shell. Currently, we support bash and zsh. Copy and paste the respective command to your terminal:

• For bash, use:

eval $(ohcrab --shell bash)

• For zsh, use:

eval $(ohcrab --shell zsh)

NOTE: In order to load ohcrab every time you open a terminal, add the eval command above to your .bash_profile, .bashrc, .zshrc or other startup script.

Changing the alias

The commands above use the default alias (crab) to call ohcrab from your terminal. Feel free to use your own alias by passing --alias NEW_ALIAS to use your NEW_ALIAS instead. For example, in case you want to use shinycrab as your alias in zsh, use

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

Usage

In the terminal, after typing the wrong command, type crab (or the alias you chose in during the Exporting ohcrab step). It will show a menu to choose the correct command from.

Contributing

If you like ohcrab and/or want to learn rust, you can contribute by adding new rules or improving the crate.

Road map

• Add sudo support
• Distribute binaries for Linux, MacOs and Windows.
• Make a short screen record of its functioning
• Inform the user which shell type is being used when the ohcrab shell function is generated.
• Add support to user shell aliases.
• Add support to PowerShell
• Reduce number/size of dependencies
• Make it available via package managers
• Benchmark against thefuck
• Add an interactive menu to setup ohcrab (see issue #74)
• Add integration tests (see issue #81)

Rules