Skip to content

docs: update README interactive debugging section#15

Merged
valdar merged 1 commit intoopendatahub-io:mainfrom
lburgazzoli:readme-scripts
Feb 17, 2026
Merged

docs: update README interactive debugging section#15
valdar merged 1 commit intoopendatahub-io:mainfrom
lburgazzoli:readme-scripts

Conversation

@lburgazzoli
Copy link
Copy Markdown
Member

@lburgazzoli lburgazzoli commented Feb 16, 2026

  • Fix CLI name from kubectl-odh to rhai-cli
  • Add oc login example for interactive sessions
  • Add rhai-cli binary and upgrade helper scripts locations
  • Add jq to available tools list
  • Format tools list as bullet points

Co-authored-by: Cursor cursoragent@cursor.com

Description

How Has This Been Tested?

Merge criteria:

  • The commits are squashed in a cohesive manner and have meaningful messages.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

Summary by CodeRabbit

  • Documentation
    • Renamed "Interactive Debugging" to "Shell Access" and expanded guidance for shell-based workflows.
    • Added a consolidated "Available tools" list (rhai-cli, kubectl, oc, jq, wget, curl, tar, gzip, bash).
    • Updated examples to reflect current tooling and shell flow (rhai-cli lint).
    • Added high-level installation/location notes for included utilities and preserved token-based login guidance.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

README.md renames "Interactive Debugging" to "Shell Access", adds an "Available tools" list (including rhai-cli), documents rhai-cli and rhai-upgrade-helpers install locations and PATH availability, updates example commands to use rhai-cli lint, and retains token-based login and container usage notes.

Changes

Cohort / File(s) Summary
Documentation
README.md
Renamed section to "Shell Access"; added consolidated "Available tools" list (includes rhai-cli, kubectl, oc, jq, wget, curl, tar, gzip, bash); replaced kubectl-odh lint examples with rhai-cli lint; documented rhai-cli binary path /opt/rhai-cli/bin/rhai-cli and /opt/rhai-upgrade-helpers location and PATH availability; preserved token-based oc login examples and container/KUBECONFIG usage notes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through README lines to shift the view,
"Interactive" turned to "Shell" — a clearer avenue.
rhai-cli tucked in paths, tools listed in a row,
Tokens, shells, and helpers ready for the show.
Hop on, dear devs — the docs now softly glow.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title references 'interactive debugging section' but the changes significantly expand scope to include shell access, migration tools, CLI utilities, and tool installation details. Consider revising the title to reflect the broader changes, such as 'docs: expand README shell access section with tools and installation details' to better represent the full scope of changes.
✅ Passed checks (2 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.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

@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

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 67-75: Update the README sentence "Once inside the container, use
kubectl/oc/wget/curl:" to list all available tools shown in the code block;
replace that fragment with a succinct phrase such as "Once inside the container,
use the available tools (kubectl, oc, wget, curl, rhai-cli, jq, tar, gzip,
bash):" so the sentence matches the following commands and avoids confusion.

Comment thread README.md Outdated
Copy link
Copy Markdown

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

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

80-80: Consider standardizing example domain for consistency.

Line 80 uses example.com while the Token Authentication examples (lines 102, 112) use p3.openshiftapps.com. Both are valid placeholders, but using the same domain pattern throughout would provide better consistency. The .openshiftapps.com pattern is more realistic for OpenShift environments.

📝 Suggested edit for consistency
-oc login --token=sha256~xxxx --server=https://api.my-cluster.example.com:6443
+oc login --token=sha256~xxxx --server=https://api.my-cluster.p3.openshiftapps.com:6443
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 80, Update the example oc login host to use the same
domain pattern as the Token Authentication examples to improve consistency:
replace the current example server host in the "oc login --token=sha256~xxxx
--server=..." line (the oc login example) with a matching .openshiftapps.com
style hostname (e.g., api.my-cluster.p3.openshiftapps.com) so all examples use
the same domain pattern.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 80: Update the example oc login host to use the same domain pattern as
the Token Authentication examples to improve consistency: replace the current
example server host in the "oc login --token=sha256~xxxx --server=..." line (the
oc login example) with a matching .openshiftapps.com style hostname (e.g.,
api.my-cluster.p3.openshiftapps.com) so all examples use the same domain
pattern.

- Fix CLI name from kubectl-odh to rhai-cli
- Add oc login example for interactive sessions
- Add rhai-cli binary and upgrade helper scripts locations
- Add jq to available tools list
- Format tools list as bullet points

Co-authored-by: Cursor <cursoragent@cursor.com>
@valdar valdar merged commit d1cdc20 into opendatahub-io:main Feb 17, 2026
5 checks passed
@lburgazzoli lburgazzoli deleted the readme-scripts branch February 17, 2026 11:32
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.

2 participants