Use this workflow when platform or security teams need the recommended minimum-now Wrkr path: deterministic org posture first, then compliance-ready evidence that can be verified offline.
Hosted prerequisites for this path:
- pass
--github-api https://api.github.com(or setWRKR_GITHUB_API_BASE) - provide a GitHub token for private repos or to avoid public API rate limits
- token resolution order is
--github-token, configauth.scan.token,WRKR_GITHUB_TOKEN, thenGITHUB_TOKEN - fine-grained PAT guidance: select only the target repositories and grant read-only repository metadata plus read-only repository contents
- connector endpoints:
GET /orgs/{org}/repos,GET /repos/{owner}/{repo},GET /repos/{owner}/{repo}/git/trees/{default_branch}?recursive=1,GET /repos/{owner}/{repo}/git/blobs/{sha} - if hosted prerequisites are not ready yet, start with
wrkr scan --path ./your-repo --jsonorwrkr scan --my-setup --jsonfirst and return to this flow when GitHub access is configured;--pathscans the selected directory itself when it is the repo root and uses bundle roots like./scenarios/wrkr/scan-mixed-org/reposwhen you want a deterministic repo-set
wrkr init --non-interactive --org acme --github-api https://api.github.com --json
wrkr scan --config ~/.wrkr/config.json --state ./.wrkr/last-scan.json --timeout 30m --profile assessment --json --json-path ./.wrkr/scan.json --report-md --report-md-path ./.wrkr/scan-summary.md --sarif --sarif-path ./.wrkr/wrkr.sarif
wrkr report --state ./.wrkr/last-scan.json --template ciso --md --md-path ./.wrkr/ciso.md --pdf --pdf-path ./.wrkr/ciso.pdf --evidence-json --evidence-json-path ./.wrkr/report-evidence.json --csv-backlog --csv-backlog-path ./.wrkr/control-backlog.csv --json
wrkr evidence --frameworks eu-ai-act,soc2,pci-dss --state ./.wrkr/last-scan.json --output ./wrkr-evidence --json
wrkr verify --chain --state ./.wrkr/last-scan.json --jsonwrkr evidence now requires the saved proof chain to be intact before it stages or publishes a bundle, and wrkr verify --chain --json remains the explicit operator/CI integrity gate.
wrkr init can now persist the hosted GitHub API base together with the default org target, so the follow-on wrkr scan --config ... path stays copy-pasteable without repeating --github-api on every run.
If a hosted org scan is interrupted, rerun the same target with --resume to reuse checkpointed materialization state under the scan-state directory:
wrkr scan --config ~/.wrkr/config.json --state ./.wrkr/last-scan.json --resume --json --json-path ./.wrkr/scan.jsonInterpretation notes:
- retry, cooldown, resume, per-repo materialization completion, local repo discovery, scan phase, and completion progress lines are additive stderr-only operator UX in
--jsonmode partial_result,source_errors, orsource_degradedmeans the org posture is incomplete and should be rerun before downstream campaign-style aggregationorg-checkpoints/is resumability metadata beside the scan state, not a proof artifact--resumerevalidates checkpoint files and reused materialized repo roots before detector execution, so symlink-swapped resume state is blocked as unsafe
Optional deeper triage after the saved state exists:
wrkr mcp-list --state ./.wrkr/last-scan.json --gait-trust ~/.gait/trust-registry.yaml --json
wrkr report --top 5 --template appsec --jsonscan(hosted org mode):status,target,findings,ranked_findings,top_findings,inventory,repo_exposure_summaries,profile,posture_scoreinventory.security_visibility_summarygives you the additiveunknown_to_securitycounts and reference basis for that runagent_privilege_map[*]is instance-scoped and includesagent_instance_id,write_capable, andsecurity_visibility_status
evidence:status,output_dir,frameworks,manifest_path,chain_path,framework_coverageevidence.coverage_note: additive interpretation for low/zero first-run coverage; treat it as an evidence-gap signal, not unsupported framework parsingevidence.next_steps: additive machine-readable handoff guidance for verify/report sequencing and generated artifact-field reviewverify:status,chainmcp-list:status,generated_at,rows, optionalwarningsreport:status,generated_at, additivenext_steps,top_findings,total_tools,summary, optionalartifact_paths
scanandmcp-listanswer inventory, privilege, and trust-overlay questions.scan --profile assessmentgives the bounded customer-readout view of risky write paths first while leaving raw findings and proof artifacts intact.scanis the place to count unknown-to-security write-capable paths; useinventory.security_visibility_summary.unknown_to_security_write_capable_agentsonly wheninventory.security_visibility_summary.reference_basisis present for that run.reportgives the ranked operator summary for triage and can emit customer-ready CISO/AppSec/platform/audit/customer-draft artifacts led by the control backlog.reportis a saved-state renderer for static posture and offline proof artifacts; it is not a live observation surface.report.next_stepsandevidence.next_stepsare additive machine-readable sequencing hints for the operator-to-auditor handoff path; use them when you want automation or agents to follow the same artifact workflow the docs describe, using the referenced artifact fields in the same payload.evidencepackages the saved posture into portable proof artifacts only when the saved proof chain is intact, andverifyremains the explicit machine gate for proof integrity.coverage_noteis the machine-readable companion toframework_coverage; use it when handing results to operators or downstream automation so sparse first-run evidence is framed as a remediation queue instead of a parser failure.
Operator runs:
wrkr scan --config ~/.wrkr/config.json --state ./.wrkr/last-scan.json ... --jsonwrkr report --state ./.wrkr/last-scan.json --template ciso --md --md-path ./.wrkr/ciso.md --pdf --pdf-path ./.wrkr/ciso.pdf --evidence-json --evidence-json-path ./.wrkr/report-evidence.json --csv-backlog --csv-backlog-path ./.wrkr/control-backlog.csv --jsonwrkr evidence --frameworks eu-ai-act,soc2,pci-dss --state ./.wrkr/last-scan.json --output ./wrkr-evidence --jsonwrkr verify --chain --state ./.wrkr/last-scan.json --json
Buyer, GRC, or audit consumer reads:
./.wrkr/ciso.mdor./.wrkr/ciso.pdffor the narrative summary./.wrkr/report-evidence.jsonfor machine-readable report evidence./.wrkr/control-backlog.csvfor owner/SLA/closure tracking./wrkr-evidence/for the portable bundle, manifest, framework mappings, and proof artifacts- the
verify --chain --jsonresult for explicit integrity confirmation
Use report.next_steps and evidence.next_steps when you want automation to follow this same packet flow without reconstructing the sequence from docs.
Wrkr does not perform live MCP probing or package/server vulnerability assessment in this workflow. Use dedicated scanners such as Snyk for those surfaces. Gait interoperability is optional and provides control-layer context rather than a requirement to run Wrkr.
Canonical state, baseline, manifest, and proof-chain paths are documented in docs/state_lifecycle.md.