clever-tools 4.4.1 → 4.5.0

package/src/commands/logs/logs.command.js

@@ -0,0 +1,81 @@
+import { z } from 'zod';
+import { defineCommand } from '../../lib/define-command.js';
+import { defineOption } from '../../lib/define-option.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import * as Application from '../../models/application.js';
+import { resolveAddonId } from '../../models/ids-resolver.js';
+import * as Log from '../../models/log-v4.js';
+import * as LogV2 from '../../models/log.js';
+import { Deferred } from '../../models/utils.js';
+import {
+  addonIdOption,
+  afterOption,
+  aliasOption,
+  appIdOrNameOption,
+  beforeOption,
+  logsFormatOption,
+} from '../global.options.js';
+
+export const logsCommand = defineCommand({
+  description: 'Fetch application logs, continuously',
+  since: '0.2.0',
+  options: {
+    search: defineOption({
+      name: 'search',
+      schema: z.string().optional(),
+      description: 'Fetch logs matching this pattern',
+      placeholder: 'search',
+    }),
+    deploymentId: defineOption({
+      name: 'deployment-id',
+      schema: z.string().optional(),
+      description: 'Fetch logs for a given deployment',
+      placeholder: 'deployment-id',
+    }),
+    alias: aliasOption,
+    app: appIdOrNameOption,
+    before: beforeOption,
+    after: afterOption,
+    addon: addonIdOption,
+    format: logsFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    const {
+      alias,
+      app: appIdOrName,
+      addon: addonIdOrRealId,
+      after: since,
+      before: until,
+      search,
+      deploymentId,
+      format,
+    } = options;
+
+    // ignore --search ""
+    const filter = search !== '' ? search : null;
+    const isForHuman = format === 'human';
+
+    // TODO: drop when addons are migrated to the v4 API
+    if (addonIdOrRealId != null) {
+      const addonId = await resolveAddonId(addonIdOrRealId);
+      if (isForHuman) {
+        Logger.println(styleText('blue', 'Waiting for addon logs…'));
+      } else {
+        throw new Error(`"${format}" format is not yet available for add-on logs`);
+      }
+      return LogV2.displayLogs({ appAddonId: addonId, since, until, filter, deploymentId });
+    }
+
+    const { ownerId, appId } = await Application.resolveId(appIdOrName, alias);
+
+    if (isForHuman) {
+      Logger.println(styleText('blue', 'Waiting for application logs…'));
+    }
+
+    const deferred = new Deferred();
+    await Log.displayLogs({ ownerId, appId, since, until, filter, deploymentId, format, deferred });
+    return deferred.promise;
+  },
+});

package/src/commands/logs/logs.docs.md

@@ -0,0 +1,22 @@
+# 📖 `clever logs` command reference
+
+## ➡️ `clever logs` <kbd>Since 0.2.0</kbd>
+
+Fetch application logs, continuously
+
+```bash
+clever logs [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--addon` `<addon-id>`|Add-on ID|
+|`--after`, `--since` `<after>`|Fetch logs after this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)|
+|`-a`, `--alias` `<alias>`|Short name for the application|
+|`--app` `<app-id\|app-name>`|Application to manage by its ID (or name, if unambiguous)|
+|`--before`, `--until` `<before>`|Fetch logs before this date/time (ISO8601 date, positive number in seconds or duration, e.g.: 1h)|
+|`--deployment-id` `<deployment-id>`|Fetch logs for a given deployment|
+|`-F`, `--format` `<format>`|Output format (human, json, json-stream) (default: human)|
+|`--search` `<search>`|Fetch logs matching this pattern|

package/src/commands/make-default/make-default.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { styleText } from '../../lib/style-text.js';
+import { Logger } from '../../logger.js';
+import * as AppConfig from '../../models/app_configuration.js';
+import { aliasArg } from '../global.args.js';
+
+export const makeDefaultCommand = defineCommand({
+  description: 'Make a linked application the default one',
+  since: '0.5.0',
+  options: {},
+  args: [aliasArg],
+  async handler(_options, alias) {
+    await AppConfig.setDefault(alias);
+
+    Logger.printSuccess(`The application ${styleText('green', alias)} has been set as default`);
+  },
+});

package/src/commands/make-default/make-default.docs.md

@@ -0,0 +1,15 @@
+# 📖 `clever make-default` command reference
+
+## ➡️ `clever make-default` <kbd>Since 0.5.0</kbd>
+
+Make a linked application the default one
+
+```bash
+clever make-default <app-alias>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`app-alias`|Application alias|

package/src/commands/matomo/matomo.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorList } from '../../lib/operator-commands.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const matomoCommand = defineCommand({
+  description: 'Manage Clever Cloud Matomo services',
+  since: '3.13.0',
+  isExperimental: true,
+  featureFlag: 'operators',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    await operatorList('addon-matomo', options.format);
+  },
+});

package/src/commands/matomo/matomo.docs.md

@@ -0,0 +1,109 @@
+# 📖 `clever matomo` command reference
+
+> [!NOTE]
+> 🧪 **Experimental**: This command may change or be removed in future versions.
+> Enable with: `clever features enable operators`
+
+## ➡️ `clever matomo` <kbd>Since 3.13.0</kbd>
+
+Manage Clever Cloud Matomo services
+
+```bash
+clever matomo [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever matomo get` <kbd>Since 3.13.0</kbd>
+
+Get information about a deployed Matomo
+
+```bash
+clever matomo get <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever matomo open` <kbd>Since 3.13.0</kbd>
+
+Open the Matomo dashboard in Clever Cloud Console
+
+```bash
+clever matomo open <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever matomo open logs` <kbd>Since 3.13.0</kbd>
+
+Open the Matomo application logs in Clever Cloud Console
+
+```bash
+clever matomo open logs <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever matomo open webui` <kbd>Since 3.13.0</kbd>
+
+Open the Matomo admin console in your browser
+
+```bash
+clever matomo open webui <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever matomo rebuild` <kbd>Since 3.13.0</kbd>
+
+Rebuild Matomo
+
+```bash
+clever matomo rebuild <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever matomo restart` <kbd>Since 3.13.0</kbd>
+
+Restart Matomo
+
+```bash
+clever matomo restart <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|

package/src/commands/matomo/matomo.get.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorPrint } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const matomoGetCommand = defineCommand({
+  description: 'Get information about a deployed Matomo',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { format } = options;
+    await operatorPrint('matomo', addonIdOrName, format);
+  },
+});

package/src/commands/matomo/matomo.open.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpen } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const matomoOpenCommand = defineCommand({
+  description: 'Open the Matomo dashboard in Clever Cloud Console',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpen('matomo', addonIdOrName);
+  },
+});

package/src/commands/matomo/matomo.open.logs.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpenLogs } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const matomoOpenLogsCommand = defineCommand({
+  description: 'Open the Matomo application logs in Clever Cloud Console',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpenLogs('matomo', addonIdOrName);
+  },
+});

package/src/commands/matomo/matomo.open.webui.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpenWebUi } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const matomoOpenWebuiCommand = defineCommand({
+  description: 'Open the Matomo admin console in your browser',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpenWebUi('matomo', addonIdOrName);
+  },
+});

package/src/commands/matomo/matomo.rebuild.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorRebuild } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const matomoRebuildCommand = defineCommand({
+  description: 'Rebuild Matomo',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorRebuild('matomo', addonIdOrName);
+  },
+});

package/src/commands/matomo/matomo.restart.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorReboot } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const matomoRestartCommand = defineCommand({
+  description: 'Restart Matomo',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorReboot('matomo', addonIdOrName);
+  },
+});

package/src/commands/metabase/metabase.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorList } from '../../lib/operator-commands.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const metabaseCommand = defineCommand({
+  description: 'Manage Clever Cloud Metabase services',
+  since: '3.13.0',
+  isExperimental: true,
+  featureFlag: 'operators',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [],
+  async handler(options) {
+    await operatorList('metabase', options.format);
+  },
+});

package/src/commands/metabase/metabase.docs.md

@@ -0,0 +1,169 @@
+# 📖 `clever metabase` command reference
+
+> [!NOTE]
+> 🧪 **Experimental**: This command may change or be removed in future versions.
+> Enable with: `clever features enable operators`
+
+## ➡️ `clever metabase` <kbd>Since 3.13.0</kbd>
+
+Manage Clever Cloud Metabase services
+
+```bash
+clever metabase [options]
+```
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever metabase get` <kbd>Since 3.13.0</kbd>
+
+Get information about a deployed Metabase
+
+```bash
+clever metabase get <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever metabase open` <kbd>Since 3.13.0</kbd>
+
+Open the Metabase dashboard in Clever Cloud Console
+
+```bash
+clever metabase open <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever metabase open logs` <kbd>Since 3.13.0</kbd>
+
+Open the Metabase application logs in Clever Cloud Console
+
+```bash
+clever metabase open logs <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever metabase open webui` <kbd>Since 3.13.0</kbd>
+
+Open the Metabase admin console in your browser
+
+```bash
+clever metabase open webui <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever metabase rebuild` <kbd>Since 3.13.0</kbd>
+
+Rebuild Metabase
+
+```bash
+clever metabase rebuild <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever metabase restart` <kbd>Since 3.13.0</kbd>
+
+Restart Metabase
+
+```bash
+clever metabase restart <addon-id|addon-name>
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+## ➡️ `clever metabase version` <kbd>Since 3.13.0</kbd>
+
+Manage Metabase deployed version
+
+```bash
+clever metabase version <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever metabase version check` <kbd>Since 3.13.0</kbd>
+
+Check Metabase deployed version
+
+```bash
+clever metabase version check <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
+
+## ➡️ `clever metabase version update` <kbd>Since 3.13.0</kbd>
+
+Update Metabase deployed version
+
+```bash
+clever metabase version update <addon-id|addon-name> [options]
+```
+
+### 📥 Arguments
+
+|Name|Description|
+|---|---|
+|`addon-id|addon-name`|Add-on ID (or name, if unambiguous)|
+
+### ⚙️ Options
+
+|Name|Description|
+|---|---|
+|`--target` `<version>`|Target version to upgrade to (e.g.: 24, 2.4, 2.4.1)|

package/src/commands/metabase/metabase.get.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorPrint } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const metabaseGetCommand = defineCommand({
+  description: 'Get information about a deployed Metabase',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { format } = options;
+    await operatorPrint('metabase', addonIdOrName, format);
+  },
+});

package/src/commands/metabase/metabase.open.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpen } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const metabaseOpenCommand = defineCommand({
+  description: 'Open the Metabase dashboard in Clever Cloud Console',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpen('metabase', addonIdOrName);
+  },
+});

package/src/commands/metabase/metabase.open.logs.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpenLogs } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const metabaseOpenLogsCommand = defineCommand({
+  description: 'Open the Metabase application logs in Clever Cloud Console',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpenLogs('metabase', addonIdOrName);
+  },
+});

package/src/commands/metabase/metabase.open.webui.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorOpenWebUi } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const metabaseOpenWebuiCommand = defineCommand({
+  description: 'Open the Metabase admin console in your browser',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorOpenWebUi('metabase', addonIdOrName);
+  },
+});

package/src/commands/metabase/metabase.rebuild.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorRebuild } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const metabaseRebuildCommand = defineCommand({
+  description: 'Rebuild Metabase',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorRebuild('metabase', addonIdOrName);
+  },
+});

package/src/commands/metabase/metabase.restart.command.js

@@ -0,0 +1,13 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorReboot } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+
+export const metabaseRestartCommand = defineCommand({
+  description: 'Restart Metabase',
+  since: '3.13.0',
+  options: {},
+  args: [addonIdOrNameArg],
+  async handler(_options, addonIdOrName) {
+    await operatorReboot('metabase', addonIdOrName);
+  },
+});

package/src/commands/metabase/metabase.version.check.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorCheckVersion } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const metabaseVersionCheckCommand = defineCommand({
+  description: 'Check Metabase deployed version',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { format } = options;
+    await operatorCheckVersion('metabase', addonIdOrName, format);
+  },
+});

package/src/commands/metabase/metabase.version.command.js

@@ -0,0 +1,17 @@
+import { defineCommand } from '../../lib/define-command.js';
+import { operatorCheckVersion } from '../../lib/operator-commands.js';
+import { addonIdOrNameArg } from '../global.args.js';
+import { humanJsonOutputFormatOption } from '../global.options.js';
+
+export const metabaseVersionCommand = defineCommand({
+  description: 'Manage Metabase deployed version',
+  since: '3.13.0',
+  options: {
+    format: humanJsonOutputFormatOption,
+  },
+  args: [addonIdOrNameArg],
+  async handler(options, addonIdOrName) {
+    const { format } = options;
+    await operatorCheckVersion('metabase', addonIdOrName, format);
+  },
+});