exb-community-cli 1.0.2 → 1.0.3

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2026 Lucius Creamer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 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.

package/README.md

@@ -4,9 +4,9 @@ A simple, lightweight command line interface to make using Experience Builder De
 
 ## Using this CLI
 
-The ExB Community CLI has a few tools to make it easy to install, update, remove, and search for Experience Builder widgets that have been posted on NPM. Installing the CLI is as simple as running `npm i exb-community-cli` in your client directory of your Experience Builder application. To then run commands, the format is `npx exb-cli [command]`. If you don't want to prefix every command with npx, you can install the exb-community-cli globally, by running `npm i -g exb-community-cli` (Recommended). For information on the commands that exist, run `npx exb-cli help`, and commands, arguments, and descriptions will be listed.
+The ExB Community CLI has a few tools to make it easy to install, update, remove, and search for Experience Builder widgets that have been posted on NPM. Installing the CLI is as simple as running `npm install exb-community-cli` in your client directory of your Experience Builder application. To then run commands, the format is `npx exb [command]`. If you don't want to prefix every command with npx, you can install the exb-community-cli globally, by running `npm install -g exb-community-cli` (Recommended). For information on the commands that exist, run `npx exb help`, and commands, arguments, and descriptions will be listed.
 
-Additionally, this CLI makes it easy to get up and running with Experience Builder, requiring a single command to install and run Experience Builder Developer Edition, making it easier than ever to get started. Just install the CLI globally `npm-i -g exb-community-cli` and then run `exb-cli dev-setup`. The tool will give you a few prompts to get started, and you'll end up with a fully functional install.
+Additionally, this CLI makes it easy to get up and running with Experience Builder, requiring a single command to install and run Experience Builder Developer Edition, making it easier than ever to get started. Just install the CLI globally `npm install -g exb-community-cli` and then run `exb dev-setup`. The tool will give you a few prompts to get started, and you'll end up with a fully functional install.
 
 When using any of the ExB Community CLI commands, the command needs to be run in the client directory of your Experience builder application (excluding dev-setup). If you don't, you will get the error `Error: Run this from the ExB client folder.`.
 
@@ -25,4 +25,4 @@ To prepare your widget to be easily ingested by the ExB Community CLI, there are
 
 If you're like me, you probably don't want to re-publish your widget manually on NPM every time that you have an update. That'd be a pain right? Well, as long as you're using GitHub, I have a solution for you. _**GitHub Actions**_. You can use GitHub Actions to automate deployment to NPM using a fairly simple process, outlined in this [Esri Community Post](TBD).
 
-If you are using automated deployment YAML for your Experience Builder installs, you might also want to make sure that the widgets you're using come along for the ride. This CLI has that in mind! To inline install a widget into your build pipeline, use `npx exb-community-cli i widgetname`. This will install the widget into your project. If you want to ensure that you always use the same version of the widget, simply add the version suffix ex `@1.5.3`.
+If you are using automated deployment YAML for your Experience Builder installs, you might also want to make sure that the widgets you're using come along for the ride. This CLI has that in mind! To inline install a widget into your build pipeline, use `npx exb-community-cli install widgetname`. This will install the widget into your project. If you want to ensure that you always use the same version of the widget, simply add the version suffix ex `@1.5.3`.

package/dist/commands/dev-setup.js

@@ -1,4 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -46,9 +79,10 @@ async function devSetup(options) {
     }
     const clientDir = path_1.default.join(process.cwd(), `arcgis-experience-builder-${version}`, "client");
     const serverDir = path_1.default.join(process.cwd(), `arcgis-experience-builder-${version}`, "server");
-    console.log("Starting development servers in new terminal windows...");
-    openInNewTerminal(clientDir, "client");
-    openInNewTerminal(serverDir, "server");
+    console.log("Starting client and server development servers...");
+    // Start dev servers using util
+    const { startDevServer } = await Promise.resolve().then(() => __importStar(require("../utils/startDevServer")));
+    startDevServer(clientDir, serverDir);
 }
 const ciWithSpinner = (message, cwd) => {
     const spinnerFrames = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
@@ -77,64 +111,7 @@ const ciWithSpinner = (message, cwd) => {
         });
     });
 };
-const openInNewTerminal = (cwd, label) => {
-    const cmd = `cd "${cwd}" && npm start`;
-    if (process.platform === "darwin") {
-        const script = `tell application "Terminal"\nactivate\ndo script "${cmd.replace(/"/g, '\\"')}"\nend tell`;
-        (0, child_process_1.spawn)("osascript", ["-e", script], {
-            stdio: "ignore",
-            detached: true
-        }).unref();
-    }
-    else if (process.platform === "win32") {
-        (0, child_process_1.spawn)("cmd.exe", ["/c", "start", "cmd.exe", "/k", cmd], {
-            cwd,
-            stdio: "ignore",
-            detached: true,
-            shell: true
-        }).unref();
-    }
-    else {
-        // Linux: try common terminal emulators in order
-        const terminals = [
-            {
-                bin: "x-terminal-emulator",
-                args: ["-e", `bash -c '${cmd}; exec bash'`]
-            },
-            {
-                bin: "gnome-terminal",
-                args: ["--", "bash", "-c", `${cmd}; exec bash`]
-            },
-            { bin: "konsole", args: ["-e", "bash", "-c", `${cmd}; exec bash`] },
-            {
-                bin: "xfce4-terminal",
-                args: ["-e", `bash -c '${cmd}; exec bash'`]
-            },
-            { bin: "xterm", args: ["-e", `bash -c '${cmd}; exec bash'`] }
-        ];
-        let launched = false;
-        for (const t of terminals) {
-            try {
-                (0, child_process_1.execSync)(`which ${t.bin}`, { stdio: "pipe" });
-                (0, child_process_1.spawn)(t.bin, t.args, {
-                    cwd,
-                    stdio: "ignore",
-                    detached: true
-                }).unref();
-                launched = true;
-                break;
-            }
-            catch {
-                // not found, try next
-            }
-        }
-        if (!launched) {
-            console.log(`  ⚠ No supported terminal found. Run manually: cd "${cwd}" && npm start`);
-            return;
-        }
-    }
-    console.log(`  ✔ Opened ${label} in a new terminal window.`);
-};
+// ...existing code...
 const installExperienceBuilder = async (version) => {
     const url = `https://downloads.arcgis.com/dms/rest/download/secured/arcgis-experience-builder-${version}.zip?f=json&folder=software%2FExperienceBuilder%2F${version}`;
     const res = await fetch(url);

package/dist/commands/start.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = start;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const startDevServer_1 = require("../utils/startDevServer");
+function start() {
+    const clientDir = process.cwd();
+    const serverDir = path_1.default.join(process.cwd(), "..", "server");
+    if (!fs_extra_1.default.existsSync(path_1.default.join(clientDir, "your-extensions"))) {
+        console.error("Error: Run this from the ExB client folder.");
+        return;
+    }
+    (0, startDevServer_1.startDevServer)(clientDir, serverDir);
+}

package/dist/index.js

@@ -43,22 +43,23 @@ const search_1 = require("./commands/search");
 const remove_1 = require("./commands/remove");
 const format_1 = require("./commands/format");
 const scaffold_1 = require("./commands/scaffold");
+const dev_setup_1 = require("./commands/dev-setup");
+const start_1 = require("./commands/start");
 const fs = __importStar(require("fs-extra"));
 const path = __importStar(require("path"));
-const dev_setup_1 = require("./commands/dev-setup");
 const packageJsonPath = path.join(__dirname, "../package.json");
 const packageJson = fs.readJsonSync(packageJsonPath, { throws: false }) || {
     version: "1.0.0"
 };
 const program = new commander_1.Command();
 program
-    .name("exb-cli")
-    .description("The community-led widget manager for ArcGIS Experience Builder")
+    .name("exb")
+    .description("The community-led widget manager for ArcGIS Experience Builder.")
     .version(packageJson.version);
 // --- COMMAND: INSTALL ---
 program
     .command("install <package>")
-    .alias("i") // Allows users to type `exb-cli i widget-name`
+    .alias("i") // Allows users to type `exb i widget-name`
     .description("Install a widget from NPM into your Experience Builder project")
     .option("--widget-only", "Skip running npm ci in the installed widget directory")
     .action(async (pkg, options) => {
@@ -67,7 +68,6 @@ program
 // --- COMMAND: UPDATE ---
 program
     .command("update <package>")
-    .alias("u")
     .description("Update an installed widget to the latest version (or a specified version)")
     .option("--widget-only", "Skip running npm ci in the updated widget directory")
     .option("--version <version>", "Specify a version or dist-tag to update to")
@@ -80,7 +80,6 @@ program
 // --- COMMAND: REMOVE ---
 program
     .command("remove <package>")
-    .alias("rm")
     .description("Remove an installed widget from your Experience Builder project")
     .option("-f, --force", "Skip confirmation prompt")
     .action(async (pkg, options) => {
@@ -89,7 +88,6 @@ program
 // --- COMMAND: SEARCH ---
 program
     .command("search")
-    .alias("s")
     .description("Search npm for Experience Builder widgets (by keyword)")
     .option("-k, --keyword <keyword>", "Additional keyword to include in search")
     .option("-n, --size <size>", "Maximum number of npm results to fetch (default: 15)")
@@ -105,7 +103,6 @@ program
 // --- COMMAND: FORMAT ---
 program
     .command("format <widget>")
-    .alias("fmt")
     .description("Format a widget package according to community standards, based on the manifest.json configuration.")
     .option("-f, --force", "Skip prompts and overwrite package.json if present")
     .action(async (widget, options) => {
@@ -114,7 +111,6 @@ program
 // --- COMMAND: SCAFFOLD ---
 program
     .command("scaffold <name>")
-    .alias("new")
     .description("Scaffold a new widget package with a manifest.json, using an esri template")
     .action(async (name, options) => {
     await (0, scaffold_1.scaffoldWidget)(name);
@@ -129,6 +125,10 @@ program
     (0, dev_setup_1.devSetup)({ version });
     //await scaffoldWidget('dev-environment', { version });
 });
+program
+    .command("start")
+    .description("Start the client and server development servers for the current Experience Builder Developer Edition environment")
+    .action(start_1.start);
 // Parse the arguments passed by the user in the terminal
 program.parse(process.argv);
 // If the user runs the CLI with no arguments, show the help menu

package/dist/utils/startDevServer.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startDevServer = startDevServer;
+const child_process_1 = require("child_process");
+function startDevServer(clientDir, serverDir) {
+    console.log("Starting client and server development servers...");
+    // Save terminal settings before spawning child processes (Unix/macOS only)
+    let savedTermSettings = null;
+    if (process.platform !== "win32" && process.stdin.isTTY) {
+        try {
+            savedTermSettings = (0, child_process_1.execSync)("stty -g", {
+                stdio: ["inherit", "pipe", "pipe"]
+            })
+                .toString()
+                .trim();
+        }
+        catch { }
+    }
+    const restoreTerminal = () => {
+        if (savedTermSettings) {
+            try {
+                (0, child_process_1.execSync)(`stty ${savedTermSettings}`, { stdio: "inherit" });
+            }
+            catch { }
+        }
+    };
+    const serverProc = (0, child_process_1.spawn)("npm", ["start"], {
+        cwd: serverDir,
+        stdio: "ignore",
+        detached: true
+    });
+    serverProc.unref();
+    const clientProc = (0, child_process_1.spawn)("npm", ["start"], {
+        cwd: clientDir,
+        stdio: "inherit"
+    });
+    let isShuttingDown = false;
+    const shutdown = () => {
+        if (isShuttingDown)
+            return;
+        isShuttingDown = true;
+        if (serverProc && !serverProc.killed && serverProc.pid) {
+            try {
+                process.kill(-serverProc.pid);
+            }
+            catch { }
+        }
+        if (clientProc && !clientProc.killed) {
+            try {
+                clientProc.kill();
+            }
+            catch { }
+        }
+        restoreTerminal();
+        process.exit();
+    };
+    process.on("SIGINT", shutdown);
+    process.on("SIGTERM", shutdown);
+    clientProc.on("exit", shutdown);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "exb-community-cli",
-  "version": "1.0.2",
-  "description": "A lightweight command line interface to allow Experience Builder developers to quickly import widgets published as NPM pacakges.",
+  "version": "1.0.3",
+  "description": "A lightweight command line interface to allow Experience Builder developers to quickly import widgets published as NPM pacakges. Developed by the Esri Community.",
   "keywords": [
     "exb-community",
     "cli",
@@ -9,7 +9,11 @@
     "widget"
   ],
   "bin": {
-    "exb-cli": "dist/index.js"
+    "exb": "dist/index.js"
+  },
+  "homepage": "https://github.com/SunshineLuke90/exb-community-cli#readme",
+  "bugs": {
+    "url": "https://github.com/SunshineLuke90/exb-community-cli/issues"
   },
   "preferGlobal": true,
   "license": "MIT",
@@ -41,5 +45,9 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.1.0",
     "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SunshineLuke90/exb-community-cli.git"
   }
 }