@@ -27,8 +27,11 @@ sim login --method api-key
2727server must enable ` OAUTH_PROVIDER_ENABLED=true ` . Explicit OAuth selection also
2828overrides SSH/headless detection; your browser still needs to reach the CLI's
2929local callback. ` --method api-key ` uses pairing-code approval to create a new
30- permanent API key. To supply an existing key, use the global ` --api-key <key> `
31- option or ` SIM_API_KEY ` instead.
30+ permanent API key. To supply an existing key, set ` SIM_API_KEY ` instead.
31+
32+ API-key pairing requires a server that supports ` platform ` API keys. Upgrade
33+ older deployments that only issue ` copilot ` keys before starting login; those
34+ keys cannot authenticate the platform CLI.
3235
3336OAuth login opens your browser on Sim's sign-in page, then on a consent page that
3437names the Sim CLI and what it will be able to do. Approve, and the browser hands
@@ -100,9 +103,10 @@ approving. That check is what binds the approval to your terminal.
100103
101104The handoff issues a permanent personal API key rather than a renewing login,
102105so revoke it under ** Settings → API keys** when you are done with that machine.
103- It is also the path for a deployment that predates OAuth sign-in, or one with
104- the provider switched off; the CLI detects that and selects API-key login when
105- ` --method ` is omitted. An explicit ` --method oauth ` fails in that case.
106+ It also works when OAuth is unavailable or switched off, provided the server
107+ supports platform API-key pairing. When ` --method ` is omitted, the CLI checks
108+ OAuth availability and selects pairing if unavailable; that discovery does not
109+ verify pairing compatibility. An explicit ` --method oauth ` fails in that case.
106110
107111` --read-only ` and ` --callback-port ` belong to OAuth login and have no
108112meaning here, so combining either with the handoff stops the login rather than
0 commit comments