@elmohq/cli 0.2.3 → 0.2.4

package/README.md

@@ -0,0 +1,89 @@
+<p align="center">
+  <a href="https://github.com/elmohq/elmo">
+    <img src="https://raw.githubusercontent.com/elmohq/elmo/main/apps/www/public/brand/logos/elmo-logo-xl.png" alt="Elmo" width="300">
+  </a>
+</p>
+
+<p align="center">
+  The official CLI for <a href="https://www.elmohq.com/">Elmo</a> — open source AI visibility tracking and optimization.
+  <br />
+  <br />
+  <a href="https://www.elmohq.com/docs"><strong>Read the docs »</strong></a>
+</p>
+
+<br />
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@elmohq/cli"><img src="https://img.shields.io/npm/v/@elmohq/cli?color=2563eb&label=npm" alt="npm version"></a>&nbsp;
+  <a href="https://www.elmohq.com/docs"><img src="https://img.shields.io/badge/Docs-2563eb?style=flat&logo=readthedocs&logoColor=white" alt="Docs"></a>&nbsp;
+  <a href="https://github.com/elmohq/elmo"><img src="https://img.shields.io/github/stars/elmohq/elmo?style=flat&logo=github&color=ee964b&label=Star" alt="GitHub stars"></a>&nbsp;
+  <a href="https://discord.gg/s24nubCtKz"><img src="https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white" alt="Discord"></a>
+</p>
+
+<br />
+
+## What is Elmo?
+
+[Elmo](https://www.elmohq.com/) is an open source platform for tracking and optimizing how your brand shows up in AI assistants like ChatGPT, Claude, Gemini, and Perplexity. Define the prompts your customers ask, run them across providers on a schedule, and get visibility into mentions, sentiment, citations, and competitor positioning over time.
+
+`@elmohq/cli` is the fastest way to run Elmo on your own infrastructure. It generates a Docker Compose stack, manages secrets and configuration, and gives you a single command to start, stop, and operate your instance.
+
+## Installation
+
+```bash
+npm install -g @elmohq/cli
+```
+
+Requires [Docker](https://docs.docker.com/get-docker/) and Docker Compose.
+
+## Quick Start
+
+```bash
+# 1. Walk through the interactive setup wizard
+elmo init
+
+# 2. Start the stack
+elmo start
+
+# 3. Open the app at http://localhost:1515
+```
+
+`elmo init` will prompt you for a few things (database, AI provider credentials), generate `elmo.yaml` and `.env`, and optionally start the stack for you.
+
+For the full self-hosting walkthrough, see the [Elmo docs](https://www.elmohq.com/docs).
+
+## Commands
+
+| Command | Description |
+| --- | --- |
+| `elmo init` | Interactive wizard to set up a local Elmo instance |
+| `elmo start` | Start the Elmo stack |
+| `elmo stop` | Stop the Elmo stack |
+| `elmo status` | Check the health of running services |
+| `elmo logs [service]` | Tail container logs (pass `-f` to follow) |
+| `elmo regen` | Regenerate `elmo.yaml` / `.env` from your saved config |
+| `elmo compose <args...>` | Run any `docker compose` command against your Elmo project |
+| `elmo build` | Build Docker images locally (for `--dev` installs) |
+
+Run `elmo --help` or `elmo <command> --help` for the full list of flags.
+
+### Useful flags
+
+- `--dir <path>` — point any command at a specific config directory (defaults to `~/.config/elmo`).
+- `elmo init --dev` — build images from a local checkout of the repo instead of pulling from the registry.
+
+## Telemetry
+
+The CLI sends anonymous install and command events so we can understand which flows people use and where setup breaks. To opt out, set:
+
+```bash
+export DISABLE_TELEMETRY=1
+```
+
+## Star, contribute, and chat
+
+Elmo is built in the open and we'd love your help.
+
+- ⭐ **[Star us on GitHub](https://github.com/elmohq/elmo)** — it genuinely helps more people find the project.
+- 💬 **[Join the Discord](https://discord.gg/s24nubCtKz)** — get help, share what you're building, and talk to the team.
+- 🐛 **[File an issue](https://github.com/elmohq/elmo/issues)** if something breaks or you have a feature request.

package/dist/index.js

@@ -1,20 +1,18 @@
 #!/usr/bin/env node
-import { Command } from "commander";
-import pc from "picocolors";
-import * as p from "@clack/prompts";
 import { spawn, spawnSync } from "node:child_process";
+import crypto from "node:crypto";
 import fs from "node:fs/promises";
-import path from "node:path";
 import os from "node:os";
-import crypto from "node:crypto";
-import semver from "semver";
+import path from "node:path";
 import { fileURLToPath } from "node:url";
+import * as p from "@clack/prompts";
+import { Command } from "commander";
+import pc from "picocolors";
+import semver from "semver";
 import { trackCliEvent } from "./telemetry.js";
 // ── Constants ────────────────────────────────────────────────────────────────
 const CONFIG_HOME = path.join(os.homedir(), ".config", "elmo");
 const CONFIG_FILE = path.join(CONFIG_HOME, "config.json");
-const DEFAULT_ORG_ID = "default";
-const DEFAULT_ORG_NAME = "Default Organization";
 const DEFAULT_APP_NAME = "Elmo";
 const DEFAULT_APP_ICON = "/icons/elmo-icon.svg";
 const DEFAULT_APP_URL = "http://localhost:1515";
@@ -220,8 +218,6 @@ async function runInit(options, version) {
     env.DEPLOYMENT_MODE = "local";
     env.VITE_DEPLOYMENT_MODE = "local";
     env.BETTER_AUTH_SECRET = generateSecret();
-    env.DEFAULT_ORG_ID = DEFAULT_ORG_ID;
-    env.DEFAULT_ORG_NAME = DEFAULT_ORG_NAME;
     env.APP_NAME = DEFAULT_APP_NAME;
     env.APP_ICON = DEFAULT_APP_ICON;
     env.APP_URL = DEFAULT_APP_URL;
@@ -302,14 +298,7 @@ const BRIGHTDATA_AFFILIATE = "https://get.brightdata.com/67h1b7h0shcn";
 const OLOSTEP_AFFILIATE = "https://olostep.com/?ref=elmo";
 const PROVIDERS_DOC_URL = "https://docs.elmohq.com/docs/deployment/providers";
 // Surfaces each scraper can track — the first two are the "recommended starter" set.
-const BRIGHTDATA_MODELS = [
-    "chatgpt",
-    "google-ai-mode",
-    "perplexity",
-    "copilot",
-    "gemini",
-    "grok",
-];
+const BRIGHTDATA_MODELS = ["chatgpt", "google-ai-mode", "perplexity", "copilot", "gemini", "grok"];
 const OLOSTEP_MODELS = [
     "chatgpt",
     "google-ai-mode",
@@ -813,8 +802,7 @@ function buildWebService(options) {
     if (options.dependsOn.length > 0) {
         lines.push("  depends_on:");
         for (const service of options.dependsOn) {
-            const condition = options.dependencyConditions[service] ??
-                "service_started";
+            const condition = options.dependencyConditions[service] ?? "service_started";
             lines.push(`    ${service}:`, `      condition: ${condition}`);
         }
     }
@@ -832,8 +820,7 @@ function buildWorkerService(options) {
     if (options.dependsOn.length > 0) {
         lines.push("  depends_on:");
         for (const service of options.dependsOn) {
-            const condition = options.dependencyConditions[service] ??
-                "service_started";
+            const condition = options.dependencyConditions[service] ?? "service_started";
             lines.push(`    ${service}:`, `      condition: ${condition}`);
         }
     }
@@ -848,11 +835,7 @@ function indentBlock(block, spaces) {
 }
 // ── Docker Helpers ───────────────────────────────────────────────────────────
 async function getComposeServices(configDir) {
-    const output = await runDockerComposeCapture(configDir, [
-        "ps",
-        "--format",
-        "json",
-    ]);
+    const output = await runDockerComposeCapture(configDir, ["ps", "--format", "json"]);
     if (!output.trim()) {
         return [];
     }
@@ -889,8 +872,7 @@ function formatServiceStatus(service) {
     if (isServiceReady(service)) {
         color = pc.green;
     }
-    else if (health === "starting" ||
-        state.includes("starting")) {
+    else if (health === "starting" || state.includes("starting")) {
         color = pc.yellow;
     }
     return color(`${label} ${state} ${service.Health ? `(${health})` : ""}`.trim());
@@ -908,8 +890,7 @@ async function waitForHealthy(configDir, timeoutMs) {
     const start = Date.now();
     while (Date.now() - start < timeoutMs) {
         const services = await getComposeServices(configDir);
-        if (services.length > 0 &&
-            services.every(isServiceReady)) {
+        if (services.length > 0 && services.every(isServiceReady)) {
             return true;
         }
         await sleep(3000);
@@ -922,12 +903,7 @@ function sleep(ms) {
 function runDockerCompose(configDir, args) {
     return new Promise((resolve, reject) => {
         const composeFile = path.join(configDir, "elmo.yaml");
-        const commandArgs = [
-            "compose",
-            "-f",
-            composeFile,
-            ...args,
-        ];
+        const commandArgs = ["compose", "-f", composeFile, ...args];
         const child = spawn("docker", commandArgs, {
             stdio: "inherit",
         });
@@ -944,12 +920,7 @@ function runDockerCompose(configDir, args) {
 function runDockerComposeCapture(configDir, args) {
     return new Promise((resolve, reject) => {
         const composeFile = path.join(configDir, "elmo.yaml");
-        const commandArgs = [
-            "compose",
-            "-f",
-            composeFile,
-            ...args,
-        ];
+        const commandArgs = ["compose", "-f", composeFile, ...args];
         const child = spawn("docker", commandArgs);
         let stdout = "";
         let stderr = "";
@@ -964,8 +935,7 @@ function runDockerComposeCapture(configDir, args) {
                 resolve(stdout);
             }
             else {
-                reject(new Error(stderr ||
-                    `docker compose exited with code ${code}`));
+                reject(new Error(stderr || `docker compose exited with code ${code}`));
             }
         });
     });
@@ -982,11 +952,7 @@ function assertDockerRunning() {
 async function resolveDockerDirInteractive(cwd) {
     const inCwd = await fileExists(path.join(cwd, "Dockerfile"));
     const inDockerDir = await fileExists(path.join(cwd, "docker", "Dockerfile"));
-    const defaultDir = inCwd
-        ? "."
-        : inDockerDir
-            ? "docker"
-            : ".";
+    const defaultDir = inCwd ? "." : inDockerDir ? "docker" : ".";
     const dir = await p.text({
         message: "Path to docker directory (contains Dockerfile)",
         defaultValue: defaultDir,
@@ -1063,11 +1029,7 @@ async function writeConfigFiles(configDir, initConfig) {
     await fs.writeFile(composePath, initConfig.composeYaml, "utf8");
 }
 function buildEnvFile(env) {
-    const lines = [
-        "# Generated by elmo init",
-        "# WARNING: contains secrets. Do not commit.",
-        "",
-    ];
+    const lines = ["# Generated by elmo init", "# WARNING: contains secrets. Do not commit.", ""];
     for (const [key, rawValue] of Object.entries(env)) {
         if (rawValue === undefined) {
             continue;
@@ -1081,9 +1043,7 @@ function formatEnvValue(value) {
         return '""';
     }
     if (/[\s#"']/u.test(value)) {
-        const escaped = value
-            .replace(/\\/g, "\\\\")
-            .replace(/"/g, '\\"');
+        const escaped = value.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
         return `"${escaped}"`;
     }
     return value;
@@ -1091,9 +1051,7 @@ function formatEnvValue(value) {
 async function detectSettingsFromConfig(configDir) {
     const envPath = path.join(configDir, ".env");
     const env = await readEnvFile(envPath);
-    const postgresMode = env.DATABASE_URL?.includes("postgres:5432")
-        ? "docker"
-        : "external";
+    const postgresMode = env.DATABASE_URL?.includes("postgres:5432") ? "docker" : "external";
     const yamlPath = path.join(configDir, "elmo.yaml");
     let dev = false;
     let repoRoot = process.cwd();
@@ -1124,8 +1082,7 @@ async function readEnvFile(envPath) {
             const key = trimmed.substring(0, eqIndex);
             let value = trimmed.substring(eqIndex + 1);
             // Remove surrounding quotes
-            if ((value.startsWith('"') && value.endsWith('"')) ||
-                (value.startsWith("'") && value.endsWith("'"))) {
+            if ((value.startsWith('"') && value.endsWith('"')) || (value.startsWith("'") && value.endsWith("'"))) {
                 value = value.slice(1, -1);
             }
             env[key] = value;
@@ -1166,8 +1123,7 @@ async function maybeNotifyNewVersion(currentVersion) {
         if (!data.version) {
             return;
         }
-        if (semver.valid(currentVersion) &&
-            semver.lt(currentVersion, data.version)) {
+        if (semver.valid(currentVersion) && semver.lt(currentVersion, data.version)) {
             log.warn(`New CLI version available (${data.version}). Run: npm install -g @elmohq/cli@latest`);
         }
     }

package/package.json

@@ -1,6 +1,23 @@
 {
   "name": "@elmohq/cli",
-  "version": "0.2.3",
+  "version": "0.2.4",
+  "keywords": [
+    "marketing",
+    "typescript",
+    "tools",
+    "aio",
+    "seo",
+    "geo",
+    "gemini",
+    "copilot",
+    "grok",
+    "aso",
+    "perplexity",
+    "aeo",
+    "llmo",
+    "chatgpt",
+    "ai-visibility"
+  ],
   "bin": {
     "elmo": "dist/index.js"
   },