Adds list cmd to deconfig

Signed-off-by: Marcos Candeia <[email protected]>

Author: mcandeia

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deco-cli",
-  "version": "0.19.0",
+  "version": "0.19.2",
   "description": "CLI for managing decocms.com apps & projects",
   "license": "MIT",
   "author": "Deco team",
@@ -76,4 +76,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

packages/cli/src/cli.ts

@@ -78,6 +78,7 @@ import {
   watchCommand,
   pushCommand,
   pullCommand,
+  listCommand,
 } from "./commands/deconfig/index.js";
 import { detectRuntime } from "./lib/runtime.js";
 
@@ -539,7 +540,7 @@ const gen = new Command("gen")
 const deconfigGet = new Command("get")
   .description("Get a file from a deconfig branch.")
   .argument("<path>", "File path to get")
-  .requiredOption("-b, --branch <branchName>", "Branch name")
+  .option("-b, --branch <branchName>", "Branch name", "main")
   .option("-o, --output <file>", "Output file (defaults to stdout)")
   .option("-w, --workspace <workspace>", "Workspace name")
   .action(async (path, options) => {
@@ -567,7 +568,7 @@ const deconfigGet = new Command("get")
 const deconfigPut = new Command("put")
   .description("Put a file to a deconfig branch.")
   .argument("<path>", "File path to put")
-  .requiredOption("-b, --branch <branchName>", "Branch name")
+  .option("-b, --branch <branchName>", "Branch name", "main")
   .option("-f, --file <file>", "Local file to upload")
   .option("-c, --content <content>", "Content to upload")
   .option("-m, --metadata <metadata>", "Metadata JSON string")
@@ -598,7 +599,7 @@ const deconfigPut = new Command("put")
 // Watch command for deconfig
 const deconfigWatch = new Command("watch")
   .description("Watch a deconfig branch for changes.")
-  .requiredOption("-b, --branch <branchName>", "Branch name")
+  .option("-b, --branch <branchName>", "Branch name", "main")
   .option("-p, --path <path>", "Path filter for watching specific files")
   .option(
     "--from-ctime <ctime>",
@@ -631,7 +632,7 @@ const deconfigWatch = new Command("watch")
 // Clone command for deconfig
 const deconfigClone = new Command("clone")
   .description("Clone a deconfig branch to a local directory.")
-  .requiredOption("-b, --branch <branchName>", "Branch name to clone")
+  .option("-b, --branch <branchName>", "Branch name to clone", "main")
   .requiredOption("--path <path>", "Local directory path to clone files to")
   .option("--path-filter <filter>", "Filter files by path pattern")
   .option("-w, --workspace <workspace>", "Workspace name")
@@ -659,7 +660,7 @@ const deconfigClone = new Command("clone")
 // Push command for deconfig
 const deconfigPush = new Command("push")
   .description("Push local files to a deconfig branch.")
-  .requiredOption("-b, --branch <branchName>", "Branch name to push to")
+  .option("-b, --branch <branchName>", "Branch name to push to", "main")
   .requiredOption("--path <path>", "Local directory path to push files from")
   .option("--path-filter <filter>", "Filter files by path pattern")
   .option("--dry-run", "Show what would be pushed without making changes")
@@ -689,7 +690,7 @@ const deconfigPush = new Command("push")
 // Pull command for deconfig
 const deconfigPull = new Command("pull")
   .description("Pull changes from a deconfig branch to local directory.")
-  .requiredOption("-b, --branch <branchName>", "Branch name to pull from")
+  .option("-b, --branch <branchName>", "Branch name to pull from", "main")
   .requiredOption("--path <path>", "Local directory path to pull files to")
   .option("--path-filter <filter>", "Filter files by path pattern")
   .option("--dry-run", "Show what would be changed without making changes")
@@ -716,6 +717,38 @@ const deconfigPull = new Command("pull")
     }
   });
 
+// List command for deconfig
+const deconfigList = new Command("list")
+  .description("Interactively browse and view files in a deconfig branch.")
+  .option("-b, --branch <branchName>", "Branch name to list files from", "main")
+  .option("--path-filter <filter>", "Filter files by path pattern")
+  .option(
+    "--format <format>",
+    "Content display format: plainString, json, base64",
+    "plainString",
+  )
+  .option("-w, --workspace <workspace>", "Workspace name")
+  .action(async (options) => {
+    try {
+      const config = await getConfig({
+        inlineOptions: { workspace: options.workspace },
+      });
+      await listCommand({
+        branchName: options.branch,
+        pathFilter: options.pathFilter,
+        format: options.format,
+        workspace: config.workspace,
+        local: config.local,
+      });
+    } catch (error) {
+      console.error(
+        "❌ List failed:",
+        error instanceof Error ? error.message : String(error),
+      );
+      process.exit(1);
+    }
+  });
+
 // Deconfig parent command
 const deconfig = new Command("deconfig")
   .description("Manage deconfig filesystem operations.")
@@ -724,7 +757,8 @@ const deconfig = new Command("deconfig")
   .addCommand(deconfigWatch)
   .addCommand(deconfigClone)
   .addCommand(deconfigPush)
-  .addCommand(deconfigPull);
+  .addCommand(deconfigPull)
+  .addCommand(deconfigList);
 
 // Main CLI program
 const program = new Command()

packages/cli/src/commands/deconfig/index.ts

@@ -4,3 +4,4 @@ export { watchCommand } from "./watch.js";
 export { cloneCommand } from "./clone.js";
 export { pushCommand } from "./push.js";
 export { pullCommand } from "./pull.js";
+export { listCommand } from "./list.js";

packages/cli/src/commands/deconfig/list.ts

@@ -0,0 +1,244 @@
+import inquirer from "inquirer";
+import { fetchFileContent } from "./base.js";
+import process from "node:process";
+
+interface ListOptions {
+  branchName: string;
+  pathFilter?: string;
+  workspace?: string;
+  local?: boolean;
+  format?: "plainString" | "json" | "base64";
+}
+
+interface FileInfo {
+  address: string;
+  metadata: Record<string, unknown>;
+  sizeInBytes: number;
+  mtime: number;
+  ctime: number;
+}
+
+export async function listCommand(options: ListOptions): Promise<void> {
+  const {
+    branchName,
+    pathFilter,
+    workspace,
+    local,
+    format = "plainString",
+  } = options;
+
+  console.log(`📋 Listing files in branch "${branchName}"...`);
+  if (pathFilter) {
+    console.log(`   🔍 Path filter: ${pathFilter}`);
+  }
+
+  // Get list of files from the branch
+  const { createWorkspaceClient } = await import("../../lib/mcp.js");
+  const client = await createWorkspaceClient({ workspace, local });
+
+  try {
+    const response = await client.callTool({
+      name: "LIST_FILES",
+      arguments: {
+        branch: branchName,
+        prefix: pathFilter,
+      },
+    });
+
+    if (response.isError) {
+      const errorMessage = Array.isArray(response.content)
+        ? response.content[0]?.text || "Failed to list files"
+        : "Failed to list files";
+      throw new Error(errorMessage);
+    }
+
+    const result = response.structuredContent as {
+      files: Record<string, FileInfo>;
+      count: number;
+    };
+
+    if (result.count === 0) {
+      console.log("📂 No files found in this branch.");
+      return;
+    }
+
+    console.log(`📋 Found ${result.count} files`);
+
+    // Prepare file choices for interactive selection
+    const fileChoices = Object.entries(result.files).map(([path, info]) => {
+      const size = formatFileSize(info.sizeInBytes);
+      const lastModified = new Date(info.mtime).toLocaleString();
+      return {
+        name: `${path} (${size}, modified: ${lastModified})`,
+        value: path,
+        short: path,
+      };
+    });
+
+    // Add option to exit
+    fileChoices.push({
+      name: "🚪 Exit",
+      value: "__EXIT__",
+      short: "Exit",
+    });
+
+    while (true) {
+      // Interactive file selection
+      const { selectedFile } = await inquirer.prompt([
+        {
+          type: "list",
+          name: "selectedFile",
+          message: "Select a file to view its content:",
+          choices: fileChoices,
+          pageSize: 15,
+        },
+      ]);
+
+      if (selectedFile === "__EXIT__") {
+        console.log("👋 Goodbye!");
+        break;
+      }
+
+      // Display file content
+      try {
+        console.log(`\n📄 Loading content for: ${selectedFile}`);
+
+        const content = await fetchFileContent(
+          selectedFile,
+          branchName,
+          workspace,
+          local,
+        );
+
+        const fileInfo = result.files[selectedFile];
+
+        console.log(`\n${"=".repeat(60)}`);
+        console.log(`📁 File: ${selectedFile}`);
+        console.log(`📊 Size: ${formatFileSize(fileInfo.sizeInBytes)}`);
+        console.log(
+          `⏰ Modified: ${new Date(fileInfo.mtime).toLocaleString()}`,
+        );
+        console.log(`🏷️  Address: ${fileInfo.address}`);
+        if (Object.keys(fileInfo.metadata).length > 0) {
+          console.log(
+            `📋 Metadata: ${JSON.stringify(fileInfo.metadata, null, 2)}`,
+          );
+        }
+        console.log(`${"=".repeat(60)}\n`);
+
+        // Display content based on format
+        let displayContent: string;
+
+        switch (format) {
+          case "json":
+            try {
+              const text = content.toString("utf-8");
+              const parsed = JSON.parse(text);
+              displayContent = JSON.stringify(parsed, null, 2);
+            } catch {
+              displayContent = content.toString("utf-8");
+            }
+            break;
+          case "base64":
+            displayContent = content.toString("base64");
+            break;
+          case "plainString":
+          default:
+            displayContent = content.toString("utf-8");
+            break;
+        }
+
+        // For large files, show a preview with option to see more
+        const lines = displayContent.split("\n");
+        const maxPreviewLines = 50;
+
+        if (lines.length > maxPreviewLines) {
+          console.log(lines.slice(0, maxPreviewLines).join("\n"));
+          console.log(`\n... (${lines.length - maxPreviewLines} more lines)`);
+
+          const { showMore } = await inquirer.prompt([
+            {
+              type: "confirm",
+              name: "showMore",
+              message: "Show the complete file content?",
+              default: false,
+            },
+          ]);
+
+          if (showMore) {
+            console.log(`\n${"=".repeat(60)}`);
+            console.log("📄 Complete file content:");
+            console.log(`${"=".repeat(60)}\n`);
+            console.log(displayContent);
+          }
+        } else {
+          console.log(displayContent);
+        }
+
+        console.log(`\n${"=".repeat(60)}\n`);
+
+        // Ask if user wants to continue browsing
+        const { continueReading } = await inquirer.prompt([
+          {
+            type: "confirm",
+            name: "continueReading",
+            message: "Continue browsing files?",
+            default: true,
+          },
+        ]);
+
+        if (!continueReading) {
+          console.log("👋 Goodbye!");
+          break;
+        }
+      } catch (error) {
+        console.error(
+          `❌ Failed to read file ${selectedFile}:`,
+          error instanceof Error ? error.message : String(error),
+        );
+
+        const { tryAgain } = await inquirer.prompt([
+          {
+            type: "confirm",
+            name: "tryAgain",
+            message: "Continue browsing other files?",
+            default: true,
+          },
+        ]);
+
+        if (!tryAgain) {
+          break;
+        }
+      }
+    }
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : String(error);
+
+    if (
+      errorMessage.includes("Session not found") ||
+      errorMessage.includes("Session expired")
+    ) {
+      console.error("💥 List failed: Authentication required");
+      console.error(
+        "   Please run 'deco login' first to authenticate with deco.chat",
+      );
+    } else {
+      console.error("💥 List failed:", errorMessage);
+    }
+
+    process.exit(1);
+  } finally {
+    // Always close the client connection
+    await client.close();
+  }
+}
+
+function formatFileSize(bytes: number): string {
+  if (bytes === 0) return "0 B";
+
+  const k = 1024;
+  const sizes = ["B", "KB", "MB", "GB"];
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+
+  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(1))} ${sizes[i]}`;
+}