Skip to content

Commit 7ea8fe5

Browse files
Update auth guidance for status command
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent d678b4b commit 7ea8fe5

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

.changeset/brave-agents-login.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@shopify/cli': patch
3+
'@shopify/cli-kit': patch
4+
---
5+
6+
Improve Shopify CLI login guidance for agent-driven authentication flows.

docs/cli/auth.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ Shopify CLI authenticates developers with Shopify through a device-code OAuth fl
66

77
Shopify CLI currently supports user-driven device authentication:
88

9-
1. Run a command that requires authentication, or run `shopify auth login` directly.
10-
2. Shopify CLI prints a verification URL and user code, or opens the verification URL in your browser.
11-
3. The user completes login in the browser.
12-
4. Keep the CLI process running. It polls for completion and continues automatically after authentication succeeds.
9+
1. Check whether a session is already available with `shopify auth status` or `shopify auth status --json`.
10+
2. Run a command that requires authentication, or run `shopify auth login` directly.
11+
3. Shopify CLI prints a verification URL and user code, or opens the verification URL in your browser.
12+
4. The user completes login in the browser.
13+
5. Keep the CLI process running. It polls for completion and continues automatically after authentication succeeds.
1314

1415
Agents should show the verification URL and user code to the user, ask the user to complete authentication in the browser, and wait for the CLI command to finish.
1516

1617
## Commands
1718

1819
- `shopify auth login`: Start an interactive Shopify account login.
1920
- `shopify auth logout`: Clear the stored Shopify CLI session.
21+
- `shopify auth status`: Check whether Shopify CLI has a usable Shopify account session. Use `--json` for machine-readable output.
2022
- Commands that need authentication may start the same login flow automatically.
2123

2224
## Non-interactive environments

0 commit comments

Comments
 (0)