@uipath/cli 1.0.4 → 1.1.0

package/README.md

@@ -66,6 +66,17 @@ uip login -t my-tenant-name
 uip login --interactive
 ```
 
+**Authentication exit-code contract:**
+
+Authentication commands reserve exit code `2` for `AuthenticationError`
+results where the CLI cannot produce or find a usable authenticated
+session. This includes failed `uip login` credential/token exchange,
+`login refresh` failures, expired sessions, and missing credentials.
+Exit code `1` is used for non-authentication failures such as bad host
+configuration, filesystem problems, or tenant-selection/config errors.
+Exit code `3` is used by `login refresh` for invalid `--login-validity`
+values.
+
 #### `uip login status`
 
 Display current login status and session information.
@@ -228,6 +239,40 @@ env:
 - Missing or empty required variables produce a clear error naming the
   offending variable rather than a generic "not authenticated".
 
+#### Robot-credentials-only authentication (Studio Desktop)
+
+For consumers that spawn `uip` from a process whose user is already
+signed in to the local UiPath Robot/Assistant (e.g. Studio Desktop's
+Publish Solution feature), the CLI can be forced to authenticate via
+the Robot IPC fallback and bypass `~/.uipath/.auth` entirely.
+
+Set `UIPATH_CLI_ENFORCE_ROBOT_AUTH=true` on the spawned `uip` child
+process. When set:
+
+- The Robot fallback (introduced in #1055) is consulted first. If it
+  yields a session, the CLI returns `Logged in` with `Source: robot` —
+  no on-disk credentials are read or written.
+- If the Robot is not running, not signed in, or the IPC handshake
+  times out, the CLI **does not** fall back to `~/.uipath/.auth` or to
+  env-var auth. The reported login status is `Not logged in`, with a
+  hint that names the env var and points at the Assistant.
+  - `uip login status` itself surfaces this as `Status: "Not logged in"`
+    in its JSON payload and exits 0 (it's a diagnostic command and does
+    not fail on missing auth).
+  - Any auth-requiring command (e.g. `uip solution publish`) fails with
+    `AuthenticationError` and exits `2`, surfacing the same hint.
+- `UIPATH_CLI_ENFORCE_ROBOT_AUTH` and `UIPATH_CLI_ENABLE_ENV_AUTH` are
+  mutually exclusive. Setting both produces an explicit error rather
+  than silently picking one.
+- `UIPATH_URL`'s "skip Robot fallback" behavior is overridden — when
+  `UIPATH_CLI_ENFORCE_ROBOT_AUTH=true`, the Robot path is taken
+  regardless of `UIPATH_URL`.
+
+This flag is intended as a **per-process opt-in** set programmatically
+on the spawned `uip` child only (e.g. via `ProcessStartInfo.EnvironmentVariables`
+in .NET). Setting it at User or Machine scope would force every CLI
+invocation on the host into Robot-only auth — not the intended use.
+
 ### Tool Management
 
 The CLI supports a plugin system that allows you to extend functionality by installing additional tools.
@@ -374,4 +419,3 @@ bun test
 ### Contributing
 
 For bug reports and feature requests, please visit the [GitHub repository](https://github.com/UiPath/cli).
-