Skip to content

[docs] Document AI client skill recommendation and --no-ai-hint flag #2618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
shopware-docs-updater wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[docs] Document AI client skill recommendation and --no-ai-hint flag #2618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions products/tools/cli/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,24 @@
export SHOPWARE_CLI_NO_UPDATE_NOTIFICATION=true
```

## AI client skill recommendation

When Shopware CLI is invoked by a supported AI coding agent (detected from the `AI_AGENT` environment variable set by the agent itself) and its `shopware-cli` skill is not yet installed for that client, the CLI prints a short, non-blocking recommendation to stderr pointing at the `shopware-cli ai add` command. See [AI agent skills](https://github.com/shopware/shopware-cli/blob/main/docs/AGENT_SKILLS.md) for details on the `ai` command group. It never installs anything automatically and is shown at most once per client every 24 hours.

Check warning on line 188 in products/tools/cli/installation.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/tools/cli/installation.md#L188 

For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI[1])
Suggestions: `AI`
URL: https://languagetool.org/insights/post/ai/ 
Rule: https://community.languagetool.org/rule/show/AI?lang=en-US&subId=1
Category: CASING
Raw output 
products/tools/cli/installation.md:188:293: For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI[1])
 Suggestions: `AI`
 URL: https://languagetool.org/insights/post/ai/ 
 Rule: https://community.languagetool.org/rule/show/AI?lang=en-US&subId=1
 Category: CASING

It stays silent when:

- no AI client is detected
- `CI` is set
- `--no-ai-hint` is passed
- the invoked command is itself an `ai …` command
- the skill is already installed for that client

To silence it for a single command, pass `--no-ai-hint`:

```bash
shopware-cli --no-ai-hint <command>
```

## Environment variables

### Authentication and configuration
Expand Down
Loading