gitoxide

(β˜… 11,798)

An idiomatic, lean, fast & safe pure Rust implementation of Git

Showing a partial file list β€” download the zip above to see everything.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .mailmap
  • _typos.toml
  • AGENTS.md
  • build.rs
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • COLLABORATING.md
  • CONTRIBUTING.md
  • crate-status.md
  • deny.toml
  • DEVELOPMENT.md
  • FUNDING.json
  • general-tasks.md
  • LICENSE-APACHE
  • LICENSE-MIT
  • Makefile
  • README.md
  • SECURITY.md
  • SHORTCOMINGS.md
  • STABILITY.md

# Installation Guide

1. Get the code
git clone https://github.com/GitoxideLabs/gitoxide

Downloads the entire project code from GitHub to your computer.

cd gitoxide

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
brew install gitoxide

Installs the pre-built package via Homebrew β€” no source build required.

cargo install gitoxide --locked --no-default-features --features max-pure

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install gitoxide

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install gitoxide --locked --no-default-features --features lean

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f etc/docker/Dockerfile.alpine -t gitoxide:latest --compress . --target=pipeline

Builds a runnable image based on the Dockerfile.

docker build -f etc/docker/Dockerfile.alpine -t gitoxide:latest --compress .

Builds a runnable image based on the Dockerfile.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install gitoxide --locked --no-default-features --features max-pure

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install gitoxide

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install gitoxide --locked --no-default-features --features lean

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install --git https://github.com/GitoxideLabs/gitoxide gitoxide

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install gitoxide --no-default-features --features max-pure

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation