Skip to content

Update CLI auth docs to use client credentials#2194

Open
Soner (shyim) wants to merge 1 commit intomainfrom
cli-client-credentials-auth
Open

Update CLI auth docs to use client credentials#2194
Soner (shyim) wants to merge 1 commit intomainfrom
cli-client-credentials-auth

Conversation

@shyim
Copy link
Member

@shyim Soner (shyim) commented Mar 18, 2026

Caution

Merge this on 1 April 2026, as than the feature will be available in the Shopware Account

Summary

  • Replace legacy SHOPWARE_CLI_ACCOUNT_EMAIL / SHOPWARE_CLI_ACCOUNT_PASSWORD env vars with the new SHOPWARE_CLI_ACCOUNT_CLIENT_ID / SHOPWARE_CLI_ACCOUNT_CLIENT_SECRET for CI/CD authentication
  • Add guidance on where to generate client credentials (Extension Partner > Development in the Shopware Account)

Related: shopware/shopware-cli#918

Test plan

  • Verify the rendered docs page displays correctly

@shyim Soner (shyim) force-pushed the cli-client-credentials-auth branch from c0bba52 to 07d0326 Compare March 18, 2026 14:24
Copilot AI review requested due to automatic review settings March 18, 2026 14:24
@shyim Soner (shyim) force-pushed the cli-client-credentials-auth branch from 07d0326 to ae95751 Compare March 18, 2026 14:25
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Shopware CLI documentation for Shopware Account authentication to reflect the move from legacy email/password env vars to OAuth-style client credentials for CI/CD usage, and adds guidance for selecting an active company when an account belongs to multiple companies.

Changes:

  • Replace CI/CD authentication guidance from SHOPWARE_CLI_ACCOUNT_EMAIL / SHOPWARE_CLI_ACCOUNT_PASSWORD to SHOPWARE_CLI_ACCOUNT_CLIENT_ID / SHOPWARE_CLI_ACCOUNT_CLIENT_SECRET.
  • Add instructions to generate client credentials in the Shopware Account UI.
  • Add a “Multiple companies” section with commands to list and select the active company.
Comments suppressed due to low confidence (1)

products/cli/shopware-account-commands/authentication.md:21

  • This section describes using a client secret in CI/CD but removed the earlier guidance about using a dedicated account/limited access. Consider adding an explicit note to use dedicated client credentials (least privilege) and to store/rotate the client secret securely (CI secret store) to reduce the blast radius if leaked.
For CI/CD pipelines, you should pass `SHOPWARE_CLI_ACCOUNT_CLIENT_ID` and `SHOPWARE_CLI_ACCOUNT_CLIENT_SECRET` as environment variables and call directly the command you want to use. The client ID and client secret can be generated in the **Extension Partner** section under the [Development](https://account.shopware.com/producer/development) navigation point in the [Shopware Account](https://account.shopware.com).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@shyim Soner (shyim) force-pushed the cli-client-credentials-auth branch from ae95751 to 5e5838e Compare March 18, 2026 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants