Skip to content

Add cross-platform source installers - #1124

Closed
viniciusdebruin wants to merge 8805 commits into
CodebuffAI:mainfrom
viniciusdebruin:contrib/install-scripts
Closed

viniciusdebruin wants to merge 8805 commits 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 public sync bot added 30 commits August 19, 2026 16:36
Source: CodebuffAI/freebuff-private@3b89b37ffac9f705298099c1a92cc12ff86439b1
Source: CodebuffAI/freebuff-private@6a6c2560a0d89ff9d4fb3b3b3dcf459e718aa015
Source: CodebuffAI/freebuff-private@6bbe32b95effc6c81479ffe1be3854bbf2b6a175
Source: CodebuffAI/freebuff-private@9c49375348733a5bdc7b13b5e5c71b6aac3c150c
Source: CodebuffAI/freebuff-private@18d9e898bfc0e44ac24017f980f81033123c2f83
Source: CodebuffAI/freebuff-private@67af829808816a20e117fd57c654b471e6857eae
Source: CodebuffAI/freebuff-private@3285b31b770fd5b07e854d993ac8e87e5e679f8b
Source: CodebuffAI/freebuff-private@79bfc42ece2b9e4cc4a88140e23479e5809da816
Source: CodebuffAI/freebuff-private@65df59b85e220b8f962fe01cdbe7d4e18824e320
Source: CodebuffAI/freebuff-private@e6b914d9b664add769727e29d0984c69e8717e74
Source: CodebuffAI/freebuff-private@1781f579a7d28f6609f75540529b58bd5ee8208f
Source: CodebuffAI/freebuff-private@d266b9ad26aa4d539a01097c6be544afada6b7e6
Source: CodebuffAI/freebuff-private@a518571bda930dd9f6d3c513f405f879d9474585
Source: CodebuffAI/freebuff-private@ff3322e5cc03fc4f33796f8f49fce51744b6ecb0
Source: CodebuffAI/freebuff-private@b96808549f5ba06fbac82369b419fef88bc6c6ae
Source: CodebuffAI/freebuff-private@2cf94fb38519b4fdc2caa80ce073ec2e423b2ddd
Source: CodebuffAI/freebuff-private@a3a71b3b96bd25ce2f4258704267af6ff646f9ec
Source: CodebuffAI/freebuff-private@0693087e2e254602d44514d9c44099410dda8323
Source: CodebuffAI/freebuff-private@efdf10960936cf0f87f8141191fb76b55706ed85
Source: CodebuffAI/freebuff-private@ad6bc9adfa02f0b967424df70a6b1202bcec285d
Source: CodebuffAI/freebuff-private@c71eca2672511e34e48c6e36344b060af95f0ee6
Source: CodebuffAI/freebuff-private@edac5d5b4121e342607f803b277b2a20eed859a0
Source: CodebuffAI/freebuff-private@05417f841e0359ece3e80876fe19ba5f25044f51
Source: CodebuffAI/freebuff-private@7f756a3d3d5ae9237b007a038334de6f143daff1
Source: CodebuffAI/freebuff-private@665569ba8321ae5a453633dd0693029e3414bf93
Source: CodebuffAI/freebuff-private@050b9f6fd4658f2589d2b4498e99298e49ccbb81
Source: CodebuffAI/freebuff-private@a5771d769f7ec7dac6c97fdc4bf9c5aa6201895a
Source: CodebuffAI/freebuff-private@5720ef36ed9e8ed03feac155a528d4e210778f99
Source: CodebuffAI/freebuff-private@21d1b8dbfdc437b857f751cb71d33aefd5a9b586
Source: CodebuffAI/freebuff-private@f496b0de4478d19ce64daa3b25d063a38f6b7cfb
codebuff public sync bot and others added 23 commits August 24, 2026 22:14
Source: CodebuffAI/freebuff-private@241f8bfa8a8a97867900b2f71754638efa2cbe86
Source: CodebuffAI/freebuff-private@cfc7760af31f29f1acc7153a7e9fcb48d35f730b
Source: CodebuffAI/freebuff-private@6965ea40dbf54a44c932ca4df63b0dd6377bfec5
Source: CodebuffAI/freebuff-private@ecf4fa2e98fcefcec1a96cbd596b5b16bccd97e3
Source: CodebuffAI/freebuff-private@ce96ca2455d9c6a027d6e41048e8f2520f78754f
Source: CodebuffAI/freebuff-private@890653e2610c57c22298d532cae0129efb26f862
Source: CodebuffAI/freebuff-private@d60d93125f90cdca18e1fc97819b91997081a97f
Source: CodebuffAI/freebuff-private@70ba2a57ab1e48c9f799107675dfb6029dc6d54f
Source: CodebuffAI/freebuff-private@9c2be6595fa98153b9ec0474caed5ec3a58ec116
Source: CodebuffAI/freebuff-private@c1db5271ba86e1c89c3c9fc0c6e6a2a857d3b5dd
Source: CodebuffAI/freebuff-private@2846f67777f75ee23da1e3a3047176d66953d906
Source: CodebuffAI/freebuff-private@f5329a11c8431d6f5c98581c2bfc67fb2d1829ba
Source: CodebuffAI/freebuff-private@e319a9e3de31d8c4cd1d0a9285dfd5360eebb7a1
Source: CodebuffAI/freebuff-private@9cbbba39efda2071b8325bf2779b39170e35348c
Source: CodebuffAI/freebuff-private@8470da01520ea7c273efb6eca943fd37fb265189
Source: CodebuffAI/freebuff-private@884e8a41dd02bb5c0be09d8da8e465c994a6c6a4
Source: CodebuffAI/freebuff-private@b550c712e828f5211de07c5699a643fe0fa8f22e
Source: CodebuffAI/freebuff-private@ddfa6c89a27176e4e1afef0bd597077698e3d9e3
Source: CodebuffAI/freebuff-private@9b8fb92689a45c3d52b65f6d4177bb8b0e4a29db
Source: CodebuffAI/freebuff-private@e20dcb5811c89bc349a283c8fb8b474f03857eaa
Source: CodebuffAI/freebuff-private@1a9bb08ef45331c94cfa616a7e5f91dbc3375e7b
Source: CodebuffAI/freebuff-private@2204d7f013215d4a9746f87ccadb88422bdbf0ce
@codebuff-team

ghost commented Aug 25, 2026

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
@viniciusdebruin

ghost commented Aug 26, 2026

Copy link
Copy Markdown
Author

Thanks for the detailed review. Here is the context and the validation I can provide:

  • The implementation in this PR was produced by OpenAI Codex at my request. I am developing on an older MacBook Pro running Linux Mint, where Freebuff was not working initially. The Sol model helped identify a working approach, and I asked it to prepare this pull request to help the community.
  • I verified the repository build contract locally: package.json defines build:freebuff as bun freebuff/cli/build.ts 0.0.0-dev, which invokes the Freebuff binary build. On Windows, it produced cli/bin/freebuff.exe and cli/bin/tree-sitter.wasm, and the installer copied both artifacts into the user-local Freebuff bin directory.
  • I agree that the README branch example should be generic, such as my-feature-branch, rather than referencing contrib/engine-recovery.
  • I also agree that an end-to-end CI check is preferable to bash -n alone. It should run the installer in an isolated temporary checkout, verify both artifacts, and invoke --version and --help before declaring success.
  • The quick-start instructions should be reconciled so the installer is the single documented path instead of maintaining a second divergent setup flow.

I am happy to update the PR with those documentation and CI adjustments if the maintainers would prefer them in this contribution.

@victorxheng

ghost commented Aug 31, 2026

Copy link
Copy Markdown

Apologies — this PR was auto-closed by GitHub when we force-pushed a history rewrite of this repository (repository maintenance; every commit SHA changed). That was not a judgment on this PR, and GitHub does not allow us to reopen it because the commits it was based on no longer exist in the new history.

If you'd like to continue with this change: rebase your branch onto the new main (or recreate it from a fresh clone) and open a new PR — feel free to link back to this one for context, and we'll pick up the review there.

Sorry for the churn, and thanks for contributing.

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.

3 participants