ADR003: Choosing a distribution method for CLI applications

[bmf-san]

Title

ADR003: Choosing a distribution method for CLI applications

Context

CLI applications are intended to be run by users through a terminal or command prompt. Applications need to be widely available and easily adopted by users.

Decision

From the options below, select "Binary distribution" as the CLI application distribution method.

• Binary distribution:

  • Advantages:
    • Ready to download and use.
    • Users do not need to manually install.
  • Disadvantage:
    • Version control can be a hassle.
    • Different installation steps required for each OS.

• Distribution using a package manager:

  • Advantages:
    • By using a package manager, users can install with a single command.
    • Easy application updates.
  • Disadvantage:
    • Cannot be used in environments where package managers are not supported.

Status

Accepted

Consequences

Cross-compile your application and distribute it as a binary.
Easily distribute binaries using GoReleaser.

References

• gorelease.com