gingee-cli 1.0.0

package/index.js

@@ -0,0 +1,154 @@
+#!/usr/bin/env node
+
+const { Command } = require('commander');
+const { init } = require('./commands/init');
+const { addApp } = require('./commands/addApp');
+const { addScript } = require('./commands/addScript');
+
+const { resetPwd } = require('./commands/resetPwd');
+const { resetGlade } = require('./commands/resetGlade');
+
+const serviceCommands = require('./commands/service');
+
+const { login } = require('./commands/login');
+const { logout } = require('./commands/logout');
+const { listApps } = require('./commands/listApps');
+const { installApp } = require('./commands/installApp');
+const { upgradeApp } = require('./commands/upgradeApp');
+const { deleteApp } = require('./commands/deleteApp');
+const { rollbackApp } = require('./commands/rollbackApp');
+const { packageApp } = require('./commands/packageApp');
+const { listBackups } = require('./commands/listBackups');
+
+const { listStoreApps } = require('./commands/listStoreApps');
+const { installStoreApp } = require('./commands/installStoreApp');
+const { upgradeStoreApp } = require('./commands/upgradeStoreApp');
+
+const packageJson = require('./package.json'); // For version number
+const program = new Command();
+
+program
+    .name('gingee-cli')
+    .description('The official command-line interface for the Gingee platform.')
+    .version(packageJson.version);
+
+// Local scaffolding commands
+program
+    .command('init <project-name>')
+    .description('Scaffold a new Gingee project in a new directory.')
+    .action(init);
+
+program
+    .command('add-app <app-name>')
+    .description('Scaffold a new, interactive app inside the current project.')
+    .action(addApp);
+
+program
+    .command('add-script <app-name> <script-path>')
+    .description("Create a new server script with boilerplate. Path format: '<app-name>/box/<script-path>'")
+    .action(addScript);
+
+
+// Utility and recovery commands
+program
+    .command('reset-pwd')
+    .description("Reset the Gingee - Glade admin password by directly updating its config file.")
+    .action(resetPwd);
+
+program
+    .command('reset-glade')
+    .description("Reset the Gingee - Glade admin app to a clean, default installation.")
+    .action(resetGlade);
+
+// Service management commands
+
+const serviceCmd = program.command('service')
+    .description('Manage the Gingee server as a native background service (requires admin/sudo).');
+
+serviceCmd.command('install').description('Install and start Gingee as a background service.').action(serviceCommands.install);
+serviceCmd.command('uninstall').description('Stop and remove the Gingee background service.').action(serviceCommands.uninstall);
+serviceCmd.command('start').description('Start the Gingee background service.').action(serviceCommands.start);
+serviceCmd.command('stop').description('Stop the Gingee background service.').action(serviceCommands.stop);
+
+
+// Server Administration Commands
+program.command('login').description('Authenticate with a Gingee Glade instance. Defaults to http://localhost:7070')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .requiredOption('-u, --username <username>', 'Username for authentication', 'admin')
+    .option('-p, --password <password>', 'Password for authentication')
+    .action(login);
+
+program.command('logout').description('Log out of the current Gingee Glade session. Defaults to http://localhost:7070')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .action(logout);
+
+program.command('list-apps').description('List all applications on the running Gingee server. Defaults to http://localhost:7070')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .action(listApps);
+
+program.command('install-app')
+    .description('Interactively install a new application from a local .gin package.')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .requiredOption('-a, --appName <app-name>', 'The name for the application to be installed.')
+    .requiredOption('-p, --ginPath <path-to-gin-file>', 'The path to the local app package (.gin) file.')
+    .option('-f, --file <path-to-preset-file>', 'Use a preset file for non-interactive installation.')
+    .action(installApp);
+
+program.command('upgrade-app')
+    .description('Upgrade an existing application from a .gin package.')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .requiredOption('-a, --appName <app-name>', 'The name of the application to upgrade.')
+    .requiredOption('-p, --ginPath <path-to-gin-file>', 'The path to the app package (.gin) file.')
+    .option('-f, --file <path-to-preset-file>', 'Use a preset file for non-interactive upgrade.')
+    .action(upgradeApp);
+
+program.command('delete-app')
+    .description('Permanently delete an application from the server.')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .requiredOption('-a, --appName <app-name>', 'The name of the application to delete.')
+    .option('-f, --file <path-to-preset-file>', 'Use a preset file for non-interactive delete.')
+    .action(deleteApp);
+
+program.command('rollback-app')
+    .description('Roll back an application to its most recent backup.')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .requiredOption('-a, --appName <app-name>', 'The name of the application to roll back.')
+    .option('-f, --file <path-to-preset-file>', 'Use a preset file for non-interactive rollback.')
+    .action(rollbackApp);
+
+program.command('package-app')
+    .description('Package a live application into a downloadable .gin file.')
+    .requiredOption('-s, --serverUrl <server-url>', 'The base URL of the target Gingee server', 'http://localhost:7070')
+    .requiredOption('-a, --appName <app-name>', 'The name of the application to package.')
+    .option('-d, --dest <path>', 'The destination folder for the .gin app package file.')
+    .action(packageApp);
+
+program.command('list-app-backups')
+    .description('List all available backups for an application.')
+    .requiredOption('-s, --serverUrl <server-url>', 'The base URL of the target Gingee server', 'http://localhost:7070')
+    .requiredOption('-a, --appName <app-name>', 'The name of the application to list backups for.')
+    .action(listBackups);
+
+
+// --- App Store Commands ---
+program.command('list-store-apps')
+    .description('List available applications from a store manifest URL.')
+    .requiredOption('-g, --gStoreUrl <gstore-url>', 'Gingee app store URL')
+    .action(listStoreApps);
+
+program.command('install-store-app <app-name>')
+    .description('Interactively install an application from a store onto a target Gingee server.')
+    .requiredOption('-g, --gStoreUrl <gstore-url>', 'Gingee app store URL')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .action(installStoreApp);
+
+program.command('upgrade-store-app <app-name>')
+    .description('Interactively upgrade an application from a store onto a target Gingee server.')
+    .requiredOption('-g, --gStoreUrl <gstore-url>', 'Gingee app store URL')
+    .requiredOption('-s, --serverUrl <server-url>', 'Gingee server URL', 'http://localhost:7070')
+    .action(upgradeStoreApp);
+
+
+//TODO: We will add more commands here later.
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "gingee-cli",
+  "version": "1.0.0",
+  "description": "The Gingee Command Line Interface (CLI), official command line tool for creating and managing Gingee projects.",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gingerhome/gingee-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gingerhome/gingee-cli/issues"
+  },
+  "homepage": "https://github.com/gingerhome/gingee-cli#readme",
+  "keywords": [
+    "command line",
+    "cli",
+    "gingee",
+    "genai",
+    "ai-authored",
+    "collaborative-ai",
+    "web server",
+    "app server",
+    "app platform",
+    "app framework",
+    "framework",
+    "backend",
+    "sandbox",
+    "multi-database",
+    "enterprise"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "archiver": "^7.0.1",
+    "argon2": "^0.44.0",
+    "axios": "^1.11.0",
+    "chalk": "^5.5.0",
+    "commander": "^14.0.0",
+    "form-data": "^4.0.4",
+    "fs-extra": "^11.3.1",
+    "gingee": "^1.0.0",
+    "inquirer": "^12.9.2",
+    "ora": "^8.2.0",
+    "yauzl": "^3.2.0"
+  },
+  "optionalDependencies": {
+    "node-linux": "^0.1.12",
+    "node-mac": "^1.0.1",
+    "node-windows": "^1.0.0-beta.8"
+  }
+}

package/templates/project/ecosystem.config.js

@@ -0,0 +1,34 @@
+module.exports = {
+  apps: [{
+    // The name of your application, as it will appear in PM2.
+    name: 'gingee-server',
+    
+    // The script that starts your application.
+    script: 'start.js',
+    cwd: __dirname,
+
+    // --- Advanced Options ---
+    // Reference: https://pm2.io/doc/en/runtime/reference/ecosystem-file/
+
+    // To enable cluster mode and run on all available CPU cores:
+    // instances: 'max',
+    // exec_mode: 'cluster',
+
+    // To watch for file changes and automatically restart (for development):
+    // watch: ["./web", "./modules"],
+    
+    // Automatic restart on crash
+    autorestart: true,
+    
+    // Resource limits to prevent memory leaks from crashing the server
+    max_memory_restart: '1G',
+
+    // Environment variables
+    env: {
+      NODE_ENV: 'development'
+    },
+    env_production: {
+      NODE_ENV: 'production'
+    }
+  }]
+};

package/templates/project/gingee.json

@@ -0,0 +1,34 @@
+{
+    "server": {
+        "https": {
+            "enabled": false,
+            "port": 443
+        },
+        "http": {
+            "enabled": true,
+            "port": 7070
+        }
+    },
+    "content_encoding": {
+        "enabled": true
+    },
+    "box": {
+        "allowed_modules": []
+    },
+    "web_root": "./web",
+    "cache": {
+        "provider": "memory"
+    },
+    "default_app": "glade",
+    "privileged_apps": [
+        "glide",
+        "glade"
+    ],
+    "logging": {
+        "level": "error",
+        "rotation": {
+            "period_days": 7,
+            "max_size_mb": 50
+        }
+    }
+}

package/templates/project/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "my-gingee-project",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "start": "node start.js",
+    "dev": "nodemon start.js"
+  },
+  "dependencies": {
+    "gingee": "^1.0.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.0.0"
+  }
+}

package/templates/project/start.js

@@ -0,0 +1,6 @@
+// This file starts the Gingee server engine.
+try{
+	require('gingee');
+}catch(err){
+	console.error(`Error running Gingee: ${err.message}`); 
+}