clever-tools 4.0.2 → 4.2.0

package/bin/clever.js

@@ -79,6 +79,10 @@ process.stdout.on('error', (error) => {
 const cliparseCommand = cliparse.command;
 
 cliparse.command = function (name, options, commandFunction) {
+  if (commandFunction == null) {
+    return cliparseCommand(name, options);
+  }
+
   return cliparseCommand(name, options, (...args) => {
     const promise = commandFunction(...args);
     handleCommandPromise(promise);
@@ -103,10 +107,6 @@ async function run() {
     }),
     apiTokenId: cliparse.argument('api-token-id', { description: 'API token ID' }),
     apiTokenName: cliparse.argument('api-token-name', { description: 'API token name' }),
-    ngId: cliparse.argument('id', {
-      description: 'Network Group ID',
-      parser: Parsers.ngResourceType,
-    }),
     ngLabel: cliparse.argument('ng-label', {
       description: 'Network Group label',
       parser: Parsers.ngResourceType,
@@ -115,9 +115,6 @@ async function run() {
       description: 'Network Group ID or label',
       parser: Parsers.ngResourceType,
     }),
-    ngDescription: cliparse.argument('ng-description', {
-      description: 'Network Group description',
-    }),
     ngExternalPeerLabel: cliparse.argument('external-peer-label', {
       description: 'External peer label',
       parser: Parsers.ngResourceType,
@@ -127,12 +124,16 @@ async function run() {
       parser: Parsers.ngResourceType,
     }),
     ngAnyIdOrLabel: cliparse.argument('id-or-label', {
-      description: 'ID or Label of a Network group, a member or an (external) peer',
+      description: 'ID or Label of a Network Group, a member or an (external) peer',
+      parser: Parsers.ngResourceType,
+    }),
+    ngResourceId: cliparse.argument('id', {
+      description: 'ID of a resource to (un)link to a Network Group',
       parser: Parsers.ngResourceType,
     }),
     wgPublicKey: cliparse.argument('public-key', {
       metavar: 'public_key',
-      description: 'Wireguard public key of the external peer to link to a Network Group',
+      description: 'WireGuard public key of the external peer to link to a Network Group',
     }),
     email: cliparse.argument('email', {
       description: 'Email address',
@@ -213,18 +214,9 @@ async function run() {
     ngMembersIdsToLink: cliparse.option('link', {
       metavar: 'members_ids',
       description:
-        "Comma separated list of members IDs to link to a Network Group ('app_xxx', 'addon_xxx', 'external_xxx')",
+        'Comma separated list of members IDs to link to a Network Group (app_xxx, external_xxx, mysql_xxx, postgresql_xxx, redis_xxx, etc.)',
       parser: Parsers.commaSeparated,
     }),
-    ngMemberLabel: cliparse.option('label', {
-      required: false,
-      metavar: 'member_label',
-      description: 'The member label',
-      parser: Parsers.ngResourceType,
-    }),
-    ngPeerGetConfig: cliparse.flag('config', {
-      description: 'Get the Wireguard configuration of an external peer',
-    }),
     ngResourceType: cliparse.option('type', {
       metavar: 'type',
       description: 'Type of resource to look for (NetworkGroup, Member, CleverPeer, ExternalPeer)',
@@ -265,10 +257,6 @@ async function run() {
       metavar: 'TEXT',
       description: 'Get only domains containing the provided text',
     }),
-    naturalName: cliparse.flag('natural-name', {
-      aliases: ['n'],
-      description: 'Show the application names or aliases if possible',
-    }),
     before: cliparse.option('before', {
       metavar: 'before',
       aliases: ['until'],
@@ -294,10 +282,6 @@ async function run() {
       metavar: 'tag',
       description: 'Tag to push (none by default)',
     }),
-    databaseId: cliparse.option('database-id', {
-      metavar: 'database_id',
-      description: 'The Database ID (e.g.: postgresql_xxx)',
-    }),
     deploymentId: cliparse.option('deployment-id', {
       metavar: 'deployment_id',
       description: 'Fetch logs for a given deployment',
@@ -534,45 +518,17 @@ async function run() {
       aliases: ['y'],
       description: 'Skip confirmation and remove all SSH keys directly',
     }),
-    confirmTcpRedirCreation: cliparse.flag('yes', {
-      aliases: ['y'],
-      description: 'Skip confirmation even if the TCP redirection is not free',
-    }),
     yes: cliparse.flag('yes', {
       aliases: ['y'],
       description: 'Skip confirmation',
     }),
     jsonFormat: cliparse.flag('json', { aliases: ['j'], description: 'Show result in JSON format' }),
     humanJsonOutputFormat: getOutputFormatOption(),
-    tag: cliparse.option('tag', {
-      required: true,
-      metavar: 'tag',
-      description: 'A tag',
-      parser: Parsers.tag,
-    }),
-    tags: cliparse.option('tags', {
-      required: true,
-      metavar: 'tags',
-      description: 'List of tags, separated by a comma',
-      parser: Parsers.tags,
-    }),
     optTags: cliparse.option('tags', {
       metavar: 'tags',
       description: 'List of tags, separated by a comma',
       parser: Parsers.tags,
     }),
-    optIpAddress: cliparse.option('ip', {
-      required: false,
-      metavar: 'ip_address',
-      description: 'An IP address',
-      parser: Parsers.ipAddress,
-    }),
-    optPortNumber: cliparse.option('port', {
-      required: false,
-      metavar: 'port_number',
-      description: 'A port number',
-      parser: Parsers.portNumber,
-    }),
   };
 
   // ACCESSLOGS COMMAND
@@ -855,6 +811,7 @@ async function run() {
     {
       description: 'Manage the favourite domain name for an application',
       options: [opts.alias, opts.appIdOrName],
+      privateOptions: [opts.humanJsonOutputFormat],
       commands: [domainSetFavouriteCommand, domainUnsetFavouriteCommand],
     },
     domain.getFavourite,
@@ -879,7 +836,7 @@ async function run() {
     'domain',
     {
       description: 'Manage domain names for an application',
-      privateOptions: [opts.alias, opts.appIdOrName],
+      privateOptions: [opts.alias, opts.appIdOrName, opts.humanJsonOutputFormat],
       commands: [
         domainCreateCommand,
         domainFavouriteCommands,
@@ -1464,16 +1421,18 @@ async function run() {
   const ngLinkCommand = cliparse.command(
     'link',
     {
-      description: 'Link an application or a database add-on by its ID to a Network Group',
-      args: [args.ngAnyIdOrLabel, args.ngIdOrLabel],
+      description:
+        'Link a resource by its ID (app_xxx, external_xxx, mysql_xxx, postgresql_xxx, redis_xxx, etc.) to a Network Group',
+      args: [args.ngResourceId, args.ngIdOrLabel],
     },
     ng.linkToNg,
   );
   const ngUnlinkCommand = cliparse.command(
     'unlink',
     {
-      description: 'Unlink an application or a database add-on by its ID from a Network Group',
-      args: [args.ngAnyIdOrLabel, args.ngIdOrLabel],
+      description:
+        'Unlink a resource by its ID (app_xxx, external_xxx, mysql_xxx, postgresql_xxx, redis_xxx, etc.) from a Network Group',
+      args: [args.ngResourceId, args.ngIdOrLabel],
     },
     ng.unlinkFromNg,
   );
@@ -1489,7 +1448,7 @@ async function run() {
   const ngGetConfigCommand = cliparse.command(
     'get-config',
     {
-      description: 'Get the Wireguard configuration of a peer in a Network Group',
+      description: 'Get the WireGuard configuration of a peer in a Network Group',
       args: [args.ngExternalIdOrLabel, args.ngIdOrLabel],
       options: [opts.humanJsonOutputFormat],
     },
@@ -1907,7 +1866,7 @@ async function run() {
     'add',
     {
       description: 'Add a new TCP redirection to the application',
-      options: [opts.namespace, opts.confirmTcpRedirCreation],
+      options: [opts.namespace],
     },
     tcpRedirs.add,
   );
@@ -2028,18 +1987,10 @@ async function run() {
     },
     database.listBackups,
   );
-  const databaseCommand = cliparse.command(
-    'database',
-    {
-      description: 'List available databases',
-      commands: [backupsCommand],
-    },
-    async () => {
-      console.info('This command is not available, you can try the following commands:');
-      console.info('clever database backups');
-      console.info('clever database backups download');
-    },
-  );
+  const databaseCommand = cliparse.command('database', {
+    description: 'Manage databases and backups',
+    commands: [backupsCommand],
+  });
 
   // Patch help command description
   cliparseCommands.helpCommand.description = 'Display help about the Clever Cloud CLI';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "4.0.2",
+  "version": "4.2.0",
   "description": "Command Line Interface for Clever Cloud.",
   "keywords": [
     "cli",
@@ -47,7 +47,7 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "dependencies": {
-    "@clevercloud/client": "11.0.1",
+    "@clevercloud/client": "11.2.0",
     "@inquirer/prompts": "7.8.4",
     "char-regex": "2.0.2",
     "cliparse": "0.5.0",

package/src/commands/accesslogs.js

@@ -34,7 +34,7 @@ export async function accessLogs(params) {
   });
 
   if (format === 'human') {
-    Logger.warn(styleText('yellow', '/!\\ Access Logs feature is in Alpha testing phase'));
+    Logger.println(styleText('yellow', '/!\\ This feature is in Beta testing phase'));
   }
 
   if (format === 'json' && !until) {

package/src/commands/addon.js

@@ -3,6 +3,7 @@ import { styleText } from '../lib/style-text.js';
 import { getAllEnvVars } from '@clevercloud/client/esm/api/v2/addon.js';
 import { toNameEqualsValueString } from '@clevercloud/client/esm/utils/env-vars.js';
 import dedent from 'dedent';
+import { getOperator } from '../clever-client/operators.js';
 import { formatTable } from '../format-table.js';
 import { Logger } from '../logger.js';
 import * as Addon from '../models/addon.js';
@@ -53,6 +54,45 @@ export async function list(params) {
   }
 }
 
+const ADDON_PROVIDERS = {
+  keycloak: {
+    name: 'Keycloak',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Keycloak on Clever Cloud: ${conf.DOC_URL}/addons/keycloak/`,
+  },
+  kv: {
+    name: 'Materia KV',
+    isOperator: false,
+    status: 'beta',
+    postCreateInstructions: (addonId) => dedent`
+      ${styleText('yellow', "You can easily use Materia KV with 'redis-cli', with such commands:")}
+      ${styleText('blue', `source <(clever addon env ${addonId} -F shell)`)}
+      ${styleText('blue', 'redis-cli -h $KV_HOST -p $KV_PORT --tls')}
+      Learn more about Materia KV on Clever Cloud: ${conf.DOC_URL}/addons/materia-kv/
+    `,
+  },
+  'addon-matomo': {
+    name: 'Matomo',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Matomo on Clever Cloud: ${conf.DOC_URL}/addons/matomo/`,
+  },
+  metabase: {
+    name: 'Metabase',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Metabase on Clever Cloud: ${conf.DOC_URL}/addons/metabase/`,
+  },
+  otoroshi: {
+    name: 'Otoroshi with LLM',
+    isOperator: true,
+    postCreateInstructions: `Learn more about Otoroshi with LLM on Clever Cloud: ${conf.DOC_URL}/addons/otoroshi/`,
+  },
+  'addon-pulsar': {
+    name: 'Pulsar',
+    isOperator: false,
+    postCreateInstructions: `Learn more about Pulsar on Clever Cloud: ${conf.DOC_URL}/addons/pulsar/`,
+  },
+};
+
 export async function create(params) {
   const [providerName, name] = params.args;
   const {
@@ -62,23 +102,21 @@ export async function create(params) {
     yes: skipConfirmation,
     org: orgaIdOrName,
     format,
+    'addon-version': version,
+    option: addonOptions,
   } = params.options;
-  const version = params.options['addon-version'];
-  const addonOptions = parseAddonOptions(params.options.option);
-
-  const ownerId = orgaIdOrName != null ? await Organisation.getId(orgaIdOrName) : await User.getCurrentId();
 
   const addonToCreate = {
-    ownerId,
     name,
     providerName,
     planName,
     region,
     skipConfirmation,
     version,
-    addonOptions,
+    addonOptions: parseAddonOptions(addonOptions),
   };
 
+  const ownerId = orgaIdOrName != null ? await Organisation.getId(orgaIdOrName) : await User.getCurrentId();
   if (linkedAppAlias != null) {
     const linkedAppData = await AppConfig.getAppDetails({ alias: linkedAppAlias });
     if (orgaIdOrName != null && linkedAppData.ownerId !== ownerId && format === 'human') {
@@ -86,163 +124,98 @@ export async function create(params) {
         'The specified application does not belong to the specified organisation. Ignoring the `--org` option',
       );
     }
-    const newAddon = await Addon.create({
-      ...addonToCreate,
-      ownerId: linkedAppData.ownerId,
-    });
-    await Addon.link(linkedAppData.ownerId, linkedAppData.appId, { addon_id: newAddon.id });
-    displayAddon(
-      format,
-      newAddon,
-      providerName,
-      `Add-on created and linked to application ${linkedAppAlias} successfully!`,
-    );
+    addonToCreate.ownerId = linkedAppData.ownerId;
   } else {
-    const newAddon = await Addon.create(addonToCreate);
-    displayAddon(format, newAddon, providerName, 'Add-on created successfully!');
+    addonToCreate.ownerId = ownerId;
   }
-}
 
-function displayAddon(format, addon, providerName, message) {
-  const PROVIDERS_WITH_URL = {
-    keycloak: {
-      name: 'Keycloak',
-      urlEnv: 'CC_KEYCLOAK_URL',
-    },
-    'addon-matomo': {
-      name: 'Matomo',
-      urlEnv: 'MATOMO_URL',
-    },
-    metabase: {
-      name: 'Metabase',
-      urlEnv: 'METABASE_URL',
-    },
-    otoroshi: {
-      name: 'Otoroshi with LLM',
-      urlEnv: 'CC_OTOROSHI_URL',
-    },
-  };
+  const newAddon = await Addon.create(addonToCreate);
 
-  const WIP_PROVIDERS = {
-    keycloak: {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Keycloak on Clever Cloud: ${conf.DOC_URL}/addons/keycloak/,
-      `,
-    },
-    kv: {
-      status: 'alpha',
-      postCreateInstructions: dedent`
-        ${styleText('yellow', "You can easily use Materia KV with 'redis-cli', with such commands:")}
-        ${styleText('blue', `source <(clever addon env ${addon.id} -F shell)`)}
-        ${styleText('blue', 'redis-cli -h $KV_HOST -p $KV_PORT --tls')}
-        Learn more about Materia KV on Clever Cloud: ${conf.DOC_URL}/addons/materia-kv/
-      `,
-    },
-    'addon-matomo': {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Matomo on Clever Cloud: ${conf.DOC_URL}/addons/matomo/
-      `,
-    },
-    metabase: {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Metabase on Clever Cloud: ${conf.DOC_URL}/addons/metabase/
-      `,
-    },
-    otoroshi: {
-      status: '',
-      postCreateInstructions: dedent`
-        Learn more about Otoroshi with LLM on Clever Cloud: ${conf.DOC_URL}/addons/otoroshi/
-      `,
-    },
-    'addon-pulsar': {
-      status: 'beta',
-      postCreateInstructions: dedent`
-        Learn more about Pulsar on Clever Cloud: ${conf.DOC_URL}/addons/pulsar/
-      `,
-    },
-  };
+  if (linkedAppAlias != null) {
+    const linkedAppData = await AppConfig.getAppDetails({ alias: linkedAppAlias });
+    await Addon.link(linkedAppData.ownerId, linkedAppData.appId, { addon_id: newAddon.id });
+  }
 
-  let providerNameToShow = '';
+  const provider = ADDON_PROVIDERS[providerName];
   let statusMessage = '';
-  if (providerName in WIP_PROVIDERS && WIP_PROVIDERS[providerName].status !== '') {
-    providerNameToShow = providerName === 'kv' ? 'Materia KV' : providerName;
+  if (provider?.status) {
+    statusMessage = `The ${provider.name} provider is in ${provider.status} testing phase`;
+    if (provider.status === 'alpha') {
+      statusMessage += ". Don't store sensitive or production grade data.";
+    }
+  }
+
+  // JSON format
+  if (format === 'json') {
+    const jsonAddon = {
+      id: newAddon.id,
+      realId: newAddon.realId,
+      name: newAddon.name,
+      env: newAddon.env,
+    };
+
+    if (provider?.status) {
+      jsonAddon.availability = provider.status;
+      jsonAddon.message = statusMessage;
+    }
 
-    statusMessage = `The ${providerNameToShow} provider is in ${WIP_PROVIDERS[providerName].status} testing phase`;
-    statusMessage +=
-      WIP_PROVIDERS[providerName].status === 'alpha' ? ". Don't store sensitive or production grade data." : '';
+    Logger.printJson(jsonAddon);
+    return;
   }
 
-  switch (format) {
-    case 'json': {
-      const jsonAddon = {
-        id: addon.id,
-        realId: addon.realId,
-        name: addon.name,
-        env: addon.env,
-      };
+  // Human format
+  if (linkedAppAlias != null) {
+    Logger.println(`Add-on created and linked to application ${linkedAppAlias} successfully!`);
+  } else {
+    Logger.println('Add-on created successfully!');
+  }
 
-      Logger.printJson(
-        WIP_PROVIDERS[providerName] != null
-          ? { ...jsonAddon, availability: WIP_PROVIDERS[providerName].status, message: statusMessage }
-          : jsonAddon,
-      );
-      break;
-    }
+  Logger.println(`ID: ${newAddon.id}`);
+  Logger.println(`Real ID: ${newAddon.realId}`);
+  Logger.println(`Name: ${newAddon.name}`);
 
-    case 'human':
-    default:
-      Logger.println([message, `ID: ${addon.id}`, `Real ID: ${addon.realId}`, `Name: ${addon.name}`].join('\n'));
-
-      if (providerName in PROVIDERS_WITH_URL) {
-        const provider = PROVIDERS_WITH_URL[providerName];
-        const urlEnv = addon.env.find((entry) => entry.name === provider.urlEnv);
-        const urlToShow = urlEnv.value;
-        const urlToShowWithHttps = urlToShow.startsWith('http') ? urlToShow : `https://${urlToShow}`;
-
-        if (urlEnv) {
-          Logger.println();
-          Logger.println(`Your ${provider.name} is starting:`);
-          Logger.println(` - Access it: ${urlToShowWithHttps}`);
-          Logger.println(` - Manage it: ${conf.GOTO_URL}/${addon.id}`);
-        }
+  const operator = ADDON_PROVIDERS[providerName]?.isOperator
+    ? await getOperator({ provider: providerName, realId: newAddon.realId }).then(sendToApi)
+    : null;
 
-        if (providerName === 'keycloak') {
-          Logger.println();
-          Logger.println(
-            "An initial account has been created, you'll be invited to change the password at first login:",
-          );
-          Logger.println(` - Admin user name: ${addon.env.find((e) => e.name === 'CC_KEYCLOAK_ADMIN').value}`);
-          Logger.println(
-            ` - Temporary password: ${addon.env.find((e) => e.name === 'CC_KEYCLOAK_ADMIN_DEFAULT_PASSWORD').value}`,
-          );
-        }
+  if (operator) {
+    if (operator.accessUrl) {
+      Logger.println();
+      Logger.println(`Your ${ADDON_PROVIDERS[providerName].name} is starting:`);
+      Logger.println(` - Access it: ${operator.accessUrl}`);
+      Logger.println(` - Manage it: ${conf.GOTO_URL}/${newAddon.id}`);
+    }
 
-        if (providerName === 'otoroshi') {
-          Logger.println();
-          Logger.println(
-            'An initial account has been created, change the password at first login (Security -> Administrators -> Edit user):',
-          );
-          Logger.println(
-            ` - Admin user name: ${addon.env.find((e) => e.name === 'CC_OTOROSHI_INITIAL_ADMIN_LOGIN').value}`,
-          );
-          Logger.println(
-            ` - Initial password: ${addon.env.find((e) => e.name === 'CC_OTOROSHI_INITIAL_ADMIN_PASSWORD').value}`,
-          );
-        }
+    if (operator.initialCredentials) {
+      if (providerName === 'keycloak') {
+        Logger.println();
+        Logger.println("An initial account has been created, you'll be invited to change the password at first login:");
+        Logger.println(` - Admin user name: ${operator.initialCredentials.user}`);
+        Logger.println(` - Temporary password: ${operator.initialCredentials.password}`);
       }
-
-      if (providerName in WIP_PROVIDERS) {
+      if (providerName === 'otoroshi') {
         Logger.println();
+        Logger.println(
+          'An initial account has been created, change the password at first login (Security -> Administrators -> Edit user):',
+        );
+        Logger.println(` - Admin user name: ${operator.initialCredentials.user}`);
+        Logger.println(` - Password: ${operator.initialCredentials.password}`);
+      }
+    }
+  }
 
-        if (statusMessage !== '') {
-          Logger.println(styleText('yellow', `/!\\ ${statusMessage}`));
-        }
+  if (provider?.postCreateInstructions) {
+    Logger.println();
 
-        Logger.println(WIP_PROVIDERS[providerName].postCreateInstructions);
-      }
+    if (statusMessage !== '') {
+      Logger.println(styleText('yellow', `/!\\ ${statusMessage}`));
+    }
+
+    if (typeof provider.postCreateInstructions === 'function') {
+      Logger.println(provider.postCreateInstructions(newAddon.id));
+    } else {
+      Logger.println(provider.postCreateInstructions);
+    }
   }
 }
 

package/src/commands/diag.js

@@ -17,11 +17,9 @@ export async function diag(params) {
     if (authDetails.token == null) {
       return 'not connected';
     }
-
     if (userId == null) {
       return 'authentication failed';
     }
-
     return 'authenticated';
   }
 
@@ -32,7 +30,8 @@ export async function diag(params) {
     platform: os.platform(),
     release: os.release(),
     arch: process.arch,
-    shell: process.env.SHELL,
+    shell: getShell(),
+    terminal: getTerminal(),
     isPackaged: process.pkg != null,
     execPath: process.execPath,
     configFile: conf.CONFIGURATION_FILE,
@@ -69,7 +68,8 @@ export async function diag(params) {
         Logger.println('Linux         ' + styleText('green', formattedDiag.linuxInfos));
       }
       Logger.println('Shell         ' + styleText('green', formattedDiag.shell));
-      Logger.println('Packaged      ' + styleText('green', String(formattedDiag.isPackaged)));
+      Logger.println('Terminal      ' + styleText('green', formattedDiag.terminal));
+      Logger.println('Packaged      ' + styleText('green', formattedDiag.isPackaged));
       Logger.println('Exec path     ' + styleText('green', formattedDiag.execPath));
       Logger.println('Config file   ' + styleText('green', formattedDiag.configFile));
 
@@ -95,3 +95,32 @@ export async function diag(params) {
     }
   }
 }
+
+function getShell() {
+  const platform = os.platform();
+
+  if (platform === 'win32') {
+    if (process.env.PSModulePath) {
+      if (process.env.WT_SESSION) {
+        return 'PowerShell (Windows Terminal)';
+      }
+      if (process.env.PSVersionTable || process.env.POWERSHELL_DISTRIBUTION_CHANNEL) {
+        return 'PowerShell Core';
+      }
+      return 'Windows PowerShell';
+    }
+    if (process.env.WT_SESSION) {
+      return 'Windows Terminal (cmd)';
+    }
+    return process.env.ComSpec || 'cmd.exe';
+  }
+
+  return process.env.SHELL || 'unknown';
+}
+
+function getTerminal() {
+  if (process.env.WT_SESSION) {
+    return 'Windows Terminal';
+  }
+  return process.env.TERM_PROGRAM || process.env.TERMINAL_EMULATOR || process.env.TERM;
+}