Deprecate and fix search#7778
Draft
nelsonwittwer wants to merge 5 commits into
Draft
Conversation
Introduce `shopify agent-search`, which queries the shopify.dev vector store and prints the most relevant documentation chunks as JSON to stdout (filters: --api-name, --api-version). This is the non-breaking counterpart to repurposing `search` itself: existing `shopify search` behavior is preserved (it still opens shopify.dev in the browser) but is now marked deprecated, so oclif emits a runtime warning pointing users to `agent-search` and the command is hidden from listings. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rather than deprecating `shopify search`, restore the original browser experience by opening `https://shopify.dev/?search=<query>`. The command is no longer marked deprecated, so it stays in the command listings and behaves as it did before. `agent-search` remains the JSON-returning command for programmatic/agent discovery. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
nelsonwittwer
changed the title
agent-search command; deprecate searchagent-search command; fix search browser URL
`https://shopify.dev/?search=<query>` 301-redirects to `https://shopify.dev/docs?search=<query>`. Open that destination directly so the browser doesn't follow a redirect. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Update the description to state that `search` opens shopify.dev in the browser for interactive human use, and point agents to `agent-search` for JSON results. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Per the doc-namespace plan, the JSON search will live at `doc search` (added in a separate PR), so this PR no longer introduces a top-level `agent-search` command. Instead it: - keeps the `search` URL fix (opens https://shopify.dev/docs?search=<query> directly, no redirect), and - marks `search` deprecated with `deprecationOptions = {to: 'doc search'}`, so oclif warns users at runtime and the command is hidden from listings while still working as a browser search for humans. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
nelsonwittwer
changed the title
agent-search command; fix search browser URLsearch
nelsonwittwer
added a commit
that referenced
this pull request
Jun 10, 2026
Per the doc-namespace plan, the JSON vector-store search lives at `doc search` instead of repurposing the top-level `search` command: - Add commands/doc/search.ts (class DocSearch), services/commands/doc/search.ts (docSearchService), and the colocated test; register as `doc:search`. - Add a `doc` topic description. - Revert the breaking change to top-level `search` — it goes back to the original browser behavior (handled/deprecated separately in #7778). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Deprecates
shopify searchand fixes its browser URL. (Earlier revisions of this PR added a top-levelagent-searchcommand; that has been dropped — the JSON search now lives atdoc search, added in #7770.)Why
shopify searchopenedhttps://shopify.dev?search=<query>, which 301-redirects tohttps://shopify.dev/docs?search=<query>. It now opens that destination directly, so it no longer relies on a redirect.docnamespace (doc search, returns JSON).searchstays as the human, browser-based command and now points there.Changes
searchis markedstate: 'deprecated'withdeprecationOptions = {to: 'doc search'}:The "search" command has been deprecated. Use "doc search" instead.commands --deprecated).https://shopify.dev/docs?search=<query>(no redirect).Related
doc searchcommand (JSON documentation search) #7770 — addsdoc search(JSON documentation search for agents).doc fetchcommand (download docs from shopify.dev) #7766 — addsdoc fetch(full-document retrieval).Notes
@shopify/cli: patch.doc search, which lands in Adddoc searchcommand (JSON documentation search) #7770. Merge Adddoc searchcommand (JSON documentation search) #7770 before (or with) this so the suggested command exists.🤖 Generated with Claude Code