Skip to content

Revise setup documentation #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AmrDeveloper merged 1 commit into from
Jan 5, 2026
Merged

Revise setup documentation #148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,31 @@
## Install from Package managers

## Cargo.io
### Cargo.io

```sh
cargo install gitql
```

> Note that from version `0.10.0` onward installing from Cargo requires `Cmake` to be installed so it can build the dependencies.

## Winget on Windows
### Winget on Windows

```sh
winget install gitql
```

## Scoop on Windows
### Scoop on Windows

```sh
scoop install gitql
```

## Homebrew on MacOS and Linux
### Homebrew on MacOS and Linux

```sh
brew install gql
```

# On Single repository
gitql <repository_path>

# On multi repositories
gitql --repo <repository_path> <repository_path> ...etc

# Or
gitql -r <repository_path> <repository_path> ...etc
```

## Download Binaries

From Github repository page you can download the right executable for your OS and Arch from the latest release
Expand All @@ -54,7 +44,20 @@ cargo run -- --repo <repository_path> <repository_path> ...etc
cargo run -- -r <repository_path> <repository_path> ...etc
```

# Command line arguments
## Samples for using command line

```sh
# On Single repository
gitql <repository_path>

# On multi repositories
gitql --repo <repository_path> <repository_path> ...etc

# Or
gitql -r <repository_path> <repository_path> ...etc
```

## Command line arguments

```
Usage: gitql [OPTIONS]
Expand Down