glep / Get started
Installation
Install glep 2.0.0 from PyPI with pip, pipx or uv, or with cargo, see which platforms have wheels, and what changes when you upgrade from 0.3.1.
On this page
glep is a single Rust binary. Version 2.0.0 is published as binary wheels on PyPI (no Rust toolchain needed), as a crate on crates.io, and as a GitHub release with the wheels and standalone binaries attached.
First principles
- glep is one compiled binary. Installing it means putting that binary on your PATH, and every route below does only that.
- A wheel is a binary prebuilt for one platform. Where a wheel exists, pip needs no compiler. Where none exists, the only route is to compile from source, which needs a Rust toolchain.
- The agent integrations are scripts in the repository, not part of the binary, so they install separately.
- The index is per-project data, not part of the install. Removing the binary leaves each project’s
.glep/directory behind.
From PyPI (recommended)
pip install glep
The wheel contains only the glep binary, so an isolated tool installer works too:
pipx install glep
# or
uv tool install glep
Requirements: Python 3.8 or newer, used only to install the wheel. glep itself does not run Python.
Prebuilt wheels exist for these platforms (version 2.0.0, the same targets as 0.3.1):
- macOS on Apple Silicon (macOS 11 or newer)
- macOS on Intel (macOS 10.12 or newer)
- Linux x86_64 and aarch64 (manylinux, glibc 2.17 or newer)
- Linux x86_64 with musl (musllinux 1.2)
- Windows x86_64
The wheels link the PCRE2 (Perl Compatible Regular Expressions) library statically, so they need no PCRE2 installed on the system. PyPI has no source distribution for glep, so on any other platform pip install glep fails. Use cargo instead.
From crates.io
cargo install glep
This installs 2.0.0. It needs a Rust toolchain, and the build also compiles the PCRE2 C library through the pcre2-sys crate, so it needs a C compiler as well.
From 2.0.0 on, PyPI and crates.io carry the same versions. Versions 0.3.0 and 0.3.1 were published to PyPI only, so crates.io goes from 0.2.3 to 2.0.0. To build a tagged release from source:
cargo install --git https://github.com/velofy/glep --tag v2.0.0
Upgrading from 0.3.1
2.0.0 follows 0.3.1 directly; there was no 0.4.0 release. The Changelog lists everything that changed. Coming from 0.3.1, these are the differences you will notice:
- Index rebuild. Existing indexes rebuild once, on the first query (postings format v2 to v5).
- Flags. 0.3.1 has only
-e(one pattern),-i,-F,-U,-l,-c,--json,-C,-A,-B,--files,-g,-t,--hidden,--no-ignore,--ttl,--max-filesize, and theindexandstatuswords. Every other flag in the CLI reference is new in 2.0.0. - Index location. Run in a subdirectory of an indexed tree, 2.0.0 uses the nearest
.glep/above it and scopes the search to the current directory. 0.3.1 built a second, separate index in the subdirectory. - Output modes.
-l,-cand--jsonare last-wins output modes, as in ripgrep. 0.3.1 rejected-lor-cwith--json, and-cwith-l, as a usage error (exit 2). - Binary files. Binary detection follows ripgrep’s reader: a NUL byte in the first 64 KiB, where 0.3.1 looked at the first 8 KB. UTF-16 files with a byte-order mark are transcoded and searched instead of skipped.
- Ignore files.
.rgignorefiles apply, and--no-ignore-vcsalso turns off.git/info/excludeand the global gitignore, so results can change in trees that rely on them. - Closed pipes. In 0.3.1,
glep pattern | head -5printsglep: Broken pipe (os error 32)and exits 2. 2.0.0 ends quietly, as ripgrep does. - Dash-leading patterns. In 0.3.1,
-e '-> Result'fails as an unknown flag. 2.0.0 takes the next word as the value. - First query. 0.3.1 builds the index before it answers the first query, at any tree size. Outside Windows, 2.0.0 answers the first query on a tree of more than 64 MiB with a full scan and builds the index in the background.
- Sizes.
--max-filesizetakes a plain byte count in 0.3.1. 2.0.0 also acceptsK,MandGsuffixes. - Status.
glep statusprintsskipped (binary/oversized):in 0.3.1 andskipped (binary/oversized/utf16):in 2.0.0.
Other routes
- GitHub releases exist from v0.3.1 on. v0.3.1 has the wheels attached; v2.0.0 has the wheels and standalone binaries. Earlier versions have tags only.
- There is no Homebrew formula.
Check the install
glep --version
This prints glep 2.0.0.
Optional: agent integrations
The Claude Code skill and hook, and the Cursor hook, are not part of the wheel or the crate. They live in the repository and install with a script. They need python3 on your PATH.
git clone https://github.com/velofy/glep
glep/claude/install.sh # Claude Code skill + hook
glep/cursor/install.sh # Cursor hook
See Using glep with Claude Code and Using glep with Cursor.
Optional: shell completions and a man page
glep generates them on demand:
glep --generate complete-zsh > _glep
glep --generate man > glep.1
The other kinds are complete-bash, complete-fish and complete-powershell. Install the output wherever your shell or man looks for it.
Uninstall
Remove the binary with the tool you installed it with (pip uninstall glep, pipx uninstall glep, uv tool uninstall glep, or cargo uninstall glep). Each indexed project also has a .glep/ directory you can delete.