Skip to content

docs: distributing CLI binaries via Homebrew, MacPorts, and Scoop #172

Description

@zrosenbauer

Summary

Add documentation (and optionally tooling) covering how to distribute a kidd-built CLI binary through system package managers — Homebrew, MacPorts, Scoop (Windows), and APT/RPM repos.

Motivation

Users expect to install CLI tools via their system package manager (brew install, scoop install, etc.). This makes the CLI discoverable outside the npm ecosystem, removes the Node.js runtime requirement, and provides a familiar update path. A guide (and eventually tooling) lowers the barrier for kidd-based CLI authors to publish through these channels.

Current state

  • Kidd can produce standalone binaries for all major platforms via bun build --compile
  • No existing docs or automation for publishing to any system package manager
  • The only Homebrew reference in the codebase is the Nerd Font installer middleware (packages/core/src/middleware/icons/install.ts)

Proposed scope

  • Docs: A guide in docs/guides/ covering:
    • Creating and maintaining a Homebrew tap (formula template, GitHub Release integration)
    • MacPorts Portfile basics
    • Scoop bucket for Windows
    • Brief pointers to APT/RPM packaging (or link to goreleaser-style tooling)
  • Tooling (stretch): A generator or bundler hook that outputs Homebrew formula / Scoop manifest from package.json metadata + compiled binary checksums

Open questions

  • Should this live as a standalone guide or as part of a broader "distribution" section in docs?
  • Is a Homebrew tap under the joggr GitHub org the intended approach?
  • Priority order: Homebrew > Scoop > MacPorts > APT/RPM?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation improvements

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions