Skip to content

Installation

The install script auto-detects your OS (Linux, macOS, Windows via MINGW/MSYS/Cygwin) and architecture (x64, arm64) and downloads the right pre-compiled binary from the latest release to /usr/local/bin.

Windows

On Windows, the script requires a bash-compatible shell (Git Bash, MSYS2, or Cygwin). Native PowerShell is not supported — download the binary directly from the releases page instead.

bash
curl -fsSL https://raw.githubusercontent.com/fulll/github-code-search/main/install.sh | bash

Custom install directory or version

bash
INSTALL_DIR=~/.local/bin VERSION=vX.Y.Z \
  curl -fsSL https://raw.githubusercontent.com/fulll/github-code-search/main/install.sh | bash
VariableDefaultDescription
INSTALL_DIR/usr/local/binDirectory where the binary is installed
VERSIONlatest releaseSpecific version tag to install (e.g. v1.1.0)

From source

Requires Bun ≥ 1.0.

bash
git clone https://github.com/fulll/github-code-search
cd github-code-search
bun install
bun run build.ts
# → produces dist/github-code-search

Copy the binary wherever you like:

bash
cp dist/github-code-search ~/.local/bin/

Cross-compilation

The build script accepts any Bun executable target via --target:

bash
bun run build.ts --target=bun-linux-x64
bun run build.ts --target=bun-linux-x64-baseline
bun run build.ts --target=bun-linux-arm64
bun run build.ts --target=bun-darwin-x64
bun run build.ts --target=bun-darwin-arm64
bun run build.ts --target=bun-windows-x64

Verify the installation

bash
github-code-search --version
# → X.Y.Z (abc1234 · darwin/arm64)

The version string includes the commit SHA, OS and architecture — useful for bug reports.

Upgrade

Once installed, you can upgrade to the latest release with a single command:

bash
github-code-search upgrade

Next step

Run your first search

Released under the MIT License.