appwrite-cli 17.1.0 → 17.2.1

package/lib/commands/services/vcs.ts

@@ -26,7 +26,7 @@ export const vcs = new Command("vcs")
     helpWidth: process.stdout.columns || 80,
   });
 
-vcs
+const vcsCreateRepositoryDetectionCommand = vcs
   .command(`create-repository-detection`)
   .description(`Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -40,7 +40,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsListRepositoriesCommand = vcs
   .command(`list-repositories`)
   .description(`Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -54,7 +55,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsCreateRepositoryCommand = vcs
   .command(`create-repository`)
   .description(`Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -67,7 +69,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsGetRepositoryCommand = vcs
   .command(`get-repository`)
   .description(`Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -79,7 +82,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsListRepositoryBranchesCommand = vcs
   .command(`list-repository-branches`)
   .description(`Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
 `)
@@ -92,7 +96,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsGetRepositoryContentsCommand = vcs
   .command(`get-repository-contents`)
   .description(`Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -106,7 +111,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsUpdateExternalDeploymentsCommand = vcs
   .command(`update-external-deployments`)
   .description(`Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -119,7 +125,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsListInstallationsCommand = vcs
   .command(`list-installations`)
   .description(`List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
 `)
@@ -138,7 +145,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsGetInstallationCommand = vcs
   .command(`get-installation`)
   .description(`Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. `)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -149,7 +157,8 @@ vcs
     ),
   );
 
-vcs
+
+const vcsDeleteInstallationCommand = vcs
   .command(`delete-installation`)
   .description(`Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
@@ -160,3 +169,4 @@ vcs
     ),
   );
 
+

package/lib/commands/services/webhooks.ts

@@ -26,7 +26,7 @@ export const webhooks = new Command("webhooks")
     helpWidth: process.stdout.columns || 80,
   });
 
-webhooks
+const webhooksListCommand = webhooks
   .command(`list`)
   .description(`Get a list of all webhooks belonging to the project. You can use the query params to filter your results.`)
   .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, url, httpUser, security, events, enabled, logs, attempts`)
@@ -43,7 +43,8 @@ webhooks
     ),
   );
 
-webhooks
+
+const webhooksCreateCommand = webhooks
   .command(`create`)
   .description(`Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.`)
   .requiredOption(`--webhook-id <webhook-id>`, `Webhook ID. Choose a custom ID or generate a random ID with \`ID.unique()\`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
@@ -71,7 +72,8 @@ webhooks
     ),
   );
 
-webhooks
+
+const webhooksGetCommand = webhooks
   .command(`get`)
   .description(`Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. `)
   .requiredOption(`--webhook-id <webhook-id>`, `Webhook ID.`)
@@ -82,7 +84,8 @@ webhooks
     ),
   );
 
-webhooks
+
+const webhooksUpdateCommand = webhooks
   .command(`update`)
   .description(`Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.`)
   .requiredOption(`--webhook-id <webhook-id>`, `Webhook ID.`)
@@ -110,7 +113,8 @@ webhooks
     ),
   );
 
-webhooks
+
+const webhooksDeleteCommand = webhooks
   .command(`delete`)
   .description(`Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. `)
   .requiredOption(`--webhook-id <webhook-id>`, `Webhook ID.`)
@@ -121,7 +125,8 @@ webhooks
     ),
   );
 
-webhooks
+
+const webhooksUpdateSignatureCommand = webhooks
   .command(`update-signature`)
   .description(`Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.`)
   .requiredOption(`--webhook-id <webhook-id>`, `Webhook ID.`)
@@ -132,3 +137,4 @@ webhooks
     ),
   );
 
+

package/lib/constants.ts

@@ -1,7 +1,7 @@
 // SDK
 export const SDK_TITLE = 'Appwrite';
 export const SDK_TITLE_LOWER = 'appwrite';
-export const SDK_VERSION = '17.1.0';
+export const SDK_VERSION = '17.2.1';
 export const SDK_NAME = 'Command Line';
 export const SDK_PLATFORM = 'console';
 export const SDK_LANGUAGE = 'cli';

package/lib/emulation/docker.ts

@@ -219,6 +219,7 @@ export async function dockerStart(
   params.push("-p", `${port}:3000`);
   params.push("-e", "OPEN_RUNTIMES_ENV=development");
   params.push("-e", "OPEN_RUNTIMES_SECRET=");
+  params.push("-e", `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
 
   for (const k of Object.keys(variables)) {
     params.push("-e", `${k}=${variables[k]}`);

package/lib/parser.ts

@@ -1,5 +1,7 @@
 // @ts-expect-error BigInt toJSON polyfill for JSON.stringify support
-BigInt.prototype.toJSON = function () { return this.toString(); };
+BigInt.prototype.toJSON = function () {
+  return this.toString();
+};
 
 import chalk from "chalk";
 import { InvalidArgumentError } from "commander";
@@ -22,15 +24,32 @@ const cliConfig: CliConfig = {
   verbose: false,
   json: false,
   raw: false,
+  showSecrets: false,
   force: false,
   all: false,
   ids: [],
   report: false,
   reportData: {},
+  displayFields: [],
 };
 
 type JsonObject = Record<string, unknown>;
 
+const HIDDEN_VALUE = "[hidden]";
+const SENSITIVE_KEYS = new Set([
+  "secret",
+  "apikey",
+  "accesstoken",
+  "refreshtoken",
+  "password",
+  "jwt",
+  "clientsecret",
+  "secretkey",
+  "sessionsecret",
+]);
+let renderDepth = 0;
+let redactionApplied = false;
+
 interface ReportDataPayload {
   data?: {
     args?: string[];
@@ -58,6 +77,97 @@ const extractReportCommandArgs = (value: unknown): string[] => {
   return reportData.data.args;
 };
 
+const beginRender = (): void => {
+  if (renderDepth === 0) {
+    redactionApplied = false;
+  }
+
+  renderDepth++;
+};
+
+const endRender = (): void => {
+  renderDepth = Math.max(0, renderDepth - 1);
+
+  if (renderDepth === 0 && redactionApplied && !cliConfig.showSecrets) {
+    const message =
+      "Sensitive values were redacted. Pass --show-secrets to display them.";
+
+    if (cliConfig.json || cliConfig.raw) {
+      console.error(`${chalk.cyan.bold("♥ Hint:")} ${chalk.cyan(message)}`);
+    } else {
+      hint(message);
+    }
+  }
+};
+
+const withRender = <T>(callback: () => T): T => {
+  beginRender();
+
+  try {
+    return callback();
+  } finally {
+    endRender();
+  }
+};
+
+const isSensitiveKey = (key: string): boolean => {
+  const normalizedKey = key.toLowerCase().replace(/[^a-z0-9]/g, "");
+
+  return SENSITIVE_KEYS.has(normalizedKey);
+};
+
+const maskSensitiveString = (value: string): string => {
+  if (value.length <= 16) {
+    return HIDDEN_VALUE;
+  }
+
+  const separatorIndex = value.indexOf("_");
+  if (separatorIndex > 0 && separatorIndex < value.length - 9) {
+    const prefix = value.slice(0, separatorIndex + 1);
+    const tail = value.slice(-4);
+    return `${prefix}${HIDDEN_VALUE}${tail}`;
+  }
+
+  return `${HIDDEN_VALUE}${value.slice(-4)}`;
+};
+
+const maskSensitiveData = (value: unknown, key?: string): unknown => {
+  if (key && isSensitiveKey(key) && !cliConfig.showSecrets) {
+    redactionApplied = true;
+
+    if (typeof value === "string") {
+      return maskSensitiveString(value);
+    }
+
+    if (value == null) {
+      return value;
+    }
+
+    return HIDDEN_VALUE;
+  }
+
+  if (Array.isArray(value)) {
+    return value.map((item) => maskSensitiveData(item));
+  }
+
+  if (value && typeof value === "object") {
+    if (value?.constructor?.name === "BigNumber") {
+      return String(value);
+    }
+
+    const result: JsonObject = {};
+    for (const childKey of Object.keys(value as JsonObject)) {
+      const childValue = (value as JsonObject)[childKey];
+      if (typeof childValue === "function") continue;
+      result[childKey] = maskSensitiveData(childValue, childKey);
+    }
+
+    return result;
+  }
+
+  return value;
+};
+
 const filterObject = (obj: JsonObject): JsonObject => {
   const result: JsonObject = {};
   for (const key of Object.keys(obj)) {
@@ -75,6 +185,24 @@ const filterObject = (obj: JsonObject): JsonObject => {
   return result;
 };
 
+const applyDisplayFilter = (rows: JsonObject[]): JsonObject[] => {
+  if (cliConfig.displayFields.length === 0) {
+    return rows;
+  }
+
+  return rows.map((row) => {
+    const filtered: JsonObject = {};
+
+    for (const key of cliConfig.displayFields) {
+      if (Object.prototype.hasOwnProperty.call(row, key)) {
+        filtered[key] = row[key];
+      }
+    }
+
+    return Object.keys(filtered).length > 0 ? filtered : row;
+  });
+};
+
 const filterData = (data: JsonObject): JsonObject => {
   const result: JsonObject = {};
   for (const key of Object.keys(data)) {
@@ -104,49 +232,68 @@ const filterData = (data: JsonObject): JsonObject => {
 };
 
 export const parse = (data: JsonObject): void => {
-  if (cliConfig.raw) {
-    drawJSON(data);
-    return;
-  }
+  withRender(() => {
+    const sanitizedData = maskSensitiveData(data) as JsonObject;
 
-  if (cliConfig.json) {
-    drawJSON(filterData(data));
-    return;
-  }
+    if (cliConfig.raw) {
+      drawJSON(sanitizedData);
+      return;
+    }
 
-  const keys = Object.keys(data).filter((k) => typeof data[k] !== "function");
-  let printedScalar = false;
+    if (cliConfig.json) {
+      drawJSON(filterData(sanitizedData));
+      return;
+    }
 
-  for (const key of keys) {
-    const value = data[key];
-    if (value === null) {
-      console.log(`${chalk.yellow.bold(key)} : null`);
-      printedScalar = true;
-    } else if (Array.isArray(value)) {
-      if (printedScalar) console.log("");
-      console.log(`${chalk.yellow.bold.underline(key)}`);
-      if (typeof value[0] === "object") {
-        drawTable(value);
+    const keys = Object.keys(sanitizedData).filter(
+      (k) => typeof sanitizedData[k] !== "function",
+    );
+    let printedScalar = false;
+
+    for (const key of keys) {
+      const value = sanitizedData[key];
+      if (value == null) continue;
+      if (typeof value === "string" && value.trim() === "") continue;
+      if (Array.isArray(value)) {
+        if (value.length === 0) continue;
+        if (
+          value.every(
+            (item) =>
+              item &&
+              typeof item === "object" &&
+              !Array.isArray(item) &&
+              Object.keys(item).length === 0,
+          )
+        )
+          continue;
+        console.log();
+        console.log(`${chalk.yellow.bold.underline(key)}`);
+        if (typeof value[0] === "object") {
+          drawTable(value);
+        } else {
+          drawJSON(value);
+        }
+        console.log();
+        printedScalar = false;
+      } else if (typeof value === "object") {
+        if (value?.constructor?.name === "BigNumber") {
+          console.log(`${chalk.yellow.bold(key)} : ${value}`);
+          printedScalar = true;
+        } else {
+          const tableRow = toJsonObject(value) ?? {};
+          if (Object.keys(tableRow).length === 0) continue;
+          console.log();
+          console.log(`${chalk.yellow.bold.underline(key)}`);
+          drawTable([tableRow]);
+          console.log();
+          printedScalar = false;
+        }
       } else {
-        drawJSON(value);
-      }
-      printedScalar = false;
-    } else if (typeof value === "object") {
-      if (printedScalar) console.log("");
-      if (value?.constructor?.name === "BigNumber") {
         console.log(`${chalk.yellow.bold(key)} : ${value}`);
         printedScalar = true;
-      } else {
-        console.log(`${chalk.yellow.bold.underline(key)}`);
-        const tableRow = toJsonObject(value) ?? {};
-        drawTable([tableRow]);
-        printedScalar = false;
       }
-    } else {
-      console.log(`${chalk.yellow.bold(key)} : ${value}`);
-      printedScalar = true;
     }
-  }
+  });
 };
 
 const MAX_COL_WIDTH = 40;
@@ -171,104 +318,114 @@ const formatCellValue = (value: unknown): string => {
 };
 
 export const drawTable = (data: Array<JsonObject | null | undefined>): void => {
-  if (data.length == 0) {
-    console.log("[]");
-    return;
-  }
-
-  const rows = data.map((item): JsonObject => toJsonObject(item) ?? {});
+  withRender(() => {
+    if (data.length == 0) {
+      console.log("[]");
+      return;
+    }
 
-  // Create an object with all the keys in it
-  const obj = rows.reduce((res, item) => ({ ...res, ...item }), {});
-  // Get those keys as an array
-  const allKeys = Object.keys(obj);
-  if (allKeys.length === 0) {
-    drawJSON(data);
-    return;
-  }
+    const rows = applyDisplayFilter(
+      data.map((item): JsonObject => {
+        const maskedItem = maskSensitiveData(item);
+        return toJsonObject(maskedItem) ?? {};
+      }),
+    );
+
+    // Create an object with all the keys in it
+    const obj = rows.reduce((res, item) => ({ ...res, ...item }), {});
+    // Get those keys as an array
+    const allKeys = Object.keys(obj);
+    if (allKeys.length === 0) {
+      drawJSON(data);
+      return;
+    }
 
-  // If too many columns, show condensed key-value output with only scalar, non-empty fields
-  const maxColumns = 6;
-  if (allKeys.length > maxColumns) {
-    // Collect visible entries per row to compute alignment
-    const rowEntries = rows.map((row) => {
-      const entries: Array<[string, string]> = [];
-      for (const key of Object.keys(row)) {
-        const value = row[key];
-        if (typeof value === "function") continue;
-        if (value == null) continue;
-        if (value?.constructor?.name === "BigNumber") {
+    // If too many columns, show condensed key-value output with only scalar, non-empty fields
+    const maxColumns = 6;
+    if (allKeys.length > maxColumns) {
+      // Collect visible entries per row to compute alignment
+      const rowEntries = rows.map((row) => {
+        const entries: Array<[string, string]> = [];
+        for (const key of Object.keys(row)) {
+          const value = row[key];
+          if (typeof value === "function") continue;
+          if (value == null) continue;
+          if (value?.constructor?.name === "BigNumber") {
+            entries.push([key, String(value)]);
+            continue;
+          }
+          if (typeof value === "object") continue;
+          if (typeof value === "string" && value.trim() === "") continue;
           entries.push([key, String(value)]);
-          continue;
         }
-        if (typeof value === "object") continue;
-        if (typeof value === "string" && value.trim() === "") continue;
-        entries.push([key, String(value)]);
+        return entries;
+      });
+
+      const flatEntries = rowEntries.flat();
+      if (flatEntries.length === 0) {
+        drawJSON(data);
+        return;
       }
-      return entries;
-    });
 
-    const flatEntries = rowEntries.flat();
-    if (flatEntries.length === 0) {
-      drawJSON(data);
+      const maxKeyLen = Math.max(...flatEntries.map(([key]) => key.length));
+
+      const separatorLen = Math.min(
+        maxKeyLen + 2 + MAX_COL_WIDTH,
+        process.stdout.columns || 80,
+      );
+
+      rowEntries.forEach((entries, idx) => {
+        if (idx > 0) console.log(chalk.cyan("─".repeat(separatorLen)));
+        for (const [key, value] of entries) {
+          const paddedKey = key.padEnd(maxKeyLen);
+          console.log(`${chalk.yellow.bold(paddedKey)}  ${value}`);
+        }
+      });
       return;
     }
 
-    const maxKeyLen = Math.max(...flatEntries.map(([key]) => key.length));
-
-    const separatorLen = Math.min(maxKeyLen + 2 + MAX_COL_WIDTH, process.stdout.columns || 80);
+    const columns = allKeys;
+
+    // Create an object with all keys set to the default value ''
+    const def = allKeys.reduce((result: Record<string, string>, key) => {
+      result[key] = "-";
+      return result;
+    }, {});
+    // Use object destructuring to replace all default values with the ones we have
+    const normalizedData = rows.map((item) => ({ ...def, ...item }));
+
+    const table = new Table({
+      head: columns.map((c) => chalk.cyan.italic.bold(c)),
+      colWidths: columns.map(() => null) as (number | null)[],
+      wordWrap: false,
+      chars: {
+        "top": " ",
+        "top-mid": " ",
+        "top-left": " ",
+        "top-right": " ",
+        "bottom": " ",
+        "bottom-mid": " ",
+        "bottom-left": " ",
+        "bottom-right": " ",
+        "left": " ",
+        "left-mid": " ",
+        "mid": chalk.cyan("─"),
+        "mid-mid": chalk.cyan("┼"),
+        "right": " ",
+        "right-mid": " ",
+        "middle": chalk.cyan("│"),
+      },
+    });
 
-    rowEntries.forEach((entries, idx) => {
-      if (idx > 0) console.log(chalk.cyan("─".repeat(separatorLen)));
-      for (const [key, value] of entries) {
-        const paddedKey = key.padEnd(maxKeyLen);
-        console.log(`${chalk.yellow.bold(paddedKey)}  ${value}`);
+    normalizedData.forEach((row) => {
+      const rowValues: string[] = [];
+      for (const key of columns) {
+        rowValues.push(formatCellValue(row[key]));
       }
+      table.push(rowValues);
     });
-    return;
-  }
-
-  const columns = allKeys;
-
-  // Create an object with all keys set to the default value ''
-  const def = allKeys.reduce((result: Record<string, string>, key) => {
-    result[key] = "-";
-    return result;
-  }, {});
-  // Use object destructuring to replace all default values with the ones we have
-  const normalizedData = rows.map((item) => ({ ...def, ...item }));
-
-  const table = new Table({
-    head: columns.map((c) => chalk.cyan.italic.bold(c)),
-    colWidths: columns.map(() => null) as (number | null)[],
-    wordWrap: false,
-    chars: {
-      top: " ",
-      "top-mid": " ",
-      "top-left": " ",
-      "top-right": " ",
-      bottom: " ",
-      "bottom-mid": " ",
-      "bottom-left": " ",
-      "bottom-right": " ",
-      left: " ",
-      "left-mid": " ",
-      mid: chalk.cyan("─"),
-      "mid-mid": chalk.cyan("┼"),
-      right: " ",
-      "right-mid": " ",
-      middle: chalk.cyan("│"),
-    },
-  });
-
-  normalizedData.forEach((row) => {
-    const rowValues: string[] = [];
-    for (const key of columns) {
-      rowValues.push(formatCellValue(row[key]));
-    }
-    table.push(rowValues);
+    console.log(table.toString());
   });
-  console.log(table.toString());
 };
 
 export const drawJSON = (data: unknown): void => {
@@ -403,7 +560,7 @@ export const commandDescriptions: Record<string, string> = {
   avatars: `The avatars command aims to help you complete everyday tasks related to your app image, icons, and avatars.`,
   databases: `(Legacy) The databases command allows you to create structured collections of documents and query and filter lists of documents.`,
   "tables-db": `The tables-db command allows you to create structured tables of columns and query and filter lists of rows.`,
-  init: `The init command provides a convenient wrapper for creating and initializing projects, functions, collections, buckets, teams, and messaging-topics in ${SDK_TITLE}.`,
+  init: `The init command provides a convenient wrapper for creating and initializing projects, functions, collections, buckets, teams, messaging-topics, and agent skills in ${SDK_TITLE}.`,
   push: `The push command provides a convenient wrapper for pushing your functions, collections, buckets, teams, and messaging-topics.`,
   run: `The run command allows you to run the project locally to allow easy development and quick debugging.`,
   functions: `The functions command allows you to view, create, and manage your Cloud Functions.`,