Skip to content

Repository files navigation

bunli-starter-template

A GitHub template repository for building and shipping a Bunli CLI with real multi-platform releases.

Use This Template

  1. Click "Use this template" on GitHub.
  2. Update names:
    • package.json: package name, description
    • package.json#bin key: this becomes the CLI binary name
    • bunli.config.ts: name and version
    • .bunli-releaser.yml: project.binary
  3. Update Homebrew settings in .github/workflows/release.yml:
    • brew-tap
    • HOMEBREW_TAP_TOKEN

Development

bun install
bun run dev -- greet --name World

Release (Binaries + Homebrew)

This repo is meant to be tagged with strict semver tags:

git tag v0.1.0
git push origin v0.1.0

The release workflow publishes:

  • ${name}-${version}-${os}-${arch}.tar.gz (macOS/Linux)
  • ${name}-${version}-${os}-${arch}.zip (Windows)
  • checksums.txt (sha256)

Notes:

  • Homebrew consumes macOS/Linux assets only. Windows is still published on the GitHub Release.
  • If you enable build.compress in bunli.config.ts, bunli-releaser will fail. Keep it disabled.

About

GitHub template repository for Bunli CLIs with real bunli-releaser releases

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages