Skip to content

Scan API

The client.scan namespace exposes the GitHub App client, remediation planning, and semantic code ingestion for CRP Scan.

SDK proxy

crp.sdk.proxies_extra._ScanProxy

CRP Scan proxy (SPEC-013, SPEC-036, SPEC-039, SPEC-048).

Exposes the GitHub App client, remediation planning, and semantic code ingestion.

github_app()

Return the GitHub App client for scan remediations.

Returns:

Type Description
Any

CRPScanGitHubApp wrapper instance.

remediation(advisory)

Plan a remediation for a scan advisory.

Parameters:

Name Type Description Default
advisory dict[str, Any] | str

Either a dict describing a finding or a short message.

required

Returns:

Type Description
Any

RemediationProposal instance.

ingest_code(text)

Add text as a fact node to a CodeGraph.

Parameters:

Name Type Description Default
text str

Arbitrary text to store as a code fact.

required

Returns:

Type Description
Any

The fact_id of the created fact.