microsoft / microsoft/tgrep

Package manager distribution (Homebrew, Linux packages, WinGet/Scoop, crates.io)

Open
#109 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
3.3k
Forks
129
Avg merge
21h 37m
Merged PRs (30d)
28

Description

Umbrella issue for making tgrep installable through native package managers.

Follows on from #107, which asks specifically for a Homebrew formula. The same gap applies to Linux and Windows users.

Current state

The only documented install paths are:

  • cargo install --path tgrep-cli --locked after cloning the repo
  • manually downloading a tarball/zip from Releases and extracting it onto PATH

There is no package manager story on any platform, and nothing published to crates.io.

The good news is that .github/workflows/release.yml already produces the artifacts packaging needs:

  • x86_64-unknown-linux-musl
  • aarch64-unknown-linux-musl
  • x86_64-apple-darwin
  • aarch64-apple-darwin
  • Windows zip

So most of this is packaging and release automation rather than new build work.

Proposed scope

macOS + Linux — Homebrew (covers #107)

Publish a formula to a microsoft/homebrew-tap so users can run brew install microsoft/tap/tgrep. Homebrew works on Linux as well, so a single bottle-less formula pointing at the existing release tarballs covers both platforms. Moving to homebrew-core later is possible once the project meets its notability requirements.

Linux — native packages
  • .deb via cargo-deb and .rpm via cargo-generate-rpm, attached to each GitHub release
  • optionally a Nix derivation and an AUR PKGBUILD (both are typically community-maintained)
Windows — WinGet and/or Scoop

Submit a WinGet manifest and/or a Scoop bucket entry built from the existing Windows zip.

Cross-platform — crates.io

Publishing tgrep-cli to crates.io makes cargo install tgrep work without cloning the repo. This is the cheapest win and benefits every platform at once.

Release automation

Whatever we adopt needs a bump step in the release workflow so formulas/manifests are updated with the new version and checksums automatically. Otherwise these go stale within a release or two.

Suggested order

  1. crates.io publish (lowest effort, immediate cross-platform benefit)
  2. Homebrew tap (closes #107, highest demand)
  3. .deb/.rpm artifacts on releases
  4. WinGet/Scoop
  5. Automate version + checksum bumps in release.yml

Docs

Update the Installation section of README.md as each channel lands.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading .github/workflows/release.yml and the existing installation section in README.md, then review the current cargo install and release artifact paths. The issue spans crates.io, Homebrew, Linux packages, Windows manifests, and release automation, so define one channel as a focused contribution. Done means the selected channel is published or attached to releases, version and checksum updates are covered where applicable, and README.md reflects it.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, rust
Domain
build-system, documentation, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.