Gradle task API
This reference is generated from the tasks registered by the STIG plugin and the same @Option metadata used by ./gradlew help --task <task>. Use the workflow pages for intent and examples; use this page for the exact command surface of this STIG version. The task dependency diagrams are generated from the same registered tasks.
For the effective contract in a consumer project, Gradle remains authoritative:
stigAggregateAnalysisConfigurationEvidence
Scope | Group | Purpose |
|---|---|---|
root | Aggregates retained analysis-configuration evidence for the root stigCheckAnalysis task. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAggregateProblemsSarif
Scope | Group | Purpose |
|---|---|---|
root | stig - check | Derives one IDE SARIF view from every registered canonical problems.jsonl output. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP1BuildNativeTarget
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P1: Runs |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP1ExtractNativeCompileCommands
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P1: Generates raw + canonical compile_commands.json via Bazel aquery. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP1PatchNativeSources
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P1: Applies configurable source patches before native build. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP2ConvertCompileCommandsToLlvm
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P2: Converts every native compile command to the pinned LLVM toolchain recipe. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP3BuildProvenanceBitcode
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P3: Builds provenance LLVM bitcode (module.bc / module.ll). |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP3CompileProvenanceSources
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Compiles raw LLVM source units for stigAnalysisP3BuildProvenanceBitcode. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP3SelectProvenanceCompileCommands
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P3: Selects provenance compile commands from the complete P2 LLVM database. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP4SelectSoftwareUnderAnalysis
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P4: Selects software-under-analysis compilation units (mode=EXPLICIT). |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP5ApplyBitcodeTransforms
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P5: Applies semantic transforms and validates the final analyzer input. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP5BuildUntransformedAnalyzerInput
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P5: Builds and links the untransformed analyzer input. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP5CompileAnalyzerInputSources
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Compiles raw LLVM source units for stigAnalysisP5BuildUntransformedAnalyzerInput. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP5DeriveInterfacePoints
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P5: Derives component interface points (LLVM symbols + ASIL) from the final analyzer-input module. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP5GenerateAnalyzerRunPlan
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P5: Generates PhASAR run-plan for actual analysis execution. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP5ProduceBitcodeTransformEvidence
Scope | Group | Purpose |
|---|---|---|
element | Produces retained P5 transform and analyzer-input validation evidence. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP5SelectAnalyzerInputCompileCommands
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P5: Selects analyzer-input compile commands for the P4 software-under-analysis units. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP6RunAnalyzer
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P6: Executes stig-code-analyzer; --start-with=transformed uses captured inputs without local P1-P5 producers. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element | string | Existing stig-code-analyzer executable for transformed mode. Skips analyzer build/install and records its identity and SHA-256. |
| element | string | Evidence ZIP or extracted evidence directory for --start-with=transformed; relative paths use the root project. |
| element | string | Separate task-owned diagnostic output directory, required with --start-with=transformed. |
| element | string | Password for an encrypted transformed evidence ZIP. |
| element | string | One exact captured run name in transformed mode; omit to execute every captured run. |
| element | string | Maximum concurrent source solvers per run; 0 (default) shares CPUs minus one and available RAM across the build. |
| element | TRANSFORMED | Run from a captured transformed checkpoint. Only transformed is supported; omit for the local pipeline. |
Copy for Codex:
stigAnalysisP6SliceAnalyzerInput
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P6: Slices per-root LLVM modules from analyzer run-plan roots. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP7CollectDescriptions
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P7: Collects function descriptions from code comments. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element | string | Optional override for code browser repo URL (for example https://host/org/repo). |
| element | string | Commit reference for fileUrl in report: current \| upstream-parent (default current). |
| element | string | Path to compile_commands JSON. |
| element | string | Element/component directory to analyze. |
| element | string | Output report file path (json\|yaml based on --outputFormat). |
| element | string | Output format: json \| yaml. |
| element | string | Project root directory. |
| element | string | Comma-separated source globs relative to elementDir (default includes cpp/cc/cxx and h/hpp/hh/hxx). |
Copy for Codex:
stigAnalysisP7CollectMetrics
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P7: Collects per-function complexity metrics via clang-tidy (from=sourceCodeSelection.compileCommands). |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element | string | clang-tidy executable override; defaults to the pinned STIG LLVM toolchain binary. |
| element | string | Optional override for code browser repo URL (for example https://host/org/repo). |
| element | string | Commit reference for fileUrl in metrics report: current \| upstream-parent (default current). |
| element | string | Path to compile_commands JSON used by clang-tidy. |
| element | string | Minimum recommended tests derived from function metrics. |
| element | string | NEXY low-to-medium reference for branch count. |
| element | string | NEXY low-to-medium reference for cognitive complexity. |
| element | string | NEXY low-to-medium reference for line count. |
| element | string | NEXY low-to-medium reference for parameter count. |
| element | string | NEXY low-to-medium reference for statement count. |
| element | string | NEXY low-to-medium reference for variable count. |
| element | string | Deprecated compatibility option; NEXY ignores final gain. |
| element | string | Deprecated compatibility option; NEXY ignores final offset. |
| element | string | NEXY weight for branch count. |
| element | string | NEXY weight for cognitive complexity. |
| element | string | NEXY weight for line count. |
| element | string | NEXY weight for parameter count. |
| element | string | NEXY weight for statement count. |
| element | string | NEXY weight for variable count. |
| element | string | Element/component directory to analyze. |
| element | string | Comma-separated source exclude globs/prefixes applied after sourceGlobs. |
| element | string | Output report file path (json\|yaml based on --outputFormat). |
| element | string | Output format: json \| yaml. |
| element | string | Project root directory. |
| element | string | Comma-separated source include globs/prefixes. Empty means all C/C++ files in compile_commands. |
Copy for Codex:
stigAnalysisP7GenerateAppliedTransformations
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P7: Builds report-ready applied-transformations function table data. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP7GenerateDiagrams
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P7: Generates SVG, Cytoscape, and Sigma diagrams directly from analyzer JSON. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAnalysisP7SelectSourceCompileCommands
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | P7: Selects source-code compile commands (from=analyzerInput.compileCommands, includes=0, excludes=0). |
This task defines no task-specific command-line options.
Copy for Codex:
stigAssembleDokkaEnginePlugin
Scope | Group | Purpose |
|---|---|---|
root | stig - docs | Packages STIG's development class directories for Dokka's plugin classpath. |
This task defines no task-specific command-line options.
Copy for Codex:
stigAuditAnalysisEvidence
Scope | Group | Purpose |
|---|---|---|
root | stig - analysis | Audits captured evidence integrity and LLVM transform accounting, stopping before expensive checks when blocked. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | flag | Continue independent mechanical checks after a recorded blocker; never use corrupt payloads. |
| root | list | Extracted stigCheckAnalysis archive directory; repeat for multiple activities. |
| root | list | Existing local review_evidence_index.json; selects no pipeline producer. |
| root | list | stigCheckAnalysis ZIP; repeat for multiple activities. |
| root | flag | Disables option --all-checks. |
| root | string | Directory for generated evidence reports, outside the input evidence. |
| root | string | Password for the supplied encrypted evidence ZIPs. |
Copy for Codex:
stigBuildConfiguredAnalyzerInputInventory
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Builds the configured untransformed analyzer-input inventory for configuration maintenance. |
This task defines no task-specific command-line options.
Copy for Codex:
stigBuildFullLlvmOwnershipInventory
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Builds the complete untransformed LLVM ownership inventory from the shared P2 database. |
This task defines no task-specific command-line options.
Copy for Codex:
stigCheckAnalysis
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Checks the complete analysis chain and optionally exports LLVM, analyzer, and report evidence. |
root | stig - analysis | Checks selected source-analysis modules and optionally exports one combined evidence ZIP. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element, root | flag | Retain available evidence after pipeline failures (enabled by default). Use --continue to attempt other activities. |
| element, root | flag | Stop after P5 and collect configuration evidence and Markdown review tables without running P6, P7, or HTML generation. |
| root | list | Comma-separated absolute Gradle project paths; repeatable. Defaults to all eligible source-analysis modules. |
| element, root | flag | Disables option --accept-partial-results. |
| element, root | flag | Disables option --configuration-only. |
| root | flag | Disables option --sync-evidence-repositories. |
| element, root | flag | Disables option --zip. |
| element, root | string | Encrypt ZIP contents with AES-256; requires --zip and must not be blank. |
| root | flag | Synchronize evidence repositories before running the selected activity analysis chains. |
| element, root | flag | Create one self-contained evidence ZIP for the selected modules (disabled by default). |
| element, root | string | Export directory, relative to the root project or absolute; requires --zip. Defaults to ../<project-name>-check-analysis-evidence/. |
Copy for Codex:
stigCheckConfig
Scope | Group | Purpose |
|---|---|---|
element | stig - check | Validates that file paths and DSL settings in this module's stig { element } block are correct (paths exist, no contradictory settings). |
root | stig - check | [root aggregator] Validates file paths in stig { element } blocks across all modules (existence, kind, repo containment). |
This task defines no task-specific command-line options.
Copy for Codex:
stigCheckModel
Scope | Group | Purpose |
|---|---|---|
element | stig - check | [per-module] Writes canonical specification/configuration problems and derived IDE SARIF. |
root | stig - check | [full-model] Loads the complete model once and checks each module with its own settings. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element, root | all\|automatic\|manual | Checks to report: automatic (default), all (automatic and manual), or manual. |
| element, root | string | Directory for reports. |
| element, root | string | Report format: text \| json \| sarif \| junit \| html. |
| element, root | string | Ruleset/profile selector (optional). |
| element, root | list | Viewpoint to check. Repeat the option to check multiple viewpoints. |
Copy for Codex:
stigCheckP5SymbolCompleteness
Scope | Group | Purpose |
|---|---|---|
element | stig - check | Builds P1-P5 and reports unresolved application symbols as HIGH findings for provisional analysis. |
root | stig - check | Checks final P5 symbol completeness for every analyzed activity. |
This task defines no task-specific command-line options.
Copy for Codex:
stigClassifyP5MissingSymbols
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Classifies missing symbols into inactive real-unit, other-element, or unresolved candidates. |
This task defines no task-specific command-line options.
Copy for Codex:
stigCollectAnalysisConfigurationEvidence
Scope | Group | Purpose |
|---|---|---|
element | Collects retained LLVM and configuration evidence for stigCheckAnalysis. |
This task defines no task-specific command-line options.
Copy for Codex:
stigCollectAnalysisStatistics
Scope | Group | Purpose |
|---|---|---|
root | stig - docs | Collects P5 scope and P6 execution measurements without launching analysis. |
This task defines no task-specific command-line options.
Copy for Codex:
stigCollectNativeSymbolProviders
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Captures current native symbol-provider candidates for active activity transform rules. |
This task defines no task-specific command-line options.
Copy for Codex:
stigCompileConfiguredAnalyzerInputSources
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Compiles raw LLVM source units for stigBuildConfiguredAnalyzerInputInventory. |
This task defines no task-specific command-line options.
Copy for Codex:
stigCompileFullLlvmOwnershipSources
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Compiles raw LLVM source units for stigBuildFullLlvmOwnershipInventory. |
This task defines no task-specific command-line options.
Copy for Codex:
stigConfigureAnalysis
Scope | Group | Purpose |
|---|---|---|
element | stig - edit | Creates or reconciles this element's analysis configuration; --preview writes only build candidates. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element | string | Conditionally required. Logical native activity directory as repo:path; reuses element configuration. |
| element | string | Optional. Marker depth GROUP, LEAF, or BOTH. Reuses enabled analyzerExecution modes; default LEAF. |
| element | list | Optional, repeatable exact override (repo:path). When both source options are omitted, reuses configured target source trees or selects nativeTarget actions under activitySourceRoot. |
| element | list | Optional, repeatable repo:path tree. Selects only compile actions owned by nativeTarget whose logical source path is beneath the tree; may be combined with exact --analysisSource values. |
| element | string | Optional path to compile_commands.json. Defaults to the selected element's P1 extraction output. |
| element | string | Conditionally required. C++ implementation class; reuses implementationClassName when omitted. |
| element | string | Optional repo:path override. Defaults to <implementationDir>/<moduleName>_activity.h in the owning repository. |
| element | string | Conditionally required. C++ namespace; reuses implementationNamespace when omitted. |
| element | string | Required for LEAF/BOTH, optional for GROUP. Coordinate repo:path; reuses the configured file. |
| element | string | Optional. Values: EXECUTE_INIT_THEN_EXPLICIT_CYCLE or EXPLICIT_CYCLE_ONLY. Default EXECUTE_INIT_THEN_EXPLICIT_CYCLE. |
| element | string | Conditionally required. Native target label; reuses the configured target when omitted. |
| element | flag | Disables option --preview. |
| element | flag | Write configuration candidates and review findings under build/ without editing project sources. |
| element | string | Conditionally required. Topics metadata coordinate repo:path; reuses interfacePoints.topicsFile. |
Copy for Codex:
stigConfirmFunctionRewriteRules
Scope | Group | Purpose |
|---|---|---|
root | stig - analysis | Records completed semantic review as CONFIRMED on shared project registry rules. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | list | Exact project registry rule identity whose semantic review is complete; repeatable. Omit to confirm every selected rule. |
| root | list | Select shared rules used by these comma-separated absolute activity project paths; repeatable. Omit to select project registry rules directly. |
| root | flag | Disables option --preview. |
| root | flag | Write the proposed root Gradle file and status report without updating the project registry. |
Copy for Codex:
stigContextClasses
Scope | Group | Purpose |
|---|---|---|
element | build | Assembles stig context classes. |
This task defines no task-specific command-line options.
Copy for Codex:
stigContextJar
Scope | Group | Purpose |
|---|---|---|
element | Packages this element's Context declarations independently of its other viewpoints. |
This task defines no task-specific command-line options.
Copy for Codex:
stigDeriveAnalysisConfiguration
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Derives a non-mutating source-code-analysis configuration proposal from maintenance evidence. |
This task defines no task-specific command-line options.
Copy for Codex:
stigExportModel
Scope | Group | Purpose |
|---|---|---|
root | stig - docs | Exports selected Highway model roots or the Kotlin-defined native JSON schema. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | list | Canonical element name or ID; repeat to select several. |
| root | string | Output encoding: highway-json. |
| root | string | Output file, relative to the STIG project or absolute. |
| root | string | Comma-separated Context, Requirements, Design, Analysis viewpoint selection. |
| root | string | Export model or schema; schema export does not load the consumer model. |
Copy for Codex:
stigExtendedCheckModel
Scope | Group | Purpose |
|---|---|---|
root | stig - check | [root aggregator] Runs stigCheckModel plus a whole-repository scan with the free pinned Qodana Community linter (native mode, no Docker/license or manual installation). Requires complete evidence and zero unsuppressed findings. |
This task defines no task-specific command-line options.
Copy for Codex:
stigExtractAnalysisInterfaceInventory
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Scans compiled C++ topics into the shared specification and harness interface inventory. |
This task defines no task-specific command-line options.
Copy for Codex:
stigExtractDokkaResources
Scope | Group | Purpose |
|---|---|---|
root | stig - docs | Extracts STIG's bundled Dokka assets and templates from the plugin classpath into build/stig/dokka-resources/ so Dokka can consume them as on-disk inputs. |
This task defines no task-specific command-line options.
Copy for Codex:
stigGenerateAnalysisHarness
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Generates temporary C++ harness files and the contract consumed directly by P5. |
root | stig - analysis | [root aggregator] Generates temporary analysis harnesses for all STIG elements. |
This task defines no task-specific command-line options.
Copy for Codex:
stigGenerateArchivedAnalysisReview
Scope | Group | Purpose |
|---|---|---|
root | stig - analysis | Generates review worksheets from existing evidence; optionally creates editable copies at a chosen destination. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | list | Extracted stigCheckAnalysis archive directory; repeat for multiple activities. |
| root | list | Existing local review_evidence_index.json; selects no pipeline producer. |
| root | list | stigCheckAnalysis ZIP; repeat for multiple activities. |
| root | string | Directory for generated evidence reports, outside the input evidence. |
| root | string | Password for the supplied encrypted evidence ZIPs. |
| root | string | Optional destination for editable per-activity reviews, outside input evidence and task outputs. |
Copy for Codex:
stigGenerateDiagramAppendix
Scope | Group | Purpose |
|---|---|---|
element | stig - docs | Issue 13: emits diagrams.md indexing every file in the new 5-axis diagrams tree. |
This task defines no task-specific command-line options.
Copy for Codex:
stigGenerateHtml
Scope | Group | Purpose |
|---|---|---|
element | stig - docs | [per-module] Builds standalone HTML, validates its exact inventory, and reports large files. |
root | stig - docs | [root] Builds all modules' Dokka HTML, validates its exact inventory, and reports large files. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element, root | list | Exclude one STIG module from the root aggregate report and its STIG report pipeline. Use an absolute Gradle project path and repeat the option for multiple modules. |
| element, root | flag | Disables option --serve. |
| element, root | flag | Start or reuse a managed background HTTP server for the generated report. |
| element, root | string | Override the preview-server port for this invocation (0 selects a free port; implies --serve). |
Copy for Codex:
stigGenerateHtmlPipelineStart
Scope | Group | Purpose |
|---|---|---|
root | stig - docs | Optionally requires clean source repositories and logs the HTML-pipeline wall-clock start. |
This task defines no task-specific command-line options.
Copy for Codex:
stigGenerateMarkdown
Scope | Group | Purpose |
|---|---|---|
element | stig - docs | Generates documentation from STIG viewpoints (stub implementation). |
root | stig - docs | [root aggregator] Generates STIG viewpoint documentation for all subprojects. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element | string | Generate markdown files containing Kotlin viewpoint source (default false). |
| element | string | Docs format: MKDOCS \| WRITERSIDE \| DOKKA. |
| element | string | Navigation file to update (format-specific). |
| element | string | Output directory for generated docs. |
| element | string | Update navigation files (default true). |
| element | list | Viewpoint to generate. Repeat the option to generate multiple viewpoints. |
Copy for Codex:
stigImportModel
Scope | Group | Purpose |
|---|---|---|
element | stig - edit | Imports this module's root-configured code input into its ordinary Kotlin Context. |
root | stig - edit | Reads configured SYML/Highway/code inputs and explicitly overwrites selected Kotlin specifications. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| element, root | string | Input kind: syml, c-header, highway-json or code at the root; code only for an element task. Omit to use configured inputs. |
| element, root | string | Project-relative target module root for the ad hoc SYML input. |
| element, root | string | SYML component root for a single ad hoc import; otherwise use the configured roots. |
| element, root | string | Canonical ElementType for SYML, for example component or activity. |
Copy for Codex:
stigInitElement
Scope | Group | Purpose |
|---|---|---|
root | stig - edit | Creates a new element module and initializes STIG viewpoints. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | string | Optional. Element ASIL written to build.gradle.kts. Syntax: --asil <value>. Values: QM, A, B, C, D or decompositions such as QM_B, B_D. Default: none; no ASIL setting is generated. |
| root | string | Optional. Base Kotlin package. Syntax: --basePackage <package>. Default: derived from --elementDir and the project prefix. |
| root | string | Optional. Whether to create the module build.gradle.kts. Syntax: --createBuildFile <boolean>. Values: true, false, 1, 0. Default: true. |
| root | string | Optional. Whether to create Kotlin and Markdown templates. Syntax: --createTemplates <boolean>. Values: true, false, 1, 0. Default: true. |
| root | string | Optional. Whether to preview changes without writing files. Syntax: --dryRun <boolean>. Values: true, false, 1, 0. Default: false. |
| root | string | Required. Element directory relative to the root project. Syntax: --elementDir <path>. |
| root | string | Canonical Kotlin element name; defaults to the name derived from elementDir. |
| root | string | Optional. Element type written to build.gradle.kts. Syntax: --elementType <value>. Values: VEHICLE, ITEM, SYSTEM, SUBSYSTEM, CLUSTER, COMPONENT, ACTIVITY, UNIT. Default: COMPONENT. |
| root | string | Optional. Gradle project path. Syntax: --gradlePath <project-path>. Default: colon-separated --elementDir. |
| root | string | Optional. Element group written to build.gradle.kts. Syntax: --group <name>. Default: none; a commented placeholder is generated and project defaults apply. |
| root | string | Optional. Model import policy written to the element configuration. Syntax: --importEnabled <boolean>. Values: true, false, 1, 0. Default: false. |
| root | string | Optional. Existing-file policy. Syntax: --mode <value>. Values: CREATE_MISSING, OVERWRITE, FAIL_IF_EXISTS. Default: CREATE_MISSING. |
| root | string | Optional. Viewpoint placement. Syntax: --placement <value>. Values: DIRECT, STIG_SUBDIR. Default: DIRECT. |
| root | string | Optional. Initial source-code-analysis policy. Syntax: --sourceCodeAnalysis <value>. Values: DISABLED, INHERIT. Default: DISABLED; a safe-off phased scaffold is generated. |
| root | string | Optional. Template content mode. Syntax: --templateMode <value>. Values: SKELETON, EXAMPLE. Default: SKELETON. |
| root | list | Optional. Viewpoints to create. Syntax: --viewpoints <value> (repeatable). Values: context, requirements, design, analysis, tests. Default: all five viewpoints. |
Copy for Codex:
stigInitModule
Scope | Group | Purpose |
|---|---|---|
root | stig - edit | Creates a Kotlin model library without architectural elements or CREATE viewpoints. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | string | Kotlin package for shared declarations; defaults to the project prefix and module directory. |
| root | string | Existing-file policy: CREATE_MISSING (default), OVERWRITE, or FAIL_IF_EXISTS. |
| root | string | Required. New module directory relative to the root project, e.g. interfaces/pecu. |
| root | flag | Disables option --preview. |
| root | flag | Show the intended files without changing project sources or settings. |
Copy for Codex:
stigInstallDeps
Scope | Group | Purpose |
|---|---|---|
element | stig | Install the OS toolchain (LLVM/Z3/clang/cmake) via scripts/setup.sh (sudo). Run once per machine before building. |
root | stig | Install the OS toolchain (LLVM/Z3/clang/cmake) via scripts/setup.sh (sudo). Run once per machine before building. |
This task defines no task-specific command-line options.
Copy for Codex:
stigInstallSkill
Scope | Group | Purpose |
|---|---|---|
root | stig | Install or update the bundled STIG Codex plugin for this user. Explicit only; normal builds never run it. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | string | Use this Codex executable instead of the pinned managed distribution. |
| root | string | Codex configuration home; defaults to CODEX_HOME or ~/.codex. |
| root | AUTO\|DEVICE\|NEVER | AUTO prompts when connected; DEVICE explicitly starts device login; NEVER never prompts. |
| root | flag | Disables option --smoke-test. |
| root | flag | Check that Codex answers 1+1 with 2 (default true). Disable with --no-smoke-test. |
| root | string | Maximum seconds for the model smoke test (default 120). |
Copy for Codex:
stigListElements
Scope | Group | Purpose |
|---|---|---|
root | stig - help (introspection) | Lists every STIG element configured in build.gradle.kts with its project path, module directory, implementation directory, build system, and Bazel target (when set). |
This task defines no task-specific command-line options.
Copy for Codex:
stigListProblems
Scope | Group | Purpose |
|---|---|---|
root | stig - check | Generates HTML, writes the complete deduplicated problem aggregate, and lists typed filters. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | string | List problems at least as severe as this ProblemSeverity value. |
| root | string | List exact ProblemCategory values; comma-separate multiple values. |
| root | string | After writing and printing the complete result, fail at this ProblemSeverity threshold. |
| root | string | List only problems with exactly this ProblemSeverity value. |
Copy for Codex:
stigLockAnalysisWorkspace
Scope | Group | Purpose |
|---|---|---|
element | Protects analysis inputs and outputs from another Gradle invocation in this checkout. | |
root | Protects analysis inputs and outputs from another Gradle invocation in this checkout. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPrepareAnalysisTransformConfiguration
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Materializes the resolved analysis transform rules, including current review state. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPrepareDokkaIncludes
Scope | Group | Purpose |
|---|---|---|
element | stig - docs | Stages this module's STIG markdown (provenance file, flow/complexity viewpoint .md files, source-tree READMEs) into Dokka's includes directory. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPrepareModelReport
Scope | Group | Purpose |
|---|---|---|
element | stig - docs | Prepares this module and its model dependency context for checks and a standalone HTML report. |
root | stig - docs | Prepares one shared compiled model for all included modules' checks and HTML reports. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPreparePublishedHtmlVersions
Scope | Group | Purpose |
|---|---|---|
root | stig - docs | [root] Fetches and prepares retained Pages releases for Dokka versioning. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPrepareReviewAssets
Scope | Group | Purpose |
|---|---|---|
element | Prepares non-secret browser review settings for Dokka HTML generation. | |
root | Prepares non-secret browser review settings for Dokka HTML generation. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPrepareTransformReviewEvidence
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Collects original LLVM definition coverage and exact P3/P5 input matches for transform review. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPrintVersion
Scope | Group | Purpose |
|---|---|---|
root | stig - help (introspection) | Prints the consumer project name/version and the selected STIG source and loaded plugin version. |
This task defines no task-specific command-line options.
Copy for Codex:
stigPublishHtml
Scope | Group | Purpose |
|---|---|---|
root | stig - docs | [root] Publishes the exact bounded Dokka inventory through a single-commit Pages branch and reports size. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | list | Exclude one STIG module from the generated aggregate before publishing. Use an absolute Gradle project path and repeat the option for multiple modules. |
| root | flag | Disables option --prune-all-in-project. |
| root | flag | Disables option --prune-snapshots-in-project. |
| root | flag | Disables option --replace-existing-release-in-project. |
| root | flag | Replace this project's Pages subtree and publish only the current version. |
| root | flag | Remove all previously published snapshots in this project's Pages subtree before publishing. |
| root | flag | Permit deliberate replacement of the same named, non-snapshot release. |
Copy for Codex:
stigQuickCheck
Scope | Group | Purpose |
|---|---|---|
element | stig - check | Compiles this element's main source set. Model import is a separate source-editing command. |
root | stig - check | [root aggregator] Runs stigQuickCheck for every active STIG element. |
This task defines no task-specific command-line options.
Copy for Codex:
stigReplayArchivedAnalyzerRun
Scope | Group | Purpose |
|---|---|---|
root | stig - analysis | Replays one analyzer run from an extracted stigCheckAnalysis archive without compiling product source. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | string | Literal fact-label substring used with at least one --debug-facts-at-function option. |
| root | list | Exact mangled LLVM function to inspect after the solve. Repeat for multiple functions; prefer this targeted diagnostic before --debug-trace. |
| root | flag | Enable the analyzer's high-volume PhASAR trace. Use only after targeted fact diagnostics. |
| root | string | Absolute or root-project-relative directory containing an extracted stigCheckAnalysis ZIP. |
| root | string | Exact Gradle module path to replay from a multi-module evidence collection. |
| root | flag | Disables option --debug-trace. |
| root | string | Fresh task-owned directory for replay JSON, logs, command, and concise sink summary. |
| root | string | Exact archived runStem from selected_p6_modules.json, for example cascading-faults-A. |
Copy for Codex:
stigSelectConfiguredAnalyzerInputCompileCommands
Scope | Group | Purpose |
|---|---|---|
element | stig - analysis | Selects the configured analyzer-input units from the shared P2 LLVM database. |
This task defines no task-specific command-line options.
Copy for Codex:
stigSelfTest
Scope | Group | Purpose |
|---|---|---|
element | stig | Run stig environment checks. Scaffold today — real checks land via #38. |
root | stig | Run stig environment checks. Scaffold today — real checks land via #38. |
This task defines no task-specific command-line options.
Copy for Codex:
stigSetupAnalyzer
Scope | Group | Purpose |
|---|---|---|
element | stig | Build / refresh the stig-code-analyzer binary on this host (build-analyzer.sh; idempotent; assumes deps installed). |
root | stig | Build / refresh the stig-code-analyzer binary on this host (build-analyzer.sh; idempotent; assumes deps installed). |
This task defines no task-specific command-line options.
Copy for Codex:
stigStopHtmlServer
Scope | Group | Purpose |
|---|---|---|
element | stig - docs | Stops this project's managed background HTML preview server, if running. |
root | stig - docs | Stops this project's managed background HTML preview server, if running. |
This task defines no task-specific command-line options.
Copy for Codex:
stigSyncAnalysisEvidenceRepositories
Scope | Group | Purpose |
|---|---|---|
root | stig - analysis | Runs the consumer's explicit pull/push git-subrepo synchronization before root analysis collection. |
This task defines no task-specific command-line options.
Copy for Codex:
stigUpdate
Scope | Group | Purpose |
|---|---|---|
root | stig | Update to the latest stable published STIG release by default; --keep-devel retains local source. Align Gradle, Java, shared pins and IDEA settings; repair and strictly verify dependency locks and checksums. |
Option | Scope | Value | Meaning |
|---|---|---|---|
| root | flag | Write missing SHA-256 checksums and strictly verify current dependencies and IDEA sources without changing the STIG version. |
| root | flag | Align dependencies with the configured local STIG checkout. |
| root | flag | Retain the local STIG checkout, record its actual version and synchronize its pins (alias: --devel). |
| root | flag | Update to the latest stable STIG release, including major upgrades, and refresh dependency checksums. |
| root | flag | Update to the latest stable STIG release within the current major version and refresh dependency checksums. |
| root | flag | Disables option --dependencies. |
| root | flag | Disables option --devel. |
| root | flag | Disables option --keep-devel. |
| root | flag | Disables option --major. |
| root | flag | Disables option --minor. |
| root | flag | Disables option --none. |
| root | flag | Disables option --patch. |
| root | flag | Disables option --yes. |
| root | flag | Keep the selected STIG version and repair dependency locks and checksums. |
| root | flag | Update to the latest stable STIG patch release and refresh dependency checksums. |
| root | flag | Accept new checksum additions after the existing-pin and signing-policy checks. |
Copy for Codex: