Skip to main content

Prerequisites

Before installing cloneit, ensure you have one of the following:
  • Git and Cargo (Rust toolchain) for building from source or installing from Git
  • Cargo alone for quick installation from the repository
If you don’t have Rust installed, visit rustup.rs to install the Rust toolchain.

Installation Methods

Install directly from the Git repository using Cargo:
cargo install --git https://github.com/alok8bb/cloneit
This downloads and compiles the latest version directly from the repository.
For development or customization, you can build manually:
git clone https://github.com/alok8bb/cloneit
cd cloneit
cargo build --release
The compiled binary will be located at target/release/cloneit. You can then move it to a directory in your PATH:
# Linux/macOS
sudo mv target/release/cloneit /usr/local/bin/

# Or to your local bin directory
mv target/release/cloneit ~/.local/bin/
Make sure the destination directory is in your system’s PATH environment variable.

Verify Installation

After installation, verify that cloneit is properly installed:
cloneit --version
You should see output similar to:
cloneit 1.0.0
To view the help message and available options:
cloneit --help

Troubleshooting

If you get a “command not found” error, the Cargo bin directory may not be in your PATH.Add this line to your shell configuration file (~/.bashrc, ~/.zshrc, etc.):
export PATH="$HOME/.cargo/bin:$PATH"
Then reload your shell configuration:
source ~/.bashrc  # or source ~/.zshrc
If you encounter compilation errors:
  1. Ensure you have the latest Rust toolchain:
    rustup update
    
  2. Check that you meet the minimum Rust version requirements (edition 2018 or later)
  3. Try cleaning the build cache and rebuilding:
    cargo clean
    cargo build --release
    

Next Steps

Now that you have cloneit installed, check out the Quickstart guide to learn how to use it.

Build docs developers (and LLMs) love