Skip to content

Add package installation instructions for Linux (deb/rpm) to README.md#22

Merged
noborus merged 2 commits into
mainfrom
add-package
May 22, 2026
Merged

Add package installation instructions for Linux (deb/rpm) to README.md#22
noborus merged 2 commits into
mainfrom
add-package

Conversation

@noborus
Copy link
Copy Markdown
Owner

@noborus noborus commented May 22, 2026

close #21

Summary by CodeRabbit

  • Documentation
    • Added a new Linux packages (deb/rpm) installation section in the README with asset naming details and example install commands (including dependency fix step).
    • Reformatted SQL example blocks for improved readability (adjusted whitespace and line breaks) while preserving the shown query structure.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e81aa0b7-68e1-4175-af73-c404c62744df

📥 Commits

Reviewing files that changed from the base of the PR and between 7a1d46c and 7074d2f.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md now includes a "Linux packages (deb/rpm)" installation section documenting .deb/.rpm release assets and install commands; two console SQL example blocks were reformatted for readability (whitespace/line-breaks only).

Changes

Documentation Updates

Layer / File(s) Summary
Linux packages documentation and SQL example formatting
README.md
New "Linux packages (deb/rpm)" installation subsection added with supported extensions, release asset filename patterns, and example install commands (including an apt dependency-fix step). Two multi-line SQL console examples were reformatted for whitespace/line-break readability only.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through README's gate,
New Linux paths to celebrate,
Debs and rpms in tidy row,
SQL lines that gently flow,
Hooray for docs that help things go!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding Linux package installation instructions (deb/rpm) to README.md, which is the primary focus of the changeset.
Linked Issues check ✅ Passed The PR adds Linux (deb/rpm) package installation instructions to README.md, directly addressing issue #21's request for a clear installation path for Linux users without relying on go install.
Out of Scope Changes check ✅ Passed The PR includes a minor reformatting of SQL example code blocks in README.md, which is tangential to the main objective but supportive of documentation quality and not contradictory to the linked issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-package

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

57-59: ⚡ Quick win

Prefer distro package managers over rpm -i for local RPM installs.

rpm -i does not resolve dependencies automatically on common RPM-based distros. Using dnf/zypper here better supports the “easy install” objective.

Suggested doc tweak
 # RHEL/Fedora/openSUSE
-sudo rpm -i xlsxsql_<version>_linux_amd64.rpm
+# Fedora/RHEL
+sudo dnf install ./xlsxsql_<version>_linux_amd64.rpm
+# openSUSE
+sudo zypper install ./xlsxsql_<version>_linux_amd64.rpm
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 57 - 59, Update the README section headed
"RHEL/Fedora/openSUSE" by replacing the direct "sudo rpm -i
xlsxsql_<version>_linux_amd64.rpm" instruction with distro-package-manager
commands that resolve dependencies—e.g., for RHEL/Fedora show "sudo dnf install
./xlsxsql_<version>_linux_amd64.rpm" and for openSUSE show "sudo zypper install
./xlsxsql_<version>_linux_amd64.rpm" (keep the existing header text and filename
pattern so the change is easy to locate).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 37: Update the README.md install sentence to include a direct hyperlink
to the project's GitHub Releases page by replacing the plain text "GitHub
Releases page" with a Markdown link pointing to the Releases URL (e.g.
https://github.com/<owner>/<repo>/releases); locate the line containing "Linux
users can install prebuilt packages from the GitHub Releases page." and convert
it to use the Markdown link so readers can click straight through to Releases.

---

Nitpick comments:
In `@README.md`:
- Around line 57-59: Update the README section headed "RHEL/Fedora/openSUSE" by
replacing the direct "sudo rpm -i xlsxsql_<version>_linux_amd64.rpm" instruction
with distro-package-manager commands that resolve dependencies—e.g., for
RHEL/Fedora show "sudo dnf install ./xlsxsql_<version>_linux_amd64.rpm" and for
openSUSE show "sudo zypper install ./xlsxsql_<version>_linux_amd64.rpm" (keep
the existing header text and filename pattern so the change is easy to locate).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9da23756-6a36-4528-9276-b0296d0b753e

📥 Commits

Reviewing files that changed from the base of the PR and between 8b2f2ad and 7a1d46c.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
@noborus noborus merged commit 5e7f6f8 into main May 22, 2026
2 checks passed
@noborus noborus deleted the add-package branch May 22, 2026 02:07
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.

go install adds xls2csv not xlsxsql

1 participant