Skip to content

docs: document localsend-cli installation via Homebrew - #3572

Open
ShlomoCode wants to merge 1 commit into
localsend:mainfrom
ShlomoCode:codex/docs-cli-homebrew-upstream
Open

ShlomoCode wants to merge 1 commit into
localsend:mainfrom
ShlomoCode:codex/docs-cli-homebrew-upstream

Conversation

@ShlomoCode

@ShlomoCode ShlomoCode commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 88690b2c-819b-460b-a112-5457df8c62f2


📥 Commits

Reviewing files that changed from the base of the PR and between 14f3a87 and 5ea8f63.



📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • README.md
  • support/readme/README_ZH.md


Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.




📝 Walkthrough
📝 Walkthrough

Walkthrough

The contribution guide adds a separate Homebrew entry for localsend-cli. The English and Chinese READMEs add Homebrew installation and upgrade instructions for macOS and Linux.

Changes

Homebrew CLI documentation

Layer / File(s) Summary
Homebrew distribution listing
CONTRIBUTING.md
The guide adds a localsend-cli Homebrew entry with its repository and maintainer attribution. It changes the existing cask attribution to Homebrew autobump.
CLI installation and upgrade instructions
README.md, support/readme/README_ZH.md
Both READMEs add macOS and Linux Homebrew installation and upgrade commands. The commands run brew update first.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: tienisto



Merge Risk: ⚪ Minimal · up to 5ea8f

The Homebrew listing and installation guidance match the available formula, leaving no actionable merge-blocking risk.

Architecture Summary

Architecture risk: 🔵 Low · up to 5ea8f

The change affects 3 systems.

Changed systems: CONTRIBUTING.md, README.md, support

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — CONTRIBUTING.md (service) was modified; 1 changed file maps to changed impact.
  • observed — README.md (service) was modified; 1 changed file maps to changed impact.
  • observed — support (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in CONTRIBUTING.md: The Homebrew cask row now lists Homebrew autobump instead of Github Actions, and a separate localsend-cli Homebrew row was added with its repository and maintainer attribution.
  • observed — Modified behavior in CONTRIBUTING.md: Added the link reference for the Homebrew CLI formula repository.
  • observed — Modified behavior in CONTRIBUTING.md: Added the GitHub profile link reference for @ShlomoCode.
  • observed — Modified behavior in README.md: Adds Homebrew commands for installing localsend-cli on macOS and Linux and upgrading an existing installation; both workflows run brew update before the install or upgrade command.


Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: documenting Homebrew installation for localsend-cli.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR



  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@ShlomoCode
ShlomoCode requested a review from Tienisto October 11, 2026 21:01

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant