Repository navigation
[docs] Document AI client skill recommendation and --no-ai-hint flag - #2618
Draft
shopware-docs-updater[bot] wants to merge 1 commit into
Draft
shopware-docs-updater[bot] wants to merge 1 commit into
shopware-docs-updater[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
There was a problem hiding this comment.
Threat detection produced a warning for this pull request output.
These changes need to be scrutinized before merge and only merged after a careful manual review.
- Detection reason:
agent_failure - Review workflow run logs: https://github.com/shopware/shopware-cli/actions/runs/38740136920
Developer Docs healthcheckStatus: Completed with |
Developer Docs healthcheckStatus: Running. |
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
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.
Warning
Threat Detection Engine Failure — The analysis engine could not complete. This is a tooling failure, not a security finding.
What happened
The threat detection engine failed to produce results.
Review the workflow run logs for details.
Summary
Shopware CLI PR shopware/shopware-cli#1686 (merged, by Tomasz Turkowski (@tturkowski)) added a user-facing CLI behavior change: the CLI now detects when it's invoked by a supported AI coding agent (via the
AI_AGENTenvironment variable) and, if theshopware-cliskill isn't installed for that client, prints a short non-blocking recommendation to stderr pointing atshopware-cli ai add ... --global. It also added a new global--no-ai-hintflag to suppress this recommendation, and made the previously hiddenaicommand group visible in--help.This is directly comparable to the existing, already-documented
--no-update-hint/ update-notification behavior inproducts/tools/cli/installation.md, but the new--no-ai-hintflag and AI recommendation mechanism had no corresponding entry in the public docs (only in the repo's internaldocs/AGENT_SKILLS.md, which is not part of the public developer documentation).Documentation gap addressed
--no-ai-hintflag.products/tools/cli/installation.md, directly after the existing "Update notifications" section, following the same style and structure (what triggers it, when it stays silent, and how to suppress it with--no-ai-hint).Files changed
products/tools/cli/installation.md— added "AI client skill recommendation" section documenting theAI_AGENT-based detection, the silence conditions (no agent detected,CIset,--no-ai-hintpassed, running anai ...command, skill already installed), the 24-hour suppression window, and the--no-ai-hintflag usage.Validation
pnpm run check:markdownwas not run locally becausepnpmis not available in this sandbox environment — the change mirrors the exact structure/style of the adjacent, already-passing "Update notifications" section, so it should conform to the same markdown lint rules.Related: shopware/shopware-cli#1686