@rafter-security/cli 0.5.3 → 0.5.9

package/dist/commands/backend/run.js

@@ -4,23 +4,44 @@ import ora from "ora";
 import { detectRepo } from "../../utils/git.js";
 import { API, resolveKey, EXIT_GENERAL_ERROR, EXIT_QUOTA_EXHAUSTED } from "../../utils/api.js";
 import { handleScanStatus } from "./scan-status.js";
-export function createRunCommand() {
-    return new Command("run")
-        .alias("scan")
-        .option("-r, --repo <repo>", "org/repo (default: current)")
-        .option("-b, --branch <branch>", "branch (default: current else main)")
-        .option("-k, --api-key <key>", "API key or RAFTER_API_KEY env var")
-        .option("-f, --format <format>", "json | md", "md")
-        .option("--skip-interactive", "do not wait for scan to complete")
-        .option("--quiet", "suppress status messages")
-        .action(async (opts) => {
-        const key = resolveKey(opts.apiKey);
-        let repo, branch;
+/**
+ * Shared handler for the remote backend scan (used by both `rafter run` and `rafter scan` / `rafter scan remote`).
+ */
+export async function runRemoteScan(opts) {
+    const key = resolveKey(opts.apiKey);
+    let repo, branch;
+    try {
+        ({ repo, branch } = detectRepo({ repo: opts.repo, branch: opts.branch, quiet: opts.quiet }));
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            console.error(e.message);
+        }
+        else {
+            console.error(e);
+        }
+        process.exit(EXIT_GENERAL_ERROR);
+    }
+    if (!opts.quiet) {
+        const spinner = ora("Submitting scan").start();
         try {
-            ({ repo, branch } = detectRepo({ repo: opts.repo, branch: opts.branch, quiet: opts.quiet }));
+            const { data } = await axios.post(`${API}/static/scan`, { repository_name: repo, branch_name: branch }, { headers: { "x-api-key": key } });
+            spinner.succeed(`Scan ID: ${data.scan_id}`);
+            if (opts.skipInteractive)
+                return;
+            const exitCode = await handleScanStatus(data.scan_id, { "x-api-key": key }, opts.format ?? "md", opts.quiet);
+            process.exit(exitCode);
         }
         catch (e) {
-            if (e instanceof Error) {
+            spinner.fail("Request failed");
+            if (e.response?.status === 429) {
+                console.error("Quota exhausted");
+                process.exit(EXIT_QUOTA_EXHAUSTED);
+            }
+            else if (e.response?.data) {
+                console.error(e.response.data);
+            }
+            else if (e instanceof Error) {
                 console.error(e.message);
             }
             else {
@@ -28,57 +49,44 @@ export function createRunCommand() {
             }
             process.exit(EXIT_GENERAL_ERROR);
         }
-        if (!opts.quiet) {
-            const spinner = ora("Submitting scan").start();
-            try {
-                const { data } = await axios.post(`${API}/static/scan`, { repository_name: repo, branch_name: branch }, { headers: { "x-api-key": key } });
-                spinner.succeed(`Scan ID: ${data.scan_id}`);
-                if (opts.skipInteractive)
-                    return;
-                const exitCode = await handleScanStatus(data.scan_id, { "x-api-key": key }, opts.format, opts.quiet);
-                process.exit(exitCode);
+    }
+    else {
+        try {
+            const { data } = await axios.post(`${API}/static/scan`, { repository_name: repo, branch_name: branch }, { headers: { "x-api-key": key } });
+            if (opts.skipInteractive)
+                return;
+            const exitCode = await handleScanStatus(data.scan_id, { "x-api-key": key }, opts.format ?? "md", opts.quiet);
+            process.exit(exitCode);
+        }
+        catch (e) {
+            if (e.response?.status === 429) {
+                process.exit(EXIT_QUOTA_EXHAUSTED);
             }
-            catch (e) {
-                spinner.fail("Request failed");
-                if (e.response?.status === 429) {
-                    console.error("Quota exhausted");
-                    process.exit(EXIT_QUOTA_EXHAUSTED);
-                }
-                else if (e.response?.data) {
-                    console.error(e.response.data);
-                }
-                else if (e instanceof Error) {
-                    console.error(e.message);
-                }
-                else {
-                    console.error(e);
-                }
-                process.exit(EXIT_GENERAL_ERROR);
+            else if (e.response?.data) {
+                console.error(e.response.data);
             }
-        }
-        else {
-            try {
-                const { data } = await axios.post(`${API}/static/scan`, { repository_name: repo, branch_name: branch }, { headers: { "x-api-key": key } });
-                if (opts.skipInteractive)
-                    return;
-                const exitCode = await handleScanStatus(data.scan_id, { "x-api-key": key }, opts.format, opts.quiet);
-                process.exit(exitCode);
+            else if (e instanceof Error) {
+                console.error(e.message);
             }
-            catch (e) {
-                if (e.response?.status === 429) {
-                    process.exit(EXIT_QUOTA_EXHAUSTED);
-                }
-                else if (e.response?.data) {
-                    console.error(e.response.data);
-                }
-                else if (e instanceof Error) {
-                    console.error(e.message);
-                }
-                else {
-                    console.error(e);
-                }
-                process.exit(EXIT_GENERAL_ERROR);
+            else {
+                console.error(e);
             }
+            process.exit(EXIT_GENERAL_ERROR);
         }
+    }
+}
+function addRunOptions(cmd) {
+    return cmd
+        .option("-r, --repo <repo>", "org/repo (default: current)")
+        .option("-b, --branch <branch>", "branch (default: current else main)")
+        .option("-k, --api-key <key>", "API key or RAFTER_API_KEY env var")
+        .option("-f, --format <format>", "json | md", "md")
+        .option("--skip-interactive", "do not wait for scan to complete")
+        .option("--quiet", "suppress status messages");
+}
+export function createRunCommand() {
+    return addRunOptions(new Command("run")
+        .description("Trigger a remote backend security scan")).action(async (opts) => {
+        await runRemoteScan(opts);
     });
 }

package/dist/commands/ci/init.js

@@ -44,6 +44,12 @@ export function createCiInitCommand() {
             }
         }
         console.log(`  ${opts.withBackend ? "3" : "2"}. Commit and push to trigger the pipeline`);
+        if (platform === "github") {
+            console.log();
+            console.log("Alternatives:");
+            console.log("  - GitHub Action: uses: Raftersecurity/rafter-cli@v0");
+            console.log("  - Pre-commit:  https://github.com/Raftersecurity/rafter-cli#pre-commit-framework");
+        }
         console.log();
     });
 }
@@ -68,6 +74,7 @@ function generateTemplate(platform, withBackend) {
 }
 function githubTemplate(withBackend) {
     let yaml = `# Generated by: rafter ci init
+# Alternative: uses: Raftersecurity/rafter-cli@v0
 name: Rafter Security
 
 on:
@@ -89,7 +96,7 @@ jobs:
         run: npm install -g @rafter-security/cli
 
       - name: Scan for secrets
-        run: rafter agent scan . --quiet
+        run: rafter scan local . --quiet
 `;
     if (withBackend) {
         yaml += `
@@ -120,7 +127,7 @@ secret-scan:
   image: node:20
   script:
     - npm install -g @rafter-security/cli
-    - rafter agent scan . --quiet
+    - rafter scan local . --quiet
   rules:
     - if: $CI_PIPELINE_SOURCE == "push"
     - if: $CI_PIPELINE_SOURCE == "merge_request_event"
@@ -158,7 +165,7 @@ jobs:
           command: npm install -g @rafter-security/cli
       - run:
           name: Scan for secrets
-          command: rafter agent scan . --quiet
+          command: rafter scan local . --quiet
 `;
     if (withBackend) {
         yaml += `