@dataramen/cli 0.0.7 → 0.0.9

package/README.md

@@ -0,0 +1,67 @@
+# 🍜 Data Ramen CLI
+
+**Your cozy corner for exploring and working with SQL databases — no query writing required (unless you want to).**
+
+Data Ramen CLI lets you launch a powerful, local database exploration app that connects effortlessly to MySQL and PostgreSQL databases. Browse schemas, follow relationships, insert data, and even write raw SQL — all from your browser.
+
+## ✨ Features
+
+- 🔌 **Connect to PostgreSQL & MySQL**  
+  Securely plug in your credentials — you're ready to explore.
+
+- 🧭 **Visual Schema Explorer**  
+  Instantly browse tables, columns, types, primary/foreign keys, and relationships.
+
+- 🧙 **No-SQL Querying**  
+  Filter, sort, join, and summarize data using a beautiful, intuitive interface.
+
+- 🔗 **Follow Relationships Easily**  
+  Click to expand related records like nested tables.
+
+- ✏️ **Insert & Update Visually**  
+  Add or modify rows with a visual editor — no SQL errors.
+
+- 💾 **Save Queries**  
+  Save your favorite views for quick access later.
+
+- ⌨️ **Raw SQL Mode Available**  
+  Prefer typing? Drop into SQL mode anytime and run your own queries.
+
+## 🛠️ Installation
+
+### 1. Install Node.js
+
+Data Ramen requires Node.js **v22 or above**.  
+👉 [Download Node.js](https://nodejs.org/)
+
+### 2. Install Data Ramen CLI
+
+Open your terminal and run:
+
+```bash
+npm i -g @dataramen/cli
+```
+
+## 🖥️ Usage
+
+### Start the Local Server
+
+```bash
+dataramen start
+```
+
+### Open the App
+
+Go to https://app.dataramen.xyz in your browser. Your local server will connect automatically.
+
+## 🔧 Additional CLI Commands
+
+| Command           | Description                       |
+| ----------------- | --------------------------------- |
+| `dataramen start` | Start the local Data Ramen server |
+| `dataramen stop`  | Stop the local server             |
+| `dataramen logs`  | Show logs from the running server |
+
+## ❤️ Made with love by [Oleksandr Demian](https://github.com/OleksandrDemian)
+
+Visit [dataramen.xyz](https://dataramen.xyz) for more info.

package/bin/run.js

@@ -11,7 +11,9 @@ const processName = "@dataramen/local-server";
 const homeDir = os.homedir();
 const filesPath = path.join(homeDir, ".dataramen", ".runtime", "server");
 
-const scriptPkg = fs.readJsonSync(path.join(__dirname, "..", "package.json"));
+const scriptPkg = useJson(path.join(__dirname, "..", "package.json"));
+const serverPkg = useJson(path.join(filesPath, "package.json"));
+
 const protocol = "dataramen://";
 
 yargs()
@@ -23,7 +25,7 @@ yargs()
 
     start();
   })
-  .command("logs", 'Listen for logs', () => {
+  .command(["logs"], 'Listen for logs', () => {
     execSync(`pm2 logs ${processName}`, {
       stdio: "inherit",
     });
@@ -38,10 +40,25 @@ yargs()
       require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).unregister();
     }
   })
+  .command(["version"], 'Show version', () => {
+    console.log(`Data ramen CLI version:          ${scriptPkg().version}`);
+    console.log(`Data ramen local server version: ${serverPkg().version}`);
+  })
   .parse(isBrowserStart() ? getBrowserArgs() : yargsHelpers.hideBin(process.argv));
 
-function isInstallation () {
-  return scriptPkg.name === "@dataramen/cli";
+function shouldInstall () {
+  try {
+    const installedProxyPkjJson = serverPkg();
+
+    if (!installedProxyPkjJson) {
+      return true;
+    }
+
+    const thisProxyPkgJson = fs.readJsonSync(path.join(__dirname, '..', 'dist', "package.json"));
+    return installedProxyPkjJson.version !== thisProxyPkgJson.version; // version are different, install new code
+  } catch (e) {
+    return true;
+  }
 }
 
 function isBrowserStart () {
@@ -80,17 +97,17 @@ function stopExisting () {
   } catch (e) {}
 }
 
-function registerServer () {
-  try {
-    if (os.platform() === "win32") {
-      require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).register();
-    }
-
-    console.log("Custom protocol handler registered");
-  } catch (e) {
-    console.log("Failed to register server", e);
-  }
-}
+// function registerServer () {
+//   try {
+//     if (os.platform() === "win32") {
+//       require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).register();
+//     }
+//
+//     console.log("Custom protocol handler registered");
+//   } catch (e) {
+//     console.log("Failed to register server", e);
+//   }
+// }
 
 function installServer () {
   console.log("Installing Server");
@@ -107,16 +124,14 @@ function installServer () {
   });
   console.log("Server installed");
 
-  registerServer();
+  // registerServer();
 }
 
 function start () {
   stopExisting();
 
   try {
-    if (isInstallation()) {
-      // only install if script is running from @dataramen/cli package
-      // if not, it means it was already installed, and the script is running from within the server folder
+    if (shouldInstall()) {
       installServer();
     }
 
@@ -129,7 +144,26 @@ function start () {
 
     console.log(`Local server will be available in a couple of seconds`);
     console.log(`You can close this window`);
+    console.log(`Visit https://app.dataramen.xyz`);
   } catch (e) {
     console.error(`Failed to start local server`, e);
   }
 }
+
+function useJson (path) {
+  let file = undefined;
+
+  function get () {
+    try {
+      if (!file) {
+        file = fs.readJsonSync(path);
+      }
+
+      return file;
+    } catch (e) {
+      return undefined;
+    }
+  }
+
+  return get;
+}

package/dist/code/cli.js

@@ -11,7 +11,9 @@ const processName = "@dataramen/local-server";
 const homeDir = os.homedir();
 const filesPath = path.join(homeDir, ".dataramen", ".runtime", "server");
 
-const scriptPkg = fs.readJsonSync(path.join(__dirname, "..", "package.json"));
+const scriptPkg = useJson(path.join(__dirname, "..", "package.json"));
+const serverPkg = useJson(path.join(filesPath, "package.json"));
+
 const protocol = "dataramen://";
 
 yargs()
@@ -23,7 +25,7 @@ yargs()
 
     start();
   })
-  .command("logs", 'Listen for logs', () => {
+  .command(["logs"], 'Listen for logs', () => {
     execSync(`pm2 logs ${processName}`, {
       stdio: "inherit",
     });
@@ -38,10 +40,25 @@ yargs()
       require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).unregister();
     }
   })
+  .command(["version"], 'Show version', () => {
+    console.log(`Data ramen CLI version:          ${scriptPkg().version}`);
+    console.log(`Data ramen local server version: ${serverPkg().version}`);
+  })
   .parse(isBrowserStart() ? getBrowserArgs() : yargsHelpers.hideBin(process.argv));
 
-function isInstallation () {
-  return scriptPkg.name === "@dataramen/cli";
+function shouldInstall () {
+  try {
+    const installedProxyPkjJson = serverPkg();
+
+    if (!installedProxyPkjJson) {
+      return true;
+    }
+
+    const thisProxyPkgJson = fs.readJsonSync(path.join(__dirname, '..', 'dist', "package.json"));
+    return installedProxyPkjJson.version !== thisProxyPkgJson.version; // version are different, install new code
+  } catch (e) {
+    return true;
+  }
 }
 
 function isBrowserStart () {
@@ -80,17 +97,17 @@ function stopExisting () {
   } catch (e) {}
 }
 
-function registerServer () {
-  try {
-    if (os.platform() === "win32") {
-      require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).register();
-    }
-
-    console.log("Custom protocol handler registered");
-  } catch (e) {
-    console.log("Failed to register server", e);
-  }
-}
+// function registerServer () {
+//   try {
+//     if (os.platform() === "win32") {
+//       require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).register();
+//     }
+//
+//     console.log("Custom protocol handler registered");
+//   } catch (e) {
+//     console.log("Failed to register server", e);
+//   }
+// }
 
 function installServer () {
   console.log("Installing Server");
@@ -107,16 +124,14 @@ function installServer () {
   });
   console.log("Server installed");
 
-  registerServer();
+  // registerServer();
 }
 
 function start () {
   stopExisting();
 
   try {
-    if (isInstallation()) {
-      // only install if script is running from @dataramen/cli package
-      // if not, it means it was already installed, and the script is running from within the server folder
+    if (shouldInstall()) {
       installServer();
     }
 
@@ -129,7 +144,26 @@ function start () {
 
     console.log(`Local server will be available in a couple of seconds`);
     console.log(`You can close this window`);
+    console.log(`Visit https://app.dataramen.xyz`);
   } catch (e) {
     console.error(`Failed to start local server`, e);
   }
 }
+
+function useJson (path) {
+  let file = undefined;
+
+  function get () {
+    try {
+      if (!file) {
+        file = fs.readJsonSync(path);
+      }
+
+      return file;
+    } catch (e) {
+      return undefined;
+    }
+  }
+
+  return get;
+}

package/dist/package.json

@@ -1 +1 @@
-{"name":"@dataramen/local-server","version":"0.0.33","license":"MIT","main":"code/proxy.js","dependencies":{"@fastify/cors":"^11.0.1","dotenv":"^16.5.0","fast-glob":"^3.3.3","fastify":"^5.3.2","mysql2":"^3.14.1","pg":"^8.15.6","sqlite3":"^5.1.7","typeorm":"^0.3.23"},"devDependencies":{"yargs":"^18.0.0","fs-extra":"^11.3.0"}}
+{"name":"@dataramen/local-server","version":"0.0.34","license":"MIT","main":"code/proxy.js","dependencies":{"@fastify/cors":"^11.0.1","dotenv":"^16.5.0","fast-glob":"^3.3.3","fastify":"^5.3.2","mysql2":"^3.14.1","pg":"^8.15.6","sqlite3":"^5.1.7","typeorm":"^0.3.23"},"devDependencies":{"fs-extra":"^11.3.0","yargs":"^18.0.0"}}

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@dataramen/cli",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "license": "MIT",
   "bin": {
-    "dataramen-cli": "bin/run.js"
+    "dataramen": "bin/run.js"
   },
   "scripts": {
     "build": "node build.js"
   },
   "dependencies": {
-    "yargs": "^18.0.0",
-    "fs-extra": "^11.3.0"
+    "fs-extra": "^11.3.0",
+    "yargs": "^18.0.0"
   },
   "files": [
     "dist/"