Skip to content

Add cross-platform source installers - #1124

Open
viniciusdebruin wants to merge 1 commit into
CodebuffAI:mainfrom
viniciusdebruin:contrib/install-scripts
Open

Add cross-platform source installers#1124
viniciusdebruin wants to merge 1 commit into
CodebuffAI:mainfrom
viniciusdebruin:contrib/install-scripts

Conversation

@viniciusdebruin

Copy link
Copy Markdown

Summary

  • add a Linux/macOS installer at install/install-unix.sh
  • add a Windows installer at install/install-windows.bat
  • clone or update a selected repository branch, install dependencies, build the Freebuff binary, and place it in a user-local bin directory
  • document installing the official branch or a fork/custom branch in README.md

The repository and branch are configurable through FREEBUFF_REPO_URL and FREEBUFF_BRANCH, so the scripts do not depend on a personal fork by default.

Validation

  • bash -n install/install-unix.sh
  • git diff --check
  • Windows batch syntax reviewed; Windows execution was not available in this environment

@codebuff-team

Copy link
Copy Markdown
Contributor

Thanks for taking on cross-platform installers — this is generally the kind of contribution that's useful, and the unix script (set -euo pipefail, idempotent clone/fetch, PATH check) is written carefully.

But the whole thing hinges on assumptions I can't confirm are correct for this repo:

  • Both scripts assume a bun run build:freebuff script exists and produces exactly cli/bin/freebuff (or freebuff.exe) plus cli/bin/tree-sitter.wasm. If the actual build output path, script name, or artifact set differs even slightly, this fails silently for every user who runs it — and there's no way for me to verify this against the current build tooling from the diff alone.
  • The example in README (FREEBUFF_BRANCH=contrib/engine-recovery, mentioning a "recovery-retry version") references a branch/feature that has no connection to this PR or repo history that I can see. That's a strange, oddly specific example to put in permanent docs — worth replacing with something generic like my-feature-branch.
  • No mechanism to validate the scripts actually run to completion (the PR body admits Windows execution wasn't tested, and the unix test was just bash -n, a syntax check, not a real run).
  • 220 lines of install scripting for something the project may already provide differently (there's a quick-start above line 28 in README that this doesn't reconcile with) risks becoming a second, divergent "official" install path that goes stale.

Before this can be ported, please confirm against the actual build scripts (package.json build:freebuff, output directory) and drop the confusing branch example. A short CI job that actually runs the install script end-to-end would go a long way here too.

@codebuff-team codebuff-team added bot:triaged Classified by the community triage bot pr:needs-work Right idea, not mergeable as written labels Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:triaged Classified by the community triage bot pr:needs-work Right idea, not mergeable as written

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants