@uipath/cli 0.2.1 → 0.9.0

package/README.browser.md

@@ -0,0 +1,86 @@
+# UiPath CLI — Browser Bundle
+
+A browser-runnable bundle of the UiPath CLI. Exposes a `UiPathCLI` global that host applications can load to run CLI commands without a Node.js backend.
+
+## What's in the bundle
+
+- **3 tools** (browser-compatible): `orchestrator-tool` (`or`), `integrationservice-tool` (`is`), `test-manager-tool` (`tm`)
+- **Core framework**: Commander program, `--output-filter`, output formatting, telemetry, error handling
+
+Each tool opts in by shipping a `browser.json` next to its `package.json` with `{ "compatible": true }`. At build time, `discover-browser-tools` scans `packages/*-tool/` and emits a virtual module importing each opted-in tool.
+
+Authentication is **not** included in this bundle — commands will return "Not logged in" until the browser-auth PR lands (#701).
+
+## Bundle
+
+- **Build command**: `bun run browser:build` (from `packages/cli/`)
+- **Output**: `packages/cli/dist/uip-browser.js`, plus `dist/metafile.json` for build-time assertions
+- **Size**: ~3.3 MB unminified; ~1.4 MB / ~250 KB gzipped when `minify: true` is re-enabled in `build-browser.ts`
+- **Format**: IIFE, exposes `UiPathCLI` global
+
+## Loading the bundle
+
+```html
+<script src="/path/to/uip-browser.js"></script>
+<script>
+  (async () => {
+    // Wait for filesystem (LightningFS over IndexedDB) to initialize
+    await UiPathCLI.ready;
+
+    // Run a CLI command
+    await UiPathCLI.run(['node', 'uip', '--help']);
+  })();
+</script>
+```
+
+## API
+
+### `UiPathCLI.run(args, options?)`
+
+Parses and executes a CLI invocation.
+
+```ts
+UiPathCLI.run(
+  args: string[],              // e.g. ['node', 'uip', 'or', 'folders', 'list']
+  options?: {
+    enabledTools?: string[];   // allowlist by command prefix: ['or', 'is']
+  }
+): Promise<void>
+```
+
+**`enabledTools`** — allowlist of tool command prefixes that register with Commander. Omit to register all discovered browser-compatible tools.
+
+### `UiPathCLI.ready`
+
+A `Promise<void>` that resolves when the virtual filesystem (LightningFS over IndexedDB) has initialized. Await before the first `run()` call.
+
+## Browser-compatible tools
+
+| Command | Tool | What it does |
+|---------|------|--------------|
+| `uip or <subcommand>` | orchestrator-tool | Jobs, processes, packages, folders, machines, licenses, users, permissions |
+| `uip is <subcommand>` | integrationservice-tool | Connectors, connections, triggers |
+| `uip tm <subcommand>` | test-manager-tool | Test cases, sets, executions, results |
+
+Use `uip or --help` (etc.) for the full subcommand tree.
+
+## Limitations
+
+- **No authentication.** Wiring for credential injection ships in a follow-up (#701). Until then, any command that calls the UiPath Cloud API returns `Not logged in`.
+- **No interactive prompts.** Commands that use `@inquirer/prompts` (e.g. `send-feedback`, `tools install --interactive`) are Node-only and not registered in the browser bundle.
+- **No file-based auth.** `uip login` / `uip logout` are Node-only and excluded from the browser entry.
+- **No subprocess spawning.** `child_process` is not available.
+- **Filesystem is virtual.** All file I/O routes through `@uipath/filesystem`'s `BrowserFileSystem`, backed by LightningFS + IndexedDB. Host-app code that reads/writes files should use `getFileSystem()` / `getFileSystemAsync()` from `@uipath/filesystem`.
+- **Direct `node:fs` / `node:path` imports fail at build time** for any non-commander caller — Rule 10 is enforced by the bundler.
+
+## CORS
+
+Once auth lands in #701, the bundle will make `fetch()` requests directly to the UiPath Cloud API. The host page's origin must be allow-listed by the target environment, or the host can proxy API calls through its own server to avoid cross-origin preflight.
+
+## Troubleshooting
+
+**`"Result": "Failure", "Instructions": "Not logged in..."`** — expected for now; auth wiring ships in #701.
+
+**`UiPathCLI is not defined`** — bundle hasn't loaded or loaded at a different scope. Confirm the `<script>` tag fires before your init code, or listen for its `load` event.
+
+**IndexedDB errors** — the bundle uses LightningFS for its virtual filesystem. Not available in headless environments without IndexedDB polyfills (e.g. `happy-dom` without `fake-indexeddb`).

package/README.md

@@ -85,6 +85,50 @@ uip login status
    Base URL: https://cloud.uipath.com
 ```
 
+#### Environment-variable authentication (CI/CD)
+
+For non-interactive environments such as CI/CD pipelines, containers, or
+scheduled jobs, the CLI can source credentials directly from environment
+variables — bypassing the interactive login flow and the on-disk
+`.uipath/.auth` file entirely.
+
+Set `UIPATH_CLI_ENABLE_ENV_AUTH=true` to opt in, then provide the
+following variables:
+
+| Variable | Description |
+| --- | --- |
+| `UIPATH_CLI_AUTH_TOKEN` | Access token (JWT). The server URL is derived from its `iss` claim. |
+| `UIPATH_CLI_ORGANIZATION_NAME` | Organization slug |
+| `UIPATH_CLI_ORGANIZATION_ID` | Organization UUID |
+| `UIPATH_CLI_TENANT_NAME` | Tenant slug |
+| `UIPATH_CLI_TENANT_ID` | Tenant UUID |
+
+**Example (GitHub Actions):**
+```yaml
+env:
+  UIPATH_CLI_ENABLE_ENV_AUTH: "true"
+  UIPATH_CLI_AUTH_TOKEN: ${{ secrets.UIPATH_TOKEN }}
+  UIPATH_CLI_ORGANIZATION_NAME: contoso
+  UIPATH_CLI_ORGANIZATION_ID: ${{ secrets.UIPATH_ORG_ID }}
+  UIPATH_CLI_TENANT_NAME: Default
+  UIPATH_CLI_TENANT_ID: ${{ secrets.UIPATH_TENANT_ID }}
+```
+
+**Notes:**
+- The access token is treated as opaque — the caller is responsible for
+  its freshness. There is no refresh flow: if the token is expired,
+  `uip login status` reports `Expired` and commands fail until the
+  env var is rotated.
+- The server URL is **not** a separate env var — it is derived from the
+  token's `iss` claim, which is the authoritative source for the
+  identity server that minted the token. This prevents mis-routing
+  when a user sets `UIPATH_URL` inconsistently with the token.
+- When `UIPATH_CLI_ENABLE_ENV_AUTH` is unset (or any value other than
+  the literal string `true`), the file-based auth flow is used — no
+  behavior change for existing users.
+- Missing or empty required variables produce a clear error naming the
+  offending variable rather than a generic "not authenticated".
+
 ### Tool Management
 
 The CLI supports a plugin system that allows you to extend functionality by installing additional tools.
@@ -152,6 +196,45 @@ uip tools install @uipath/automation-tool
 - View help for a specific command: `uip <command> --help`
 - View version: `uip --version`
 
+## Proxy Support
+
+The CLI respects standard HTTP proxy environment variables. This is useful in corporate environments where internet access goes through a proxy server.
+
+**Supported environment variables:**
+
+| Variable | Description |
+|---|---|
+| `HTTP_PROXY` / `http_proxy` | Proxy for HTTP requests |
+| `HTTPS_PROXY` / `https_proxy` | Proxy for HTTPS requests |
+| `NO_PROXY` / `no_proxy` | Comma-separated list of hosts that bypass the proxy |
+
+**Examples:**
+
+```bash
+# Linux / macOS
+export HTTPS_PROXY=http://proxy.example.com:8080
+uip login
+
+# Windows (cmd)
+set HTTPS_PROXY=http://proxy.example.com:8080
+uip login
+
+# Windows (PowerShell)
+$env:HTTPS_PROXY = "http://proxy.example.com:8080"
+uip login
+
+# With authentication
+export HTTPS_PROXY=http://user:password@proxy.example.com:8080
+uip login
+
+# Bypass proxy for specific hosts
+export HTTPS_PROXY=http://proxy.example.com:8080
+export NO_PROXY=localhost,127.0.0.1,.internal.corp
+uip login
+```
+
+> **Note:** When running under Bun, proxy support is built-in. When running under Node.js, the CLI uses Node's built-in undici module to enable proxy-aware `fetch()`.
+
 ## Troubleshooting
 
 ### Not logged in error
@@ -191,5 +274,5 @@ bun test
 
 ### Contributing
 
-For bug reports and feature requests, please visit the [GitHub repository](https://github.com/UiPath/uipcli).
+For bug reports and feature requests, please visit the [GitHub repository](https://github.com/UiPath/cli).