> ## Documentation Index
> Fetch the complete documentation index at: https://gitquarry.micr.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install gitquarry with npm, pnpm, Bun, Homebrew, Scoop, AUR, GitHub Releases, Nix, or from source.

# Installation

Gitquarry is distributed through a published npm wrapper package, tagged GitHub release binaries, a Homebrew tap, a Scoop bucket, the AUR, and the repository's Nix flake.

## Install With npm, pnpm, Or Bun

```bash theme={null}
npm install -g gitquarry
pnpm add -g gitquarry
bun add -g gitquarry
```

## Install With Homebrew

```bash theme={null}
brew tap Microck/gitquarry
brew install gitquarry
```

## Install With Scoop

```powershell theme={null}
scoop bucket add gitquarry https://github.com/Microck/scoop-gitquarry
scoop install gitquarry
```

## Install From GitHub Releases

Tagged releases publish platform archives on GitHub Releases:

`https://github.com/Microck/gitquarry/releases`

Pick the archive that matches your platform:

* `gitquarry-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gz`
* `gitquarry-vX.Y.Z-aarch64-unknown-linux-gnu.tar.gz`
* `gitquarry-vX.Y.Z-x86_64-apple-darwin.tar.gz`
* `gitquarry-vX.Y.Z-aarch64-apple-darwin.tar.gz`
* `gitquarry-vX.Y.Z-x86_64-pc-windows-msvc.zip`

## Install With Nix

```bash theme={null}
nix run github:Microck/gitquarry
```

## Install From AUR

```bash theme={null}
yay -S gitquarry
```

The tracked Arch packaging files remain in [`packaging/aur/`](../../packaging/aur) and are the same metadata pushed to AUR.

## Install From A Checkout

```bash theme={null}
# from a local clone of this repository
cargo install --path .
```

If you do not want to install it globally yet:

```bash theme={null}
cargo run -- search "rust cli"
```

## Requirements

* Rust toolchain
* network access to GitHub's API
* a GitHub personal access token for any real command

## Release and Publish Flow

Tagged releases verify the package, attach per-target platform archives plus raw binaries and a source tarball to the GitHub release, and provide the versioned artifacts the downstream Homebrew, Scoop, npm, and AUR packaging surfaces should track.

## Verify

```bash theme={null}
gitquarry --help
gitquarry search --help
gitquarry auth login --help
```

## Local Docs Preview

Mintlify uses `docs.json` as the site configuration file. In this repo it lives at `docs/docs.json`.

Run the Mintlify preview server from the `docs/` directory:

```bash theme={null}
cd docs
mint dev
```

If you do not already have the Mintlify CLI installed, follow Mintlify's current CLI install docs first.