Plan Credit-Bounded Scan Scope & Shard Estimate
vulkill_scan_guided_interactivePreview scan scope by calculating a zero-credit dry-run plan of covered files, live sites, shard count, and over-quota overflow before launching a real scan.
Instructions
Calculate a dry-run scan execution plan for covered files, live sites, shard count, and uncovered overflow. Call after vulkill_check_credits and before vulkill_start_scan to preview scope. Use vulkill_start_scan to launch a real scan, or vulkill_check_credits when only raw balances are needed. Parameters files and sites specify requested counts, while coveredFiles and coveredSites return accepted quota-bounded counts at 1 file credit per file across ceil(coveredFiles / 5000) shards and 1 site credit per site, placing any over-quota excess into missingFiles and missingSites without failing. Code modes ('source', 'semantic', 'infrastructure') force coveredSites=0, 'web' forces coveredFiles=0 and shards=0, and 'auto' evaluates both. Requires VULKILL_API_KEY or OAuth 2.1 auth, charges zero credits, and launches no workers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Analysis profile ('auto', 'source', 'semantic', 'infrastructure', or 'web'; default 'auto'). | auto |
| files | No | Requested repository file count for the dry-run plan (0 to 100,000,000, default 0). | |
| sites | No | Requested live web/API origin count for the dry-run plan (0 to 10,000, default 0). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | Selected scan execution mode ('auto', 'source', 'semantic', 'infrastructure', or 'web'). | |
| shards | Yes | Number of parallel 5,000-file container shards required for coveredFiles. | |
| shardSize | Yes | Maximum files per container shard (5000). | |
| coveredFiles | Yes | Number of requested files covered by the caller's available file credits. | |
| coveredSites | Yes | Number of requested live sites covered by the caller's available site credits. | |
| missingFiles | Yes | Uncovered file count when requestedFiles exceeds remainingFiles (0 if fully covered). | |
| missingSites | Yes | Uncovered site count when requestedSites exceeds remainingSites (0 if fully covered). | |
| creditsCharged | Yes | Credits deducted by this planning call (always 0). | |
| requestedFiles | Yes | Number of files requested by the caller. | |
| requestedSites | Yes | Number of live sites requested by the caller. |