Install
A .NET tool, or a single executable for your platform.
.NET tool
dotnet tool install --global Badger.Trek
trek --version
Requires the .NET 10 SDK. Pin a version per repository with a local tool manifest (dotnet new tool-manifest, then dotnet tool install Badger.Trek) and run it as dotnet trek. (Pass options after the command: dotnet trek add --help. dotnet tool run trek add --help shows dotnet's own help instead.) dotnet trek is found only in the folder that holds .config/dotnet-tools.json and the folders below it: elsewhere dotnet says "dotnet-trek does not exist". Create the manifest at the repository root, or run dotnet trek from below the folder that has it.
Standalone executable
Download the archive for your platform and put trek on your PATH. The executables are self-contained: no .NET runtime needed. Builds exist for Windows (x64, Arm64), macOS (Apple silicon, Intel) and Linux (x64, Arm64, Alpine x64), plus a portable build for any OS with the .NET 10 runtime.
Check it works
trek --help
trek doctor -C path/to/project -e dev # configuration, sign-in, connection, journal
Platform notes
- macOS: binaries are signed ad hoc but not notarized; clear the quarantine flag once with
xattr -d com.apple.quarantine trek. - Linux: Kerberos (integrated) authentication needs the system GSSAPI library. Entra interactive sign-in caches tokens with libsecret; without it, use device code or set
entra.allowUnencryptedTokenCache. - Windows: Windows authentication uses SSPI; the Windows certificate store, CNG and CSP key stores for Always Encrypted are available.