docs: add one-line install command under Highlights#53
Merged
Conversation
Adds a prominent single-command quickstart that installs CodeRAG (engine + MCP server)
straight from the repo and registers it into the user's coding agent:
pip install "coderag[mcp] @ git+https://github.com/Neverdecel/CodeRAG" && coderag install
Also sharpens the Highlights to reflect the new capabilities: a dedicated bullet for
semantic + exact search (search_code and the ripgrep-backed search_files), and a rewritten
"drop-in for AI coding agents" bullet built around `coderag install` (Claude Code, Hermes,
Codex).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011tgKDQJ8p7YLEzoMz32moC
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
3 participants
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.
What
Adds a prominent single-command quickstart directly under the Highlights section of the README, plus sharpens the Highlights to reflect the recently merged features (#52).
One-liner
Installs the engine and MCP server straight from the repo, then
coderag installauto-detects Claude Code, Hermes, and Codex (or launches the interactive wizard) and wires CodeRAG in as the agent's search tool.Highlights tightened
search_code(hybrid) +search_files(ripgrep-backed exact regex/glob).coderag install(Claude Code, Hermes, Codex).Why
Lowering the time-to-value: a reader should be able to copy one line and have CodeRAG running as their agent's search backend, without scrolling for setup steps.
Scope
Docs only —
README.mdis the only file changed (+12 / -1). No code or behavior changes.🤖 Generated with Claude Code
Generated by Claude Code