Merge pull request #1142 from appwrite/cursor/add-update-command-to-cli-sdk-9202

abnegate · web-flow · commit 0628cdbe17d9 · 2025-08-08T01:57:23.000+12:00
Add update command to CLI SDK
diff --git a/src/SDK/Language/CLI.php b/src/SDK/Language/CLI.php
@@ -330,6 +330,11 @@ public function getFiles(): array
                 'scope'         => 'default',
                 'destination'   => 'lib/commands/types.js',
                 'template'      => 'cli/lib/commands/types.js.twig',
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/commands/update.js',
+                'template'      => 'cli/lib/commands/update.js.twig',
             ]
         ];
     }
diff --git a/templates/cli/index.js.twig b/templates/cli/index.js.twig
@@ -10,6 +10,7 @@ const chalk = require("chalk");
 const { version } = require("./package.json");
 const { commandDescriptions, cliConfig } = require("./lib/parser");
 const { client } = require("./lib/commands/generic");
+const { getLatestVersion, compareVersions } = require("./lib/utils");
 const inquirer = require("inquirer");
 {% if sdk.test != "true" %}
 const { login, logout, whoami, migrate, register } = require("./lib/commands/generic");
@@ -18,6 +19,7 @@ const { types } = require("./lib/commands/types");
 const { pull } = require("./lib/commands/pull");
 const { run } = require("./lib/commands/run");
 const { push, deploy } = require("./lib/commands/push");
+const { update } = require("./lib/commands/update");
 {% else %}
 const { migrate } = require("./lib/commands/generic");
 {% endif %}
@@ -27,6 +29,41 @@ const { {{ service.name | caseLower }} } = require("./lib/commands/{{ service.na
 
 inquirer.registerPrompt('search-list', require('inquirer-search-list'));
 
+/**
+ * Check for updates and show version information
+ */
+async function checkVersion() {
+    process.stdout.write(chalk.bold(`{{ language.params.executableName|caseLower }} version ${version}`) + '\n');
+    
+    try {
+        const latestVersion = await getLatestVersion();
+        const comparison = compareVersions(version, latestVersion);
+        
+        if (comparison > 0) {
+            // Current version is older than latest
+            process.stdout.write(chalk.yellow(`\n⚠️  A newer version is available: ${chalk.bold(latestVersion)}`) + '\n');
+            process.stdout.write(chalk.cyan(`💡 Run '${chalk.bold('{{ language.params.executableName|caseLower }} update')}' to update to the latest version.`) + '\n');
+        } else if (comparison === 0) {
+            process.stdout.write(chalk.green('\n✅ You are running the latest version!') + '\n');
+        } else {
+            // Current version is newer than latest (pre-release/dev)
+            process.stdout.write(chalk.blue('\n🚀 You are running a pre-release or development version.') + '\n');
+        }
+    } catch (error) {
+        // Silently fail version check, just show current version
+        process.stdout.write(chalk.gray('\n(Unable to check for updates)') + '\n');
+    }
+}
+
+// Intercept version flag before Commander.js processes it
+if (process.argv.includes('-v') || process.argv.includes('--version')) {
+    (async () => {
+        await checkVersion();
+        process.exit(0);
+    })();
+    return;
+}
+
 program
   .description(commandDescriptions['main'])
   .configureHelp({
@@ -72,6 +109,7 @@ program
   .addCommand(types)
   .addCommand(deploy)
   .addCommand(run)
+  .addCommand(update)
   .addCommand(logout)
 {% endif %}
 {% for service in spec.services %}
diff --git a/templates/cli/lib/commands/update.js.twig b/templates/cli/lib/commands/update.js.twig
@@ -0,0 +1,218 @@
+const fs = require("fs");
+const path = require("path");
+const { spawn } = require("child_process");
+const { Command } = require("commander");
+const { fetch } = require("undici");
+const chalk = require("chalk");
+const inquirer = require("inquirer");
+const { success, log, warn, error, hint, actionRunner, commandDescriptions } = require("../parser");
+const { getLatestVersion, compareVersions } = require("../utils");
+const { version } = require("../../package.json");
+
+/**
+ * Check if the CLI was installed via npm
+ */
+const isInstalledViaNpm = () => {
+    try {
+        const scriptPath = process.argv[1];
+
+        if (scriptPath.includes('node_modules') && scriptPath.includes('{{ language.params.npmPackage|caseDash }}')) {
+            return true;
+        }
+
+        if (scriptPath.includes('/usr/local/lib/node_modules/') || 
+            scriptPath.includes('/opt/homebrew/lib/node_modules/') ||
+            scriptPath.includes('/.npm-global/') ||
+            scriptPath.includes('/node_modules/.bin/')) {
+            return true;
+        }
+        
+        return false;
+    } catch (e) {
+        return false;
+    }
+};
+
+/**
+ * Check if the CLI was installed via Homebrew
+ */
+const isInstalledViaHomebrew = () => {
+    try {
+        const scriptPath = process.argv[1];
+        return scriptPath.includes('/opt/homebrew/') || scriptPath.includes('/usr/local/Cellar/');
+    } catch (e) {
+        return false;
+    }
+};
+
+
+
+/**
+ * Execute command and return promise
+ */
+const execCommand = (command, args = [], options = {}) => {
+    return new Promise((resolve, reject) => {
+        const child = spawn(command, args, { 
+            stdio: 'inherit',
+            shell: true,
+            ...options 
+        });
+        
+        child.on('close', (code) => {
+            if (code === 0) {
+                resolve();
+            } else {
+                reject(new Error(`Command failed with exit code ${code}`));
+            }
+        });
+        
+        child.on('error', (err) => {
+            reject(err);
+        });
+    });
+};
+
+/**
+ * Update via npm
+ */
+const updateViaNpm = async () => {
+    try {
+        await execCommand('npm', ['install', '-g', '{{ language.params.npmPackage|caseDash }}@latest']);
+        console.log("");
+        success("Updated to latest version via npm!");
+        hint("Run '{{ language.params.executableName|caseLower }} --version' to verify the new version.");
+    } catch (e) {
+        if (e.message.includes('EEXIST') || e.message.includes('file already exists')) {
+            console.log("");
+            success("Latest version is already installed via npm!");
+            hint("The CLI is up to date. Run '{{ language.params.executableName|caseLower }} --version' to verify.");
+        } else {
+            console.log("");
+            error(`Failed to update via npm: ${e.message}`);
+            hint("Try running: npm install -g {{ language.params.npmPackage|caseDash }}@latest --force");
+        }
+    }
+};
+
+/**
+ * Update via Homebrew
+ */
+const updateViaHomebrew = async () => {
+    try {
+        await execCommand('brew', ['upgrade', '{{ language.params.executableName|caseLower }}']);
+        console.log("");
+        success("Updated to latest version via Homebrew!");
+        hint("Run '{{ language.params.executableName|caseLower }} --version' to verify the new version.");
+    } catch (e) {
+        if (e.message.includes('already installed') || e.message.includes('up-to-date')) {
+            console.log("");
+            success("Latest version is already installed via Homebrew!");
+            hint("The CLI is up to date. Run '{{ language.params.executableName|caseLower }} --version' to verify.");
+        } else {
+            console.log("");
+            error(`Failed to update via Homebrew: ${e.message}`);
+            hint("Try running: brew upgrade {{ language.params.executableName|caseLower }}");
+        }
+    }
+};
+
+/**
+ * Show manual update instructions
+ */
+const showManualInstructions = (latestVersion) => {
+    log("Manual update options:");
+    console.log("");
+    
+    log(`${chalk.bold("Option 1: NPM")}`);
+    console.log(`  npm install -g {{ language.params.npmPackage|caseDash }}@latest`);
+    console.log("");
+    
+    log(`${chalk.bold("Option 2: Homebrew")}`);
+    console.log(`  brew upgrade {{ language.params.executableName|caseLower }}`);
+    console.log("");
+    
+    log(`${chalk.bold("Option 3: Download Binary")}`);
+    console.log(`  Visit: https://github.com/{{ language.params.npmPackage|caseDash }}/releases/tag/${latestVersion}`);
+};
+
+/**
+ * Show interactive menu for choosing update method
+ */
+const chooseUpdateMethod = async (latestVersion) => {
+    const choices = [
+        { name: 'NPM', value: 'npm' },
+        { name: 'Homebrew', value: 'homebrew' },
+        { name: 'Show manual instructions', value: 'manual' }
+    ];
+
+    const { method } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'method',
+            message: 'Could not detect installation method. How would you like to update?',
+            choices: choices
+        }
+    ]);
+
+    switch (method) {
+        case 'npm':
+            await updateViaNpm();
+            break;
+        case 'homebrew':
+            await updateViaHomebrew();
+            break;
+        case 'manual':
+            showManualInstructions(latestVersion);
+            break;
+    }
+};
+
+/**
+ * Main update function
+ */
+const updateCli = async ({ manual } = {}) => {
+    try {
+        const latestVersion = await getLatestVersion();
+        
+        const comparison = compareVersions(version, latestVersion);
+        
+        if (comparison === 0) {
+            success(`You're already running the latest version (${chalk.bold(version)})!`);
+            return;
+        } else if (comparison < 0) {
+            warn(`You're running a newer version (${chalk.bold(version)}) than the latest released version (${chalk.bold(latestVersion)}).`);
+            hint("This might be a pre-release or development version.");
+            return;
+        }
+        
+        log(`Updating from ${chalk.blue(version)} to ${chalk.green(latestVersion)}...`);
+        console.log("");
+        
+        if (manual) {
+            showManualInstructions(latestVersion);
+            return;
+        }
+        
+        if (isInstalledViaNpm()) {
+            await updateViaNpm();
+        } else if (isInstalledViaHomebrew()) {
+            await updateViaHomebrew();
+        } else {
+            await chooseUpdateMethod(latestVersion);
+        }
+        
+    } catch (e) {
+        console.log("");
+        error(`Failed to check for updates: ${e.message}`);
+        hint("You can manually check for updates at: https://github.com/{{ language.params.npmPackage|caseDash }}/releases");
+    }
+};
+
+const update = new Command("update")
+    .description("Update the {{ spec.title|caseUcfirst }} CLI to the latest version")
+    .option("--manual", "Show manual update instructions instead of auto-updating")
+    .action(actionRunner(updateCli));
+
+module.exports = {
+    update
+};
diff --git a/templates/cli/lib/parser.js.twig b/templates/cli/lib/parser.js.twig
@@ -216,6 +216,7 @@ const commandDescriptions = {
     "sites": `The sites command allows you to view, create and manage your Appwrite Sites.`,
     "storage": `The storage command allows you to manage your project files.`,
     "teams": `The teams command allows you to group users of your project to enable them to share read and write access to your project resources.`,
+    "update": `The update command allows you to update the {{ spec.title|caseUcfirst }} CLI to the latest version.`,
     "users": `The users command allows you to manage your project users.`,
     "client": `The client command allows you to configure your CLI`,
     "login": `The login command allows you to authenticate and manage a user account.`,
diff --git a/templates/cli/lib/utils.js.twig b/templates/cli/lib/utils.js.twig
@@ -3,8 +3,43 @@ const path = require("path");
 const net = require("net");
 const childProcess = require('child_process');
 const chalk = require('chalk');
+const { fetch } = require("undici");
 const { localConfig, globalConfig } = require("./config");
 
+/**
+ * Get the latest version from npm registry
+ */
+async function getLatestVersion() {
+    try {
+        const response = await fetch('https://registry.npmjs.org/{{ language.params.npmPackage|caseDash }}/latest');
+        if (!response.ok) {
+            throw new Error(`HTTP ${response.status}`);
+        }
+        const data = await response.json();
+        return data.version;
+    } catch (e) {
+        throw new Error(`Failed to fetch latest version: ${e.message}`);
+    }
+}
+
+/**
+ * Compare versions using semantic versioning
+ */
+function compareVersions(current, latest) {
+    const currentParts = current.split('.').map(Number);
+    const latestParts = latest.split('.').map(Number);
+    
+    for (let i = 0; i < Math.max(currentParts.length, latestParts.length); i++) {
+        const currentPart = currentParts[i] || 0;
+        const latestPart = latestParts[i] || 0;
+        
+        if (latestPart > currentPart) return 1;  // Latest is newer
+        if (latestPart < currentPart) return -1; // Current is newer
+    }
+    
+    return 0; // Same version
+}
+
 function getAllFiles(folder) {
     const files = [];
     for (const pathDir of fs.readdirSync(folder)) {
@@ -285,5 +320,7 @@ module.exports = {
     systemHasCommand,
     checkDeployConditions,
     showConsoleLink,
-    isCloud
+    isCloud,
+    getLatestVersion,
+    compareVersions
 };

Original file line number	Diff line number	Diff line change
`@@ -330,6 +330,11 @@ public function getFiles(): array`
`330`	`330`	`'scope' => 'default',`
`331`	`331`	`'destination' => 'lib/commands/types.js',`
`332`	`332`	`'template' => 'cli/lib/commands/types.js.twig',`
	`333`	`+ ],`
	`334`	`+ [`
	`335`	`+ 'scope' => 'default',`
	`336`	`+ 'destination' => 'lib/commands/update.js',`
	`337`	`+ 'template' => 'cli/lib/commands/update.js.twig',`
`333`	`338`	`]`
`334`	`339`	`];`
`335`	`340`	`}`