Packaging for bbin

April 12, 2025 ยท View on GitHub

bbin can install scripts and projects from various sources. This guide explains how to package your repo for seamless installation with bbin.

Installation Sources

bbin supports installing packages from:

  • Git repositories
  • HTTP URLs
  • Maven artifacts
  • Local filesystem

There is no central registry for bbin - it leverages existing infrastructure like GitHub and Maven repositories.

Configuration

To properly package your repo for bbin, include a configuration in your bb.edn file that specifies the binaries to install:

{:bbin/bin {cmd-name {:main-opts ["-m" "cmd.core"]}}}

This configuration defines:

  • The binary name (neil in this example)
  • How to execute it (with the main namespace to run being cmd.core)

Installation Methods

  • For projects with deps.edn: Install using --git/url, --mvn/version, or --local/root options

    • GitHub projects can use the shorthand syntax: io.github.user/repo

  • For standalone .clj scripts: Host on GitHub and install from the raw HTTP URL

    • Scripts can be installed from any local path or HTTP URL ending in .clj