@mittwald/cli 1.0.0-alpha.35 → 1.0.0-alpha.36

package/README.md

@@ -42,7 +42,7 @@ either the CMD prompt or PowerShell.
 #### Any OS, using Node.js+NPM
 
 Installing the CLI via NPM will work on any OS; however we cannot guarantee
-stability, because functionality of the CLI may depend in the Node.js runtime
+stability, because functionality of the CLI may depend on the Node.js runtime
 already installed on your system. Also, the automatic upgrade will not work when
 using NPM; remember to run `npm upgrade -g @mittwald/cli` occasionally.
 
@@ -551,17 +551,18 @@ Download the filesystem of an app within a project to your local machine
 
 ```
 USAGE
-  $ mw app download [INSTALLATION-ID] --target <value> [-q] [--dry-run] [--delete]
+  $ mw app download [INSTALLATION-ID] --target <value> [-q] [--ssh-user <value>] [--dry-run] [--delete]
 
 ARGUMENTS
   INSTALLATION-ID  ID or short ID of an app installation; this argument is optional if a default app installation is set
                    in the context
 
 FLAGS
-  -q, --quiet           suppress process output and only display a machine-readable summary.
-      --delete          delete local files that are not present on the server
-      --dry-run         do not actually download the app installation
-      --target=<value>  (required) target directory to download the app installation to
+  -q, --quiet             suppress process output and only display a machine-readable summary.
+      --delete            delete local files that are not present on the server
+      --dry-run           do not actually download the app installation
+      --ssh-user=<value>  override the SSH user to connect with; if omitted, your own user will be used
+      --target=<value>    (required) target directory to download the app installation to
 
 DESCRIPTION
   Download the filesystem of an app within a project to your local machine
@@ -571,6 +572,13 @@ FLAG DESCRIPTIONS
 
     This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
     scripts), you can use this flag to easily get the IDs of created resources for further processing.
+
+  --ssh-user=<value>  override the SSH user to connect with; if omitted, your own user will be used
+
+    This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
+    will be used for this.
+
+    You can also set this value by setting the MITTWALD_SSH_USER environment variable.
 ```
 
 ## `mw app get [INSTALLATION-ID]`
@@ -1479,19 +1487,28 @@ Connect to an app via SSH
 
 ```
 USAGE
-  $ mw app ssh [INSTALLATION-ID] [--cd] [--info] [--test]
+  $ mw app ssh [INSTALLATION-ID] [--ssh-user <value>] [--cd] [--info] [--test]
 
 ARGUMENTS
   INSTALLATION-ID  ID or short ID of an app installation; this argument is optional if a default app installation is set
                    in the context
 
 FLAGS
-  --[no-]cd  change to installation path after connecting
-  --info     only print connection information, without actually connecting
-  --test     test connection and exit
+  --[no-]cd           change to installation path after connecting
+  --info              only print connection information, without actually connecting
+  --ssh-user=<value>  override the SSH user to connect with; if omitted, your own user will be used
+  --test              test connection and exit
 
 DESCRIPTION
   Connect to an app via SSH
+
+FLAG DESCRIPTIONS
+  --ssh-user=<value>  override the SSH user to connect with; if omitted, your own user will be used
+
+    This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
+    will be used for this.
+
+    You can also set this value by setting the MITTWALD_SSH_USER environment variable.
 ```
 
 ## `mw app uninstall [INSTALLATION-ID]`
@@ -2269,7 +2286,7 @@ Create a dump of a MySQL database
 
 ```
 USAGE
-  $ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--temporary-user]
+  $ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--ssh-user <value>] [--temporary-user] [--gzip]
 
 ARGUMENTS
   DATABASE-ID  The ID of the database (when a project context is set, you can also use the name)
@@ -2278,6 +2295,8 @@ FLAGS
   -o, --output=<value>          (required) the output file to write the dump to ("-" for stdout)
   -p, --mysql-password=<value>  the password to use for the MySQL user (env: MYSQL_PWD)
   -q, --quiet                   suppress process output and only display a machine-readable summary.
+      --gzip                    compress the dump with gzip
+      --ssh-user=<value>        override the SSH user to connect with; if omitted, your own user will be used
       --[no-]temporary-user     create a temporary user for the dump
 
 FLAG DESCRIPTIONS
@@ -2300,6 +2319,18 @@ FLAG DESCRIPTIONS
     This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
     scripts), you can use this flag to easily get the IDs of created resources for further processing.
 
+  --gzip  compress the dump with gzip
+
+    Compress the dump with gzip. This is useful for large databases, as it can significantly reduce the size of the
+    dump.
+
+  --ssh-user=<value>  override the SSH user to connect with; if omitted, your own user will be used
+
+    This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
+    will be used for this.
+
+    You can also set this value by setting the MITTWALD_SSH_USER environment variable.
+
   --[no-]temporary-user  create a temporary user for the dump
 
     Create a temporary user for the dump. This user will be deleted after the dump has been created. This is useful if
@@ -2376,20 +2407,28 @@ Forward the TCP port of a MySQL database to a local port
 
 ```
 USAGE
-  $ mw database mysql port-forward DATABASE-ID [-q] [--port <value>]
+  $ mw database mysql port-forward DATABASE-ID [-q] [--ssh-user <value>] [--port <value>]
 
 ARGUMENTS
   DATABASE-ID  The ID of the database (when a project context is set, you can also use the name)
 
 FLAGS
-  -q, --quiet         suppress process output and only display a machine-readable summary.
-      --port=<value>  [default: 3306] The local TCP port to forward to
+  -q, --quiet             suppress process output and only display a machine-readable summary.
+      --port=<value>      [default: 3306] The local TCP port to forward to
+      --ssh-user=<value>  override the SSH user to connect with; if omitted, your own user will be used
 
 FLAG DESCRIPTIONS
   -q, --quiet  suppress process output and only display a machine-readable summary.
 
     This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
     scripts), you can use this flag to easily get the IDs of created resources for further processing.
+
+  --ssh-user=<value>  override the SSH user to connect with; if omitted, your own user will be used
+
+    This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
+    will be used for this.
+
+    You can also set this value by setting the MITTWALD_SSH_USER environment variable.
 ```
 
 ## `mw database mysql shell DATABASE-ID`

package/dist/esm/commands/app/download.d.ts

@@ -9,6 +9,7 @@ export declare class Download extends ExecRenderBaseCommand<typeof Download, voi
         "dry-run": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         delete: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         target: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        "ssh-user": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         quiet: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     protected exec(): Promise<void>;

package/dist/esm/commands/app/download.js

@@ -7,6 +7,7 @@ import { Success } from "../../rendering/react/components/Success.js";
 import { spawn } from "child_process";
 import { hasBinary } from "../../lib/hasbin.js";
 import { getSSHConnectionForAppInstallation } from "../../lib/ssh/appinstall.js";
+import { sshConnectionFlags } from "../../lib/ssh/flags.js";
 export class Download extends ExecRenderBaseCommand {
     static description = "Download the filesystem of an app within a project to your local machine";
     static args = {
@@ -14,6 +15,7 @@ export class Download extends ExecRenderBaseCommand {
     };
     static flags = {
         ...processFlags,
+        ...sshConnectionFlags,
         "dry-run": Flags.boolean({
             description: "do not actually download the app installation",
             default: false,
@@ -30,10 +32,10 @@ export class Download extends ExecRenderBaseCommand {
     };
     async exec() {
         const appInstallationId = await this.withAppInstallationId(Download);
-        const { "dry-run": dryRun, target, delete: deleteLocal } = this.flags;
+        const { "dry-run": dryRun, target, delete: deleteLocal, "ssh-user": sshUser, } = this.flags;
         const p = makeProcessRenderer(this.flags, "Downloading app installation");
         const { host, user, directory } = await p.runStep("getting connection data", async () => {
-            return getSSHConnectionForAppInstallation(this.apiClient, appInstallationId);
+            return getSSHConnectionForAppInstallation(this.apiClient, appInstallationId, sshUser);
         });
         await p.runStep("check if rsync is installed", async () => {
             if (!(await hasBinary("rsync"))) {

package/dist/esm/commands/app/ssh.d.ts

@@ -8,6 +8,7 @@ export default class Ssh extends ExtendedBaseCommand<typeof Ssh> {
         cd: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         info: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         test: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        "ssh-user": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/dist/esm/commands/app/ssh.js

@@ -3,10 +3,12 @@ import { appInstallationArgs } from "../../lib/app/flags.js";
 import { Flags } from "@oclif/core";
 import { ExtendedBaseCommand } from "../../ExtendedBaseCommand.js";
 import { getSSHConnectionForAppInstallation } from "../../lib/ssh/appinstall.js";
+import { sshConnectionFlags } from "../../lib/ssh/flags.js";
 export default class Ssh extends ExtendedBaseCommand {
     static description = "Connect to an app via SSH";
     static args = { ...appInstallationArgs };
     static flags = {
+        ...sshConnectionFlags,
         cd: Flags.boolean({
             summary: "change to installation path after connecting",
             default: true,
@@ -22,7 +24,7 @@ export default class Ssh extends ExtendedBaseCommand {
     async run() {
         const { flags } = await this.parse(Ssh);
         const appInstallationId = await this.withAppInstallationId(Ssh);
-        const { host, user, directory } = await getSSHConnectionForAppInstallation(this.apiClient, appInstallationId);
+        const { host, user, directory } = await getSSHConnectionForAppInstallation(this.apiClient, appInstallationId, flags["ssh-user"]);
         if (flags.info) {
             this.log("hostname: %o", host);
             this.log("username: %o", user);

package/dist/esm/commands/database/mysql/dump.d.ts

@@ -5,6 +5,8 @@ export declare class Dump extends ExecRenderBaseCommand<typeof Dump, Record<stri
     static flags: {
         "temporary-user": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         output: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        gzip: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        "ssh-user": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         "mysql-password": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         quiet: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };

package/dist/esm/commands/database/mysql/dump.js

@@ -12,11 +12,14 @@ import { assertStatus } from "@mittwald/api-client";
 import { randomBytes } from "crypto";
 import { executeViaSSH } from "../../../lib/ssh/exec.js";
 import assertSuccess from "../../../lib/assert_success.js";
+import shellEscape from "shell-escape";
+import { sshConnectionFlags } from "../../../lib/ssh/flags.js";
 export class Dump extends ExecRenderBaseCommand {
     static summary = "Create a dump of a MySQL database";
     static flags = {
         ...processFlags,
         ...mysqlConnectionFlags,
+        ...sshConnectionFlags,
         "temporary-user": Flags.boolean({
             summary: "create a temporary user for the dump",
             description: "Create a temporary user for the dump. This user will be deleted after the dump has been created. This is useful if you want to dump a database that is not accessible from the outside.\n\nIf this flag is disabled, you will need to specify the password of the default user; either via the --mysql-password flag or via the MYSQL_PWD environment variable.",
@@ -30,6 +33,13 @@ export class Dump extends ExecRenderBaseCommand {
             description: 'The output file to write the dump to. You can specify "-" or "/dev/stdout" to write the dump directly to STDOUT; in this case, you might want to use the --quiet/-q flag to supress all other output, so that you can pipe the mysqldump for further processing.',
             required: true,
         }),
+        gzip: Flags.boolean({
+            summary: "compress the dump with gzip",
+            aliases: ["gz"],
+            description: "Compress the dump with gzip. This is useful for large databases, as it can significantly reduce the size of the dump.",
+            default: false,
+            required: false,
+        }),
     };
     static args = { ...mysqlArgs };
     async exec() {
@@ -49,7 +59,14 @@ export class Dump extends ExecRenderBaseCommand {
         }
         const { project } = connectionDetails;
         const mysqldumpArgs = buildMySqlDumpArgs(connectionDetails);
-        await p.runStep(_jsxs(Text, { children: ["starting mysqldump via SSH on project ", _jsx(Value, { children: project.shortId })] }), () => executeViaSSH(this.apiClient, { projectId: connectionDetails.project.id }, "mysqldump", mysqldumpArgs, this.getOutputStream()));
+        let cmd = { command: "mysqldump", args: mysqldumpArgs };
+        if (this.flags.gzip) {
+            const escapedArgs = shellEscape(mysqldumpArgs);
+            cmd = {
+                shell: `set -e -o pipefail > /dev/null ; mysqldump ${escapedArgs} | gzip`,
+            };
+        }
+        await p.runStep(_jsxs(Text, { children: ["starting mysqldump via SSH on project ", _jsx(Value, { children: project.shortId })] }), () => executeViaSSH(this.apiClient, this.flags["ssh-user"], { projectId: connectionDetails.project.id }, cmd, this.getOutputStream()));
         await p.complete(_jsx(DumpSuccess, { database: connectionDetails.database, output: this.flags.output }));
         return {};
     }

package/dist/esm/commands/database/mysql/port-forward.d.ts

@@ -4,6 +4,7 @@ export declare class PortForward extends ExecRenderBaseCommand<typeof PortForwar
     static summary: string;
     static flags: {
         port: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        "ssh-user": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         quiet: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     static args: {

package/dist/esm/commands/database/mysql/port-forward.js

@@ -7,10 +7,12 @@ import { mysqlArgs, withMySQLId } from "../../../lib/database/mysql/flags.js";
 import { getConnectionDetails } from "../../../lib/database/mysql/connect.js";
 import { Value } from "../../../rendering/react/components/Value.js";
 import { Flags } from "@oclif/core";
+import { sshConnectionFlags } from "../../../lib/ssh/flags.js";
 export class PortForward extends ExecRenderBaseCommand {
     static summary = "Forward the TCP port of a MySQL database to a local port";
     static flags = {
         ...processFlags,
+        ...sshConnectionFlags,
         port: Flags.integer({
             summary: "The local TCP port to forward to",
             default: 3306,
@@ -20,7 +22,7 @@ export class PortForward extends ExecRenderBaseCommand {
     async exec() {
         const databaseId = await withMySQLId(this.apiClient, this.flags, this.args, this.config);
         const p = makeProcessRenderer(this.flags, "Port-forwarding a MySQL database");
-        const { sshUser, sshHost, hostname, database } = await getConnectionDetails(this.apiClient, databaseId, p);
+        const { sshUser, sshHost, hostname, database } = await getConnectionDetails(this.apiClient, databaseId, this.flags["ssh-user"], p);
         const { port } = this.flags;
         p.complete(_jsxs(Text, { children: ["Forwarding MySQL database ", _jsx(Value, { children: database }), " to local port", " ", _jsx(Value, { children: port }), ". Use CTRL+C to cancel."] }));
         const sshArgs = [

package/dist/esm/lib/database/mysql/connect.d.ts

@@ -3,6 +3,7 @@ import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
 export declare function getConnectionDetailsWithPassword(apiClient: MittwaldAPIV2Client, databaseId: string, p: ProcessRenderer, flags: {
     "mysql-password": string | undefined;
     "temporary-user"?: boolean;
+    "ssh-user"?: string;
 }): Promise<{
     password: string;
     hostname: string;
@@ -12,7 +13,7 @@ export declare function getConnectionDetailsWithPassword(apiClient: MittwaldAPIV
     sshUser: string;
     project: MittwaldAPIV2.Components.Schemas.ProjectProject;
 }>;
-export declare function getConnectionDetails(apiClient: MittwaldAPIV2Client, databaseId: string, p: ProcessRenderer): Promise<{
+export declare function getConnectionDetails(apiClient: MittwaldAPIV2Client, databaseId: string, sshUser: string | undefined, p: ProcessRenderer): Promise<{
     hostname: string;
     database: string;
     user: string;

package/dist/esm/lib/database/mysql/connect.js

@@ -1,23 +1,25 @@
 import { assertStatus } from "@mittwald/api-client-commons";
-import { getProject, getUser } from "../common.js";
+import { getProject } from "../common.js";
+import { getSSHConnectionForProject } from "../../ssh/project.js";
 export async function getConnectionDetailsWithPassword(apiClient, databaseId, p, flags) {
     const password = flags["temporary-user"] ? "" : await getPassword(p, flags);
+    const sshUser = flags["ssh-user"];
     return {
-        ...(await getConnectionDetails(apiClient, databaseId, p)),
+        ...(await getConnectionDetails(apiClient, databaseId, sshUser, p)),
         password,
     };
 }
-export async function getConnectionDetails(apiClient, databaseId, p) {
+export async function getConnectionDetails(apiClient, databaseId, sshUser, p) {
     const database = await getDatabase(apiClient, p, databaseId);
     const databaseUser = await getDatabaseUser(apiClient, p, databaseId);
     const project = await getProject(apiClient, p, database);
-    const user = await getUser(apiClient, p);
+    const sshConnectionData = await getSSHConnectionForProject(apiClient, database.projectId, sshUser);
     return {
         hostname: database.hostname,
         database: database.name,
         user: databaseUser.name,
-        sshHost: `ssh.${project.clusterID}.${project.clusterDomain}`,
-        sshUser: `${user.email}@${project.shortId}`,
+        sshHost: sshConnectionData.host,
+        sshUser: sshConnectionData.user,
         project,
     };
 }

package/dist/esm/lib/ssh/appinstall.d.ts

@@ -1,3 +1,3 @@
 import { MittwaldAPIV2Client } from "@mittwald/api-client";
 import { SSHConnectionData } from "./types.js";
-export declare function getSSHConnectionForAppInstallation(client: MittwaldAPIV2Client, appInstallationId: string): Promise<SSHConnectionData>;
+export declare function getSSHConnectionForAppInstallation(client: MittwaldAPIV2Client, appInstallationId: string, sshUser: string | undefined): Promise<SSHConnectionData>;

package/dist/esm/lib/ssh/appinstall.js

@@ -1,6 +1,6 @@
 import { assertStatus } from "@mittwald/api-client";
 import path from "path";
-export async function getSSHConnectionForAppInstallation(client, appInstallationId) {
+export async function getSSHConnectionForAppInstallation(client, appInstallationId, sshUser) {
     const appInstallationResponse = await client.app.getAppinstallation({
         appInstallationId,
     });
@@ -12,10 +12,13 @@ export async function getSSHConnectionForAppInstallation(client, appInstallation
         projectId: appInstallationResponse.data.projectId,
     });
     assertStatus(projectResponse, 200);
-    const userResponse = await client.user.getOwnAccount();
-    assertStatus(userResponse, 200);
+    if (sshUser === undefined) {
+        const userResponse = await client.user.getOwnAccount();
+        assertStatus(userResponse, 200);
+        sshUser = userResponse.data.email;
+    }
     const host = `ssh.${projectResponse.data.clusterID}.${projectResponse.data.clusterDomain}`;
-    const user = `${userResponse.data.email}@${appInstallationResponse.data.shortId}`;
+    const user = `${sshUser}@${appInstallationResponse.data.shortId}`;
     const directory = path.join(projectResponse.data.directories["Web"], appInstallationResponse.data.installationPath);
     return {
         host,

package/dist/esm/lib/ssh/exec.d.ts

@@ -5,4 +5,10 @@ export type RunTarget = {
 } | {
     projectId: string;
 };
-export declare function executeViaSSH(client: MittwaldAPIV2Client, target: RunTarget, command: string, args: string[], output: NodeJS.WritableStream): Promise<void>;
+export type RunCommand = {
+    command: string;
+    args: string[];
+} | {
+    shell: string;
+};
+export declare function executeViaSSH(client: MittwaldAPIV2Client, sshUser: string | undefined, target: RunTarget, command: RunCommand, output: NodeJS.WritableStream): Promise<void>;

package/dist/esm/lib/ssh/exec.js

@@ -1,9 +1,12 @@
 import cp from "child_process";
 import { getSSHConnectionForAppInstallation } from "./appinstall.js";
 import { getSSHConnectionForProject } from "./project.js";
-export async function executeViaSSH(client, target, command, args, output) {
-    const { user, host } = await connectionDataForTarget(client, target);
-    const sshArgs = ["-l", user, "-T", host, command, ...args];
+export async function executeViaSSH(client, sshUser, target, command, output) {
+    const { user, host } = await connectionDataForTarget(client, target, sshUser);
+    const sshCommandArgs = "shell" in command
+        ? ["bash", "-c", command.shell]
+        : [command.command, ...command.args];
+    const sshArgs = ["-l", user, "-T", host, ...sshCommandArgs];
     const ssh = cp.spawn("ssh", sshArgs, {
         stdio: ["ignore", "pipe", "pipe"],
     });
@@ -31,11 +34,11 @@ export async function executeViaSSH(client, target, command, args, output) {
         });
     });
 }
-async function connectionDataForTarget(client, target) {
+async function connectionDataForTarget(client, target, sshUser) {
     if ("appInstallationId" in target) {
-        return getSSHConnectionForAppInstallation(client, target.appInstallationId);
+        return getSSHConnectionForAppInstallation(client, target.appInstallationId, sshUser);
     }
     else {
-        return getSSHConnectionForProject(client, target.projectId);
+        return getSSHConnectionForProject(client, target.projectId, sshUser);
     }
 }

package/dist/esm/lib/ssh/flags.d.ts

@@ -0,0 +1,3 @@
+export declare const sshConnectionFlags: {
+    "ssh-user": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+};

package/dist/esm/lib/ssh/flags.js

@@ -0,0 +1,13 @@
+import { Flags } from "@oclif/core";
+export const sshConnectionFlags = {
+    "ssh-user": Flags.string({
+        summary: "override the SSH user to connect with; if omitted, your own user will be used",
+        description: "This flag can be used to override the SSH user that is used for a " +
+            "connection; be default, your own personal user will be used for this." +
+            "\n\n" +
+            "You can also set this value by setting the MITTWALD_SSH_USER environment variable.",
+        required: false,
+        default: undefined,
+        env: "MITTWALD_SSH_USER",
+    }),
+};

package/dist/esm/lib/ssh/project.d.ts

@@ -1,3 +1,3 @@
 import { MittwaldAPIV2Client } from "@mittwald/api-client";
 import { SSHConnectionData } from "./types.js";
-export declare function getSSHConnectionForProject(client: MittwaldAPIV2Client, projectId: string): Promise<SSHConnectionData>;
+export declare function getSSHConnectionForProject(client: MittwaldAPIV2Client, projectId: string, sshUser: string | undefined): Promise<SSHConnectionData>;

package/dist/esm/lib/ssh/project.js

@@ -1,11 +1,14 @@
 import { assertStatus } from "@mittwald/api-client";
-export async function getSSHConnectionForProject(client, projectId) {
+export async function getSSHConnectionForProject(client, projectId, sshUser) {
     const projectResponse = await client.project.getProject({ projectId });
     assertStatus(projectResponse, 200);
-    const userResponse = await client.user.getOwnAccount();
-    assertStatus(userResponse, 200);
+    if (sshUser === undefined) {
+        const userResponse = await client.user.getOwnAccount();
+        assertStatus(userResponse, 200);
+        sshUser = userResponse.data.email;
+    }
     const host = `ssh.${projectResponse.data.clusterID}.${projectResponse.data.clusterDomain}`;
-    const user = `${userResponse.data.email}@${projectResponse.data.shortId}`;
+    const user = `${sshUser}@${projectResponse.data.shortId}`;
     const directory = projectResponse.data.directories["Web"];
     return {
         host,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/cli",
-  "version": "1.0.0-alpha.35",
+  "version": "1.0.0-alpha.36",
   "description": "Hand-crafted CLI for the mittwald API",
   "license": "MIT",
   "author": {
@@ -71,6 +71,7 @@
     "pretty-bytes": "^6.1.0",
     "react": "^18.2.0",
     "semver": "^7.5.4",
+    "shell-escape": "^0.2.0",
     "tempfile": "^5.0.0"
   },
   "devDependencies": {
@@ -84,6 +85,7 @@
     "@types/pretty-bytes": "^5.2.0",
     "@types/react": "^18",
     "@types/semver": "^7.5.0",
+    "@types/shell-escape": "^0.2.3",
     "@typescript-eslint/eslint-plugin": "^6.9.1",
     "@typescript-eslint/parser": "^6.10.0",
     "@yarnpkg/pnpify": "^4.0.0-rc.48",