@zksecurity/zkao-cli 0.2.0 → 0.5.0

package/dist/index.js

@@ -476,6 +476,13 @@ config.command("show").description("Show the resolved settings (token masked)").
   });
 });
 program.command("repos").description("List repositories in the project").action(() => run((c) => c.listRepositories()));
+program.command("repos:wait <repositoryId>").description("Wait until a repository is ready to scan").option("--timeout <ms>", "give up after this long", toInt).action(
+  (repositoryId, opts) => run(
+    (c) => c.waitForRepositoryReady(repositoryId, {
+      ...opts.timeout !== void 0 ? { timeoutMs: opts.timeout } : {}
+    })
+  )
+);
 var guidance = program.command("guidance").description("Read and update a repository's guidance");
 guidance.command("get <repoId>").description("Show a repository's configured guidance").action((repoId) => run((c) => c.getRepositoryGuidance(repoId)));
 guidance.command("set <repoId> <file|->").description("Set a repository's guidance from a file (or - for stdin)").option(
@@ -504,6 +511,20 @@ guidance.command("clear <repoId>").description("Remove a repository's guidance")
     });
   })
 );
+var areas = program.command("areas").description("List and manage a repository's audit areas");
+areas.command("list <repoId>").description("Show the subsystems a scan can be scoped to").option("--branch <branch>", "read sizes from this branch's map").action(
+  (repoId, opts) => run(
+    (c) => c.listAuditAreas(repoId, {
+      ...opts.branch === void 0 ? {} : { branch: opts.branch }
+    })
+  )
+);
+areas.command("add <repoId> <name>").description("Add a custom audit area").option("--description <text>", "what this part of the code does").action(
+  (repoId, name, opts) => run((c) => c.createAuditArea(repoId, name, opts.description ?? null))
+);
+areas.command("rm <repoId> <areaKey>").description("Delete a custom audit area").action(
+  (repoId, areaKey) => run((c) => c.deleteAuditArea(repoId, areaKey))
+);
 var scans = program.command("scans").description("Launch, list, and poll scans");
 scans.command("list").option("--page <n>", "page number", toInt).option("--limit <n>", "page size (max 100)", toInt).action(
   (opts) => run((c) => c.listScans({ page: opts.page, limit: opts.limit }))
@@ -524,6 +545,11 @@ scans.command("wait <scanId>").description("Poll a scan until it finishes (honor
 scans.command("launch").description("Launch a scan").requiredOption("--repo <id>", "repository id").requiredOption("--budget <credits>", "max budget, in credits", toInt).option("--preset <ref>", "scan preset ref (see `zkao presets`)").option("--branch <name>", "branch to scan").option("--commit <sha>", "specific commit to scan").option("--message <text>", "commit message (metadata)").option("--flow <id>", "optional-flow id to opt into (repeatable)", collect, []).option(
   "--guidance <file|->",
   "per-scan guidance from a file (or - for stdin); replaces the repo's guidance for this scan"
+).option(
+  "--area <key>",
+  "audit area to scope the scan to (repeatable; see `zkao areas list`)",
+  collect,
+  []
 ).action(
   (opts) => {
     const body = {
@@ -534,6 +560,7 @@ scans.command("launch").description("Launch a scan").requiredOption("--repo <id>
       commitHash: opts.commit ?? null,
       commitMessage: opts.message ?? null,
       optInFlowIds: opts.flow.length > 0 ? opts.flow : void 0,
+      auditAreaKeys: opts.area.length > 0 ? opts.area : void 0,
       ...opts.guidance !== void 0 ? { guidance: readContentArg(opts.guidance) } : {}
     };
     return run((c) => c.launchScan(body));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zksecurity/zkao-cli",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "Command-line interface for the zkao Project API",
   "license": "MIT",
   "author": "zkSecurity",
@@ -22,7 +22,11 @@
   "bin": {
     "zkao": "./dist/index.js"
   },
-  "files": ["dist", "LICENSE", "README.md"],
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
   "engines": {
     "node": ">=18"
   },
@@ -35,7 +39,7 @@
     "prepublishOnly": "node -e \"if (!(process.env.npm_config_user_agent || '').includes('bun/')) { console.error('Publish with bun publish: npm ships the literal workspace:* dependency and breaks installs.'); process.exit(1); }\""
   },
   "dependencies": {
-    "@zksecurity/zkao-sdk": "0.2.0",
+    "@zksecurity/zkao-sdk": "0.5.0",
     "commander": "^12.1.0"
   },
   "devDependencies": {