feat: add req subcommands for managing requirements.txt (#5)

* feat: add req subcommands for managing requirements.txt

* bump: version 2.1.9

* fix: address codex review comments (flag consistency, regex-based pkg parsing, error handling)

---------

Co-authored-by: Luna <clawy@reversed.dev>

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 dist
 build
-pnpm-lock.yaml
+pnpm-lock.yaml
+testing

OpenclawSkill.md

@@ -16,7 +16,6 @@ shsf health
 this will check the health, and if not setup, it will prompt you to set up the CLI.
 
 ## Commands
-
 - `shsf count functions`: Count your functions. Add `--full` to list them.
 - `shsf count namespaces`: Count your namespaces. Add `--full` to list them.
 - `shsf count storages`: Count your storages. Add `--full` to list them.
@@ -51,6 +50,12 @@ this will check the health, and if not setup, it will prompt you to set up the C
 - `shsf file delete`: Delete a file from a storage. (use `shsf file delete -h` first)
 - `shsf file list`: List files in a storage. (use `shsf file list -h` first)
 
+- `shsf remote pull --id <id> --into <path> [--force]`: Pull files from a function into a local directory.
+- `shsf remote push --id <id> --from <path> [--force]`: Push files from a local directory to a function.
+
+- `shsf req add <package> --id <functionid>`: Add a package to the requirements.txt of a function.
+- `shsf req remove <package> --id <functionid>`: Remove a package from the requirements.txt of a function.
+
 ## Instructions
 Use these commands for when you need to interact with shsf from the command line. Its faster than using the ui for almost all ops.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shsf-cli",
-  "version": "2.1.6",
+  "version": "2.1.9",
   "description": "",
   "type": "module",
   "files": [

src/__tests__/url_prefix.test.ts

@@ -0,0 +1,44 @@
+import { describe, it, expect } from 'vitest';
+import { readFileSync, readdirSync, statSync } from 'fs';
+import path from 'path';
+
+function getFilesRecursively(dir: string): string[] {
+  let files: string[] = [];
+  const items = readdirSync(dir);
+  for (const item of items) {
+    const fullPath = path.join(dir, item);
+    if (statSync(fullPath).isDirectory()) {
+      if (item !== '__tests__') {
+        files = files.concat(getFilesRecursively(fullPath));
+      }
+    } else if (item.endsWith('.ts')) {
+      files.push(fullPath);
+    }
+  }
+  return files;
+}
+
+describe('API URL validation', () => {
+  it('should ensure all API client calls start with /api/', () => {
+    const tsFiles = getFilesRecursively('src');
+    const violations: string[] = [];
+
+    // Regex to match common patterns like client.get('/path') or client.post(`/path`)
+    // specifically looking for paths that start with / but NOT /api/ or /health
+    const urlPattern = /client\.(get|post|put|delete|patch)\(['"`]\/(?!(api|health)\/)[^'"`]+['"`]/g;
+
+    tsFiles.forEach(file => {
+      const content = readFileSync(file, 'utf-8');
+      let match;
+      while ((match = urlPattern.exec(content)) !== null) {
+        // Double check for exact /health match (without trailing slash)
+        if (match[0].includes("'/health'") || match[0].includes('"/health"') || match[0].includes('`/health`')) {
+          continue;
+        }
+        violations.push(`${file}: ${match[0]}`);
+      }
+    });
+
+    expect(violations, `Found API calls not starting with /api/:\n${violations.join('\n')}`).toHaveLength(0);
+  });
+});

src/commands/remote/pull.ts

@@ -0,0 +1,37 @@
+import chalk from "chalk";
+import { getApiClient } from "../../api.js";
+import fs from "fs";
+import path from "path";
+
+export const pullDefinition = {
+  name: "pull",
+  description: "Pull files from a remote function.",
+  options: [
+    { name: "--id <id>", description: "Function ID", required: true },
+    { name: "--into <path>", description: "Target directory", required: true },
+    { name: "--force", description: "Force overwrite" },
+  ],
+  action: async (options: any) => {
+    const client = await getApiClient();
+
+    try {
+      const response = await client.get(`/api/function/${options.id}/files`);
+      const files = response.data.data; // Expecting { name: string, content: string }[]
+
+      if (!fs.existsSync(options.into)) {
+        fs.mkdirSync(options.into, { recursive: true });
+      } else if (fs.readdirSync(options.into).length > 0 && !options.force) {
+        console.error(chalk.red(`Directory ${options.into} is not empty. Use --force to overwrite.`));
+        return;
+      }
+      for (const file of files) {
+        fs.writeFileSync(path.join(options.into, file.name), file.content);
+        const byteSize = Buffer.byteLength(file.content, 'utf8');
+        console.log(chalk.green(`Pulled ${file.name} (${byteSize} bytes)`));
+      }
+      console.log(chalk.green(`Successfully pulled ${files.length} files into ${options.into}`));
+    } catch (error: any) {
+      console.error(chalk.red(`Failed to pull files: ${error.message}`));
+    }
+  },
+};

src/commands/remote/push.ts

@@ -0,0 +1,159 @@
+import chalk from "chalk";
+import { getApiClient } from "../../api.js";
+import fs from "fs";
+import path from "path";
+import { createHash } from "crypto";
+
+async function deleteNonexistentFiles(
+  currentFiles: any[],
+  files: any[],
+  client: any,
+  options: any,
+): Promise<{ didDeletion: boolean }> {
+  let didDeletion = false;
+  for (const currentFile of currentFiles) {
+    if (!files.some((f: any) => f.filename === currentFile.name)) {
+      try {
+      await client.delete(
+        `/api/function/${options.id}/file/${currentFile.id}`,
+        {
+          data: { filename: currentFile.name },
+        },
+      );} catch (error: any) {
+        throw error;
+      }
+      console.log(
+        chalk.green(`Deleted ${currentFile.name} from function ${options.id}`),
+      );
+      didDeletion = true;
+    }
+  }
+  return { didDeletion };
+}
+
+export const pushDefinition = {
+  name: "push",
+  description: "Push files to a remote function.",
+  options: [
+    { name: "--id <id>", description: "Function ID", required: true },
+    { name: "--from <path>", description: "Source directory", required: true },
+    { name: "--force", description: "Force overwrite" },
+  ],
+  action: async (options: any) => {
+    const client = await getApiClient();
+
+    if (!fs.existsSync(options.from)) {
+      console.error(chalk.red(`Source ${options.from} does not exist.`));
+      return;
+    }
+
+    let didDeletion = false; // Track if any deletions were made
+
+    const currentFilesResponse = await client.get(
+      `/api/function/${options.id}/files`,
+    );
+    const currentFiles = currentFilesResponse.data.data; // Expecting { name: string, id: string [...] }[]
+
+    const files = fs.readdirSync(options.from).map((file) => ({
+      filename: file,
+      content: fs.readFileSync(path.join(options.from, file), "utf-8"),
+    }));
+
+    if (!options.force && files.length > 5) {
+      console.log(
+        chalk.yellow("Too many modifications. Please use --force to confirm."),
+      );
+      return;
+    }
+
+    // Push new and modified files
+    let pushedFilesCount = 0;
+    try {
+      for (const file of files) {
+        // Hash first, save traffic
+        const fileHash = createHash("md5").update(file.content).digest("hex");
+        const currentFile = currentFiles.find(
+          (f: any) => f.name === file.filename,
+        );
+        if (currentFile) {
+          // If the file content exists in the response, we can hash it. 
+          // Note: currentFiles from /api/function/:id/files might not have content by default depending on API,
+          // but the original code assumes it does.
+          const currentFileHash = createHash("md5")
+            .update(currentFile.content || "")
+            .digest("hex");
+          if (fileHash === currentFileHash) {
+            console.log(
+              chalk.yellow(
+                `Skipping ${file.filename}, no changes detected for function ${options.id}`,
+              ),
+            );
+            continue;
+          }
+        }
+
+        await client.put(`/api/function/${options.id}/file`, {
+          filename: file.filename,
+          code: file.content,
+        });
+
+        const byteSize = Buffer.byteLength(file.content, 'utf8');
+        console.log(
+          chalk.green(`Pushed ${file.filename} (${byteSize} bytes) to function ${options.id}`),
+        );
+        pushedFilesCount++;
+      }
+
+      // Delete files that no longer exist on the remote AFTER pushing new/updated files
+      // This avoids the "cannot delete only file" error if we are pushing at least one file.
+      try {
+        const deletionResult = await deleteNonexistentFiles(
+          currentFiles,
+          files,
+          client,
+          options,
+        );
+        if (deletionResult.didDeletion) {
+          didDeletion = true;
+        }
+      } catch (error: any) {
+        if (error.response) {
+          console.error(
+            chalk.red(
+              `Failed to delete files: ${error.response.data?.message || error.response.statusText}`,
+            ),
+          );
+        } else {
+          console.error(chalk.red(`Error during deletion: ${error.message}`));
+        }
+      }
+
+      console.log(
+        chalk.green(
+          `Successfully pushed ${pushedFilesCount} files to function ${options.id}`,
+        ),
+      );
+
+      if (didDeletion) {
+        console.log("");
+        console.log(
+          chalk.blue(
+            `Hint: We might delete files that you renamed, but don't worry, we'll push the newly named file right after!`,
+          ),
+        );
+      }
+    } catch (error: any) {
+      if (error.response) {
+        console.error(
+          chalk.red(
+            `Failed to push files: ${error.response.data?.message || error.response.statusText}`,
+          ),
+        );
+      } else if (error.request) {
+        console.error(chalk.red("No response received from server."));
+      } else {
+        console.error(chalk.red(`Error: ${error.message}`));
+      }
+    }
+  },
+};

src/commands/req/add.ts

@@ -0,0 +1,99 @@
+import chalk from "chalk";
+import { getApiClient } from "../../api.js";
+
+interface ShsfFile {
+  name: string;
+  content: string;
+}
+
+export const reqAddDefinition = {
+  name: "add <package>",
+  description: "Add a package to the requirements.txt of a function.",
+  options: [
+    { name: "--to <id>", description: "The ID of the function (deprecated alias for --id)." },
+    { name: "--id <id>", description: "The ID of the function.", required: true },
+  ],
+  action: async (pkg: string, options: { to?: string; id?: string }) => {
+    const functionId = options.id ?? options.to;
+    if (!functionId) {
+      console.error(`${chalk.red("✗")} Error: Function ID is required. Use ${chalk.cyan("--id <id>")}.`);
+      return;
+    }
+    const client = await getApiClient();
+
+    try {
+      // 1. Get current files of the function
+      const response = await client.get(`/api/function/${functionId}/files`);
+      let files: ShsfFile[] = response.data.data;
+      if (!Array.isArray(files)) files = [];
+
+      let requirementsFile = files.find(f => f.name === "requirements.txt");
+      let content = requirementsFile ? requirementsFile.content : "";
+
+      // 2. Add the package
+      const lines = content.split("\n");
+      
+      // Robust package name extraction
+      const getPkgName = (line: string) => {
+        const withoutComment = line.trim().split("#", 1)[0];
+        const basePart = withoutComment.split(";", 1)[0].trim();
+        if (!basePart) return null;
+        return basePart.split(/[!=>~<]/)[0].trim().toLowerCase();
+      };
+
+      const pkgToAddName = getPkgName(pkg);
+      if (!pkgToAddName) {
+        console.error(`${chalk.red("✗")} Invalid package format.`);
+        return;
+      }
+
+      const exists = lines.some(line => {
+        const lineName = getPkgName(line);
+        return lineName === pkgToAddName;
+      });
+
+      if (exists) {
+        console.log(`${chalk.yellow("!")} Package ${chalk.cyan(pkgToAddName)} is already in requirements.txt.`);
+        return;
+      }
+
+      // Preserve existing content structure
+      if (content && !content.endsWith("\n")) {
+        content += "\n";
+      }
+      content += pkg + "\n";
+
+      // 3. Get function details to find storageId
+      const funcResponse = await client.get(`/api/function/${functionId}`);
+      const func = funcResponse.data.data;
+      if (!func || !func.namespace || !func.namespace.storageId) {
+        throw new Error("Could not determine storage ID for function.");
+      }
+      const storageId = func.namespace.storageId;
+
+      // 4. Overwrite/Create requirements.txt
+      await client.put(`/api/storage/${storageId}/files`, {
+        path: "requirements.txt",
+        content: content
+      });
+
+      console.log(`${chalk.green("✓")} Added ${chalk.cyan(pkg)} to requirements.txt for function ${chalk.yellow(functionId)}.`);
+    } catch (error: any) {
+      handleError(error, "add package");
+    }
+  },
+};
+
+function handleError(error: any, task: string) {
+  if (error.response) {
+    console.error(`${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(error.response.data?.message || error.message)}`);
+  } else if (error.request) {
+    console.error(
+      `${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(
+        "No response received from server. Please check your network connection and try again."
+      )}`
+    );
+  } else {
+    console.error(`${chalk.red("✗")} Error: ${error.message}`);
+  }
+}

src/commands/req/remove.ts

@@ -0,0 +1,105 @@
+import chalk from "chalk";
+import { getApiClient } from "../../api.js";
+
+interface ShsfFile {
+  name: string;
+  content: string;
+}
+
+export const reqRemoveDefinition = {
+  name: "remove <package>",
+  description: "Remove a package from the requirements.txt of a function.",
+  options: [
+    { name: "--from <id>", description: "The ID of the function (deprecated alias for --id)." },
+    { name: "--id <id>", description: "The ID of the function.", required: true },
+  ],
+  action: async (pkgToRemove: string, options: { from?: string; id?: string }) => {
+    const functionId = options.id ?? options.from;
+    if (!functionId) {
+      console.error(`${chalk.red("✗")} Error: Function ID is required. Use ${chalk.cyan("--id <id>")}.`);
+      return;
+    }
+    const client = await getApiClient();
+
+    try {
+      // 1. Get current files of the function
+      const response = await client.get(`/api/function/${functionId}/files`);
+      let files: ShsfFile[] = response.data.data;
+      if (!Array.isArray(files)) files = [];
+
+      const requirementsFile = files.find(f => f.name === "requirements.txt");
+      if (!requirementsFile) {
+        console.log(`${chalk.yellow("!")} No requirements.txt found for function ${chalk.yellow(functionId)}.`);
+        return;
+      }
+
+      const content = requirementsFile.content;
+      const lines = content.split("\n");
+      
+      const targetPkgName = pkgToRemove.trim().toLowerCase();
+      let removed = false;
+      
+      const newLines = lines.filter(line => {
+        const trimmedLine = line.trim();
+        // Preserve empty/whitespace-only lines
+        if (!trimmedLine) return true;
+        
+        // Strip inline comments and environment markers for matching purposes
+        const withoutComment = trimmedLine.split("#", 1)[0];
+        const basePart = withoutComment.split(";", 1)[0].trim();
+
+        // If there's no actual requirement (e.g., comment-only line), keep the line
+        if (!basePart) return true;
+
+        // Robust extraction (handles != <= >= ~= == and < >)
+        const currentPkgName = basePart.split(/[!=>~<]/)[0].trim().toLowerCase();
+        
+        if (currentPkgName === targetPkgName) {
+          removed = true;
+          return false;
+        }
+
+        return true;
+      });
+
+      if (!removed) {
+        console.log(`${chalk.yellow("!")} Package ${chalk.cyan(pkgToRemove)} was not found in requirements.txt.`);
+        return;
+      }
+
+      const newContent = newLines.join("\n");
+
+      // 2. Get function details to find storageId
+      const funcResponse = await client.get(`/api/function/${functionId}`);
+      const func = funcResponse.data.data;
+      if (!func || !func.namespace || !func.namespace.storageId) {
+        throw new Error("Could not determine storage ID for function.");
+      }
+      const storageId = func.namespace.storageId;
+
+      // 3. Overwrite requirements.txt
+      await client.put(`/api/storage/${storageId}/files`, {
+        path: "requirements.txt",
+        content: newContent
+      });
+
+      console.log(`${chalk.green("✓")} Removed ${chalk.cyan(pkgToRemove)} from requirements.txt for function ${chalk.yellow(functionId)}.`);
+    } catch (error: any) {
+      handleError(error, "remove package");
+    }
+  },
+};
+
+function handleError(error: any, task: string) {
+  if (error.response) {
+    console.error(`${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(error.response.data?.message || error.message)}`);
+  } else if (error.request) {
+    console.error(
+      `${chalk.red("✗")} Failed to ${task}: ${chalk.yellow(
+        "No response received from server. Please check your network connection and try again."
+      )}`
+    );
+  } else {
+    console.error(`${chalk.red("✗")} Error: ${error.message}`);
+  }
+}

vitest.config.ts

@@ -4,9 +4,10 @@ export default defineConfig({
   test: {
     globals: true,
     environment: 'node',
+    exclude: ['**/node_modules/**', '**/dist/**', '**/cypress/**', '**/.{idea,git,cache,output,temp}/**'],
     coverage: {
       provider: 'v8',
       reporter: ['text', 'json', 'html'],
-    },
+    }
   },
 });