sim 2.1.8-dev.94.1 → 2.1.8-preview.100.1

package/README.md

@@ -33,23 +33,37 @@ Sign in to the default profile:
 sim login
 ```
 
-The CLI opens a browser and prints a pairing code. Confirm that the code in the
-browser matches the one in your terminal, approve the login, and choose a
-workspace. The selected workspace becomes the default for this profile.
-
-The login stores a personal API key locally. It does not start a local callback
-server, so the same flow works over SSH and in containers. Use
-`sim login --no-browser` when the browser is on another machine.
-
-Check the active profile and verify that its endpoint, API key, and workspace
+With no `--method`, the CLI prefers OAuth when the server offers it and a local
+browser callback is possible. It selects API-key pairing for remote terminals
+or servers without OAuth. Use `sim login --method oauth` to require OAuth;
+if the server does not offer it, login fails without creating an API key.
+
+OAuth login opens Sim in your browser, asks you to approve the requested access,
+and receives the one-time authorization code on a loopback callback. It stores
+a short-lived OAuth login that renews automatically and can be revoked under
+**Settings → General → Authorized apps**. Choose a default workspace afterward with
+`sim configure --set-workspace <id>`.
+
+Use `--no-browser` with either method to print the approval URL without opening
+it. OAuth still needs the browser to reach the CLI's loopback callback. Over SSH
+or in a container without port forwarding, use
+`sim login --method api-key --no-browser` to approve from another device and
+create a permanent personal API key. `--method api-key` creates a new key;
+set `SIM_API_KEY` to supply an existing one.
+
+Pairing requires a server that supports `platform` API keys. Upgrade older
+deployments that only issue `copilot` keys before login; they are not compatible
+with the platform CLI. OAuth discovery does not check pairing compatibility.
+
+Check the active profile and verify that its endpoint, credential, and workspace
 work together:
 
 ```bash
 sim whoami
 ```
 
-This also reports whether the active key is personal or workspace-scoped. Some
-administrative and deployment operations require a personal key.
+This also reports whether the active credential is an OAuth login or an API
+key. Some administrative operations require a personal credential.
 
 Then list and run workflows:
 
@@ -73,7 +87,7 @@ not a workflow.
 A profile is a named CLI configuration. It determines:
 
 - which Sim deployment to use
-- which API key to authenticate with
+- which stored login or API key to authenticate with
 - which workspace to target by default
 - how command output is formatted
 
@@ -94,8 +108,8 @@ There are two common ways to create profiles.
 
 ### Use one login with several workspaces
 
-After `sim login`, create another profile that shares the active profile's API
-key but has its own default workspace:
+After `sim login`, create another profile that shares the active profile's
+credential but has its own default workspace:
 
 ```bash
 sim workspaces list
@@ -105,7 +119,7 @@ sim --profile acme whoami
 
 If you omit `--workspace` in an interactive terminal, the CLI asks you to choose
 one. The new profile stores an `auth_profile` reference to the active login; it
-does not copy the API key.
+does not copy the credential.
 
 ### Use a separate account or deployment
 
@@ -117,8 +131,8 @@ sim login --profile work
 sim login --profile local --endpoint http://localhost:3000
 ```
 
-Each of these profiles stores its own API key. The endpoint selected during
-login is saved with the profile.
+Each of these profiles stores its own login. The endpoint selected during login
+is saved with the profile.
 
 ### View and change profiles
 
@@ -134,8 +148,9 @@ sim whoami --profile work
 `sim profiles` marks the active profile with `*`. Running `sim configure` with
 no setting flags prints the saved settings for that profile.
 
-Non-secret settings are stored in `~/.sim/config`. API keys are stored separately
-in `~/.sim/credentials`, which is written with `0600` permissions. Set
+Non-secret settings are stored in `~/.sim/config`. OAuth tokens and API keys are
+stored separately in `~/.sim/credentials`, which is written with `0600`
+permissions. Set
 `SIM_CONFIG_DIR` to use a different directory.
 
 For each setting, the CLI uses the first available value in this order:
@@ -256,9 +271,26 @@ The main environment variables are:
 | `SIM_API_KEY` | API key, usually for CI |
 | `SIM_WORKSPACE` | Workspace to target |
 | `SIM_OUTPUT` | `table`, `json`, `yaml`, or `text` |
-| `SIM_CONFIG_DIR` | Directory containing CLI config and credentials |
+| `SIM_CONFIG_DIR` | Base directory for CLI config, credentials, and the update cache |
 | `SIM_TIMEOUT_SECONDS` | Per-request timeout; `0` waits indefinitely |
 | `SIM_DEBUG` | Print request diagnostics to stderr |
+| `SIM_NO_UPDATE_CHECK` | Turn off the update notice |
+
+On eligible interactive invocations, `sim` uses a daily cache before asking
+`registry.npmjs.org` what is published under the `latest` tag and prints one
+line on stderr when a newer version exists. Prerelease installs are skipped
+entirely. The cache lives in `~/.sim` by default and follows `SIM_CONFIG_DIR`;
+without a writable cache, each eligible invocation checks again. Concurrent
+invocations can also perform duplicate checks. The registry request has a
+one-second deadline; the short-lived request process is terminated on expiry.
+Apart from the configured registry URL, it sends only its own version and never
+your Sim API key. If `npm_config_registry` points at a private mirror, its query
+string is preserved, including any query-string credentials. Registry URLs
+containing username/password userinfo are rejected. Set
+`SIM_NO_UPDATE_CHECK=1` to turn it off. Empty or whitespace-only registry values
+use the public default; non-empty malformed or non-HTTP(S) values fail closed.
+The full list of cases where it stays quiet is in the
+[configuration guide](https://docs.sim.ai/cli/configuration).
 
 ## Documentation
 

package/THIRD_PARTY_LICENSES

@@ -9,6 +9,13 @@ Copyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca>
 js-yaml
 Copyright (C) 2011-2015 by Vitaly Puzrin
 
+proper-lockfile
+Copyright (c) 2018 Made With MOXY Lda <hello@moxy.studio>
+
+retry
+Copyright (c) 2011 Tim Koschützki (tim@debuggable.com)
+Copyright (c) 2011 Felix Geisendörfer (felix@debuggable.com)
+
 Each dependency above is licensed under the MIT License:
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -28,3 +35,38 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+graceful-fs
+The ISC License
+
+Copyright (c) 2011-2022 Isaac Z. Schlueter, Ben Noordhuis, and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+signal-exit
+The ISC License
+
+Copyright (c) 2015, Contributors
+
+Permission to use, copy, modify, and/or distribute this software
+for any purpose with or without fee is hereby granted, provided
+that the above copyright notice and this permission notice
+appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE
+LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
+OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.