docs: single install path — pipx + gradata install (GRA-1212 / GH #206)#211
Merged
Conversation
…RA-1198)
Replaces the two-path 'Claude Code via /plugin marketplace OR Python SDK
via pipx' branching with a single canonical install: pipx + gradata
install --agent <host>.
Why: the plugin marketplace path was a duplicate surface that did the
same thing the SDK install command already does (apply hooks + slash
commands to the host config). Two paths created onboarding friction
('which one am I supposed to use?') for zero functional gain. Council
voted Option A 'kill the plugin' on 2026-05-01.
Also surfaces the 6 first-class subcommands the SDK now ships:
status, correct, forget, prove, recall, doctor. Three of those were
shipped earlier today (PR #208 status, #209 forget, #210 prove) and
replaced the equivalent plugin slash commands.
Removed:
- '/plugin marketplace add Gradata/gradata' + '/plugin install gradata'
- The 'pick one' framing
- .claude-plugin/ from the repo layout (manifest stays in tree until
PR retiring the directory ships separately — keeps the layout
description accurate as of THIS commit)
Parent: GRA-1198 (kill the plugin epic)
GH: Gradata/gradata #206
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
📝 WalkthroughDocumentation update: unified installation path
WalkthroughThe README is updated to streamline installation instructions into a single ChangesREADME Installation and Layout Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related issues
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@Gradata/README.md`:
- Line 187: The README currently contradicts itself by claiming a “single
install surface” (the Python CLI) while still showing `pip install gradata` in
other places; update the doc to be consistent by either (A) making the Python
CLI the canonical install path and replacing the `pip install gradata`
occurrences (reference the strings "pip install gradata" shown around Line 15
and Line 103) with the recommended `pipx` install command and a brief note on
alternatives, or (B) soften the absolute sentence near the "Replace `--agent
claude-code`..." line to read that the Python CLI is the
primary/install-recommended surface and keep both pip/pipx examples with clear
guidance which is recommended. Ensure the change references the sentence that
mentions "single install surface" and the exact `pip install gradata` phrases to
keep the README consistent.
🪄 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: ASSERTIVE
Plan: Pro
Run ID: 02b350af-925d-4c69-9f64-a5bc78b82890
📒 Files selected for processing (1)
Gradata/README.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: pytest ubuntu-latest / py3.11
- GitHub Check: pytest (py3.12)
- GitHub Check: pytest windows-latest / py3.12
- GitHub Check: pytest macos-latest / py3.11
- GitHub Check: pytest (py3.11)
- GitHub Check: pytest macos-latest / py3.12
- GitHub Check: pytest ubuntu-latest / py3.12
- GitHub Check: pytest windows-latest / py3.11
🔇 Additional comments (1)
Gradata/README.md (1)
180-185: LGTM!Also applies to: 189-201, 365-365
| ``` | ||
|
|
||
| Prereq: `pipx install gradata`. See [`.claude-plugin/README.md`](./.claude-plugin/README.md). | ||
| Replace `--agent claude-code` with your host: `codex`, `gemini`, `hermes`, `opencode`, or `cursor`. One command, one path — the Python CLI is the single install surface for every host. |
There was a problem hiding this comment.
Absolute “single install surface” claim is contradicted elsewhere in this README.
Line 187 says there is one install path, but this file still shows pip install gradata (Line 15 and Line 103). Either make those sections consistent with the canonical pipx path, or soften this sentence to avoid a contradictory absolute.
Suggested doc fix
-Replace `--agent claude-code` with your host: `codex`, `gemini`, `hermes`, `opencode`, or `cursor`. One command, one path — the Python CLI is the single install surface for every host.
+Replace `--agent claude-code` with your host: `codex`, `gemini`, `hermes`, `opencode`, or `cursor`. This is the canonical agent-install path across hosts.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Replace `--agent claude-code` with your host: `codex`, `gemini`, `hermes`, `opencode`, or `cursor`. One command, one path — the Python CLI is the single install surface for every host. | |
| Replace `--agent claude-code` with your host: `codex`, `gemini`, `hermes`, `opencode`, or `cursor`. This is the canonical agent-install path across hosts. |
🤖 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 `@Gradata/README.md` at line 187, The README currently contradicts itself by
claiming a “single install surface” (the Python CLI) while still showing `pip
install gradata` in other places; update the doc to be consistent by either (A)
making the Python CLI the canonical install path and replacing the `pip install
gradata` occurrences (reference the strings "pip install gradata" shown around
Line 15 and Line 103) with the recommended `pipx` install command and a brief
note on alternatives, or (B) soften the absolute sentence near the "Replace
`--agent claude-code`..." line to read that the Python CLI is the
primary/install-recommended surface and keep both pip/pipx examples with clear
guidance which is recommended. Ensure the change references the sentence that
mentions "single install surface" and the exact `pip install gradata` phrases to
keep the README consistent.
This was referenced May 20, 2026
Gradata
added a commit
that referenced
this pull request
May 20, 2026
…-1198) (#214) The .claude-plugin/ directory itself was already removed in a prior cleanup (see CHANGELOG: 'Remove orphaned gradata-plugin/ subdir (#54)'). What remained were stale string references in docs and examples now that the SDK ships all subcommands directly (PRs #208/#209/#210/#211 + #213). Changes: - .dockerignore: removed dead .claude-plugin exclude line - examples/with_claude_code.py: replaced '/plugin install gradata' language with the canonical 'gradata install --agent claude-code' - examples/README.md: fix broken link to .claude-plugin/README.md - CHANGELOG.md: BREAKING entry under Unreleased documenting the retirement This closes out the kill-the-plugin epic (GRA-1198 / GH #206) from the references side. Anyone who installed via /plugin marketplace before 2026-05-20 must migrate to the SDK install path. Verified: - pip install /home/olive/work/gradata-sdk/Gradata in a fresh venv succeeds - gradata install --agent claude-code --brain /tmp/test-brain --help works - pytest tests/ -x -q passes (816 tests, 7 skipped, 1 known-skip on test_byo_key_provider for missing httpx in dev env unrelated to this) - ruff check clean on touched files - grep for 'claude-plugin|gradata-plugin' on src/ + docs/ shows only the intentional CHANGELOG entries (current BREAKING note + historical refs) Branch authored by delegate_task subagent (hit max_iterations on PR-open); parent agent verified + extracted clean diff + opened PR. Co-authored-by: data-engineer <data-engineer@gradata.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the two-path Claude Code marketplace OR Python SDK pipx branching with a single canonical install:
pipx install gradata && gradata install --agent <host>.Why
The
/plugin marketplace addpath was a duplicate surface that did the same thinggradata install --agent claude-codealready does (apply hooks + slash commands). Two paths created onboarding friction ('which one?') for zero functional gain. Council voted Option A 'kill the plugin' on 2026-05-01.Companion PRs that made this safe
Three subcommands shipped today replace what the plugin's slash commands did:
gradata statusreplaces/gradata:statusgradata forgetreplaces/gradata:forgetgradata provereplaces/gradata:prove/gradata:promoteis deferred (no SDK scope-machinery exists — separate feature spike).Changes
/plugin marketplace add+/plugin installinstructions.claude-plugin/(manifest stays in tree until separate retirement PR — README description matches reality AS OF THIS COMMIT)Verification
Render the README on GitHub — install section shows one canonical path. No 'pick one' framing remains. Plugin marketplace install command is gone.
Epic context
GRA-1198 (kill the plugin) / GH #206. Caps the epic from the docs side. Plugin directory retirement (
.claude-plugin/removal) is a follow-up PR.