local-operator-ui 0.1.0-beta.3 → 0.1.0-beta.5

package/README.md

@@ -43,11 +43,35 @@ The Local Operator UI is a user interface for managing and interacting with the
 
 Before you begin, ensure you have the following installed:
 
-- **Node.js**: Version specified in `.nvmrc`. It's recommended to use [nvm](https://github.com/nvm-sh/nvm) for managing Node.js versions.
-- **yarn**: Installable via `npm install -g yarn`.
+- **Node.js**: Version 22.13.1 or higher. It's recommended to use [nvm](https://github.com/nvm-sh/nvm) for managing Node.js versions.
 - **Local Operator Backend**: The UI connects to the Local Operator backend API. See the [Local Operator GitHub repository](https://github.com/damianvtran/local-operator) for installation instructions.
 
-### Installation
+### NPM Installation
+
+You can install and run Local Operator UI directly using npx:
+
+```bash
+# Install and run in one command
+npx local-operator-ui
+```
+
+This will download and execute the latest version of the Local Operator UI, launching the application immediately.
+
+### Manual Installation
+
+Alternatively, you can install the package globally:
+
+```bash
+# Install globally
+npm install -g local-operator-ui
+
+# Run the application
+local-operator-ui
+```
+
+### Development Setup
+
+If you want to contribute or modify the application, follow these steps:
 
 **Clone the repository:**
 

package/bin/local-operator-ui.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+
+/**
+ * Local Operator UI CLI
+ *
+ * This script serves as the entry point for the npx command.
+ * It launches the Electron app.
+ */
+
+const { spawn } = require("node:child_process");
+const path = require("node:path");
+const fs = require("node:fs");
+
+// Get the path to the electron executable
+const electronPath = require("electron");
+
+// Get the path to the main.js file
+const appPath = path.join(__dirname, "../out/main/index.js");
+
+// Check if the main.js file exists
+if (!fs.existsSync(appPath)) {
+	console.error("Error: Could not find the application entry point.");
+	console.error(
+		"This could happen if the application was not built correctly.",
+	);
+	console.error("Please report this issue to the package maintainer.");
+	process.exit(1);
+}
+
+// Launch the Electron app
+const child = spawn(electronPath, [appPath], {
+	stdio: "inherit",
+	windowsHide: false,
+});
+
+// Handle process exit
+child.on("close", (code) => {
+	process.exit(code);
+});
+
+// Handle errors
+child.on("error", (err) => {
+	console.error("Failed to start Electron application:", err);
+	process.exit(1);
+});
+
+// Handle process termination
+process.on("SIGINT", () => {
+	child.kill("SIGINT");
+});
+
+process.on("SIGTERM", () => {
+	child.kill("SIGTERM");
+});

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "local-operator-ui",
-	"version": "0.1.0-beta.3",
+	"version": "0.1.0-beta.5",
 	"description": "User interface for the Local Operator agent environment",
 	"main": "./out/main/index.js",
 	"bin": {
-		"local-operator-ui": "./out/main/index.js"
+		"local-operator-ui": "./bin/local-operator-ui.js"
 	},
 	"license": "MIT",
 	"author": {
@@ -28,7 +28,7 @@
 		"url": "https://github.com/damianvtran/local-operator-ui/issues"
 	},
 	"keywords": ["local-operator", "agent", "ui", "electron", "react"],
-	"files": ["out", "LICENSE", "README.md"],
+	"files": ["out", "bin", "LICENSE", "README.md"],
 	"publishConfig": {
 		"access": "public"
 	},
@@ -36,6 +36,7 @@
 		"start": "electron-vite preview",
 		"dev": "electron-vite dev",
 		"build": "electron-vite build",
+		"postbuild": "chmod +x ./bin/local-operator-ui.js",
 		"lint": "npx @biomejs/biome check src",
 		"lint:fix": "npx @biomejs/biome check --apply src",
 		"format": "npx @biomejs/biome format src",
@@ -65,7 +66,11 @@
 		"styled-components": "^6.1.14",
 		"uuid": "^11.1.0",
 		"zod": "^3.24.2",
-		"zustand": "^5.0.3"
+		"zustand": "^5.0.3",
+		"electron-vite": "^3.0.0",
+		"react": "^18.3.1",
+		"react-dom": "^18.3.1",
+		"react-router-dom": "^6.16.0"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^1.9.4",
@@ -74,14 +79,10 @@
 		"@types/react": "18.3.18",
 		"@types/react-dom": "18.3.5",
 		"@vitejs/plugin-react": "^4.3.4",
-		"electron-vite": "^3.0.0",
 		"eslint": "^9.17.0",
 		"eslint-plugin-react-hooks": "^5.0.0",
 		"eslint-plugin-react-refresh": "^0.4.16",
 		"jest": "^29.7.0",
-		"react": "^18.3.1",
-		"react-dom": "^18.3.1",
-		"react-router-dom": "^6.16.0",
 		"tsc": "^2.0.4",
 		"typescript": "^5.8.2",
 		"typescript-eslint": "^8.18.2",