Skip to content

Add section for upgrading the OpenHound CLI#298

Merged
jeff-matthews merged 5 commits into
mainfrom
openhound-upgrade
May 22, 2026
Merged

Add section for upgrading the OpenHound CLI#298
jeff-matthews merged 5 commits into
mainfrom
openhound-upgrade

Conversation

@jeff-matthews
Copy link
Copy Markdown
Contributor

@jeff-matthews jeff-matthews commented May 22, 2026

Summary by CodeRabbit

  • Documentation
    • Restructured Community Edition installation documentation with an improved tabbed interface for the OpenHound CLI.
    • Clarified installation options to help users choose between installing all built-in collectors or specific collectors based on their needs.
    • Enhanced documentation with information about automatic OpenGraph output file splitting for optimized uploads.

Review Change Stack

@jeff-matthews jeff-matthews self-assigned this May 22, 2026
@jeff-matthews jeff-matthews added the data-collection Docs related to nodes, edges, and general data collection label May 22, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

Warning

Rate limit exceeded

@jeff-matthews has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 24 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 15f5d6fa-801d-416b-8962-504b35026642

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef459d and 99cf2a3.

📒 Files selected for processing (1)
  • docs/openhound/community.mdx

Walkthrough

This PR updates the Community Edition documentation for OpenHound CLI installation and operation. The "Installing" section heading is simplified, and installation instructions are restructured with a tabbed UI offering separate commands for installing all built-in collectors versus specific collectors. Upgrade instructions are expanded accordingly. A note about graph output file splitting is repositioned within the documentation.

Changes

Community Edition CLI Installation Documentation

Layer / File(s) Summary
Install command selection and header
docs/openhound/community.mdx
Section header changed from "Installing the OpenHound CLI" to "Install the OpenHound CLI". Install instructions replaced with a tabbed "Choose the install command" section presenting separate uv commands for all collectors and specific collectors, and upgrade instructions updated to cover reinstall scenarios for both paths.
Graph output note repositioning
docs/openhound/community.mdx
Note about automatic OpenGraph output file splitting for BloodHound upload optimization repositioned within the CLI Commands section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A doc that once told only one installation tale,
Now splits into two paths, so none shall fail—
All collectors, or pick and choose your own,
The CLI path is clearer, growth has grown!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title claims to add an upgrade section, but the raw summary shows the changes are primarily about restructuring the installation instructions with tabbed UI sections and updated command examples, not adding an upgrade section. Revise the title to accurately reflect the main change: 'Update OpenHound CLI installation documentation with tabbed UI for collector options' or similar.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ 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 openhound-upgrade

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.

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 22, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
bloodhound 🟢 Ready View Preview May 22, 2026, 5:55 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

@Scoubi Scoubi left a comment

Choose a reason for hiding this comment

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

Approved with some minor suggestion.

Comment thread docs/openhound/community.mdx Outdated
Comment thread docs/openhound/community.mdx Outdated
Comment thread docs/openhound/community.mdx Outdated
@jeff-matthews
Copy link
Copy Markdown
Contributor Author

Good suggestions @Scoubi! Thanks.

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

🤖 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 `@docs/openhound/community.mdx`:
- Around line 43-47: Update the `Github` capitalization to the official `GitHub`
everywhere in this doc example: change the extras list string
"openhound[okta,jamf,github]" to "openhound[okta,jamf,github]" with the label
capitalized in prose (i.e., replace the displayed word "Github" with "GitHub")
and ensure any other occurrences in the same file use "GitHub" (look for the
example command and any mention of the Github collector).
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3abc0d4b-35c0-4b9c-afd3-adca1fcf999a

📥 Commits

Reviewing files that changed from the base of the PR and between 833fa22 and 8ef459d.

📒 Files selected for processing (1)
  • docs/openhound/community.mdx

Comment thread docs/openhound/community.mdx Outdated
@jeff-matthews jeff-matthews merged commit ac13f62 into main May 22, 2026
2 checks passed
@jeff-matthews jeff-matthews deleted the openhound-upgrade branch May 22, 2026 18:18
@github-actions github-actions Bot locked and limited conversation to collaborators May 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

data-collection Docs related to nodes, edges, and general data collection

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants