ScannerClient

Overview

ValiqorScanner performs static analysis on your codebase to detect AI-related patterns — LLM calls, tool definitions, retrieval pipelines, and prompt templates. Scan results can be uploaded to the Valiqor backend for use in failure analysis and project setup.

from valiqor import ValiqorClient

client = ValiqorClient(api_key="your-api-key", project_name="my-app")
scanner = client.scanner

Or standalone:

from valiqor.scanner import ValiqorScanner

scanner = ValiqorScanner()
scanner.configure(api_key="your-api-key", project_name="my-app")

`ValiqorScanner`

Constructor

ValiqorScanner()

The scanner loads configuration from .valiqorrc on initialization. Use configure() to set credentials programmatically.

Properties

Property	Type	Description
`is_configured`	`bool`	Whether the scanner has valid API credentials.
`project_name`	`Optional[str]`	The active project name.
`backend_url`	`str`	The backend URL.

`configure()`

Set scanner configuration programmatically. Returns self for method chaining.

def configure(
    self,
    api_key: str = None,
    project_name: str = None,
    backend_url: Optional[str] = None,
    local_output_dir: Optional[str] = None,
    valiqor_intelligence: bool = None,
    environment: str = None,
    debug: bool = None,
    verbose: bool = False,
) -> ValiqorScanner

Parameter	Type	Default	Description
`api_key`	`str`	`None`	Valiqor API key.
`project_name`	`str`	`None`	Project name.
`backend_url`	`Optional[str]`	`None`	Backend URL override.
`local_output_dir`	`Optional[str]`	`None`	Local directory for scan output files.
`valiqor_intelligence`	`bool`	`None`	Whether to upload results to Valiqor backend.
`environment`	`str`	`None`	Environment label.
`debug`	`bool`	`None`	Enable debug output.
`verbose`	`bool`	`False`	Enable verbose logging.

scanner = ValiqorScanner().configure(
    api_key="your-api-key",
    project_name="my-app",
    verbose=True
)

`scan()`

Run a scan on a repository or directory.

def scan(self, repo_path: str, skip_upload: bool = False) -> ScanResult

Parameter	Type	Default	Description
`repo_path`	`str`	—	Path to the repository or directory to scan.
`skip_upload`	`bool`	`False`	If `True`, only scan locally without uploading results.

Returns: ScanResult

result = scanner.scan("./my-ai-app")
print(f"Status: {result.status}")
print(f"Files generated: {result.files_generated}")
print(f"Scan ID: {result.scan_id}")

`ScanResult`

Returned by scan(). Contains scan metadata and output file paths.

Attribute	Type	Description
`status`	`str`	Scan status (`"success"` or `"error"`).
`project_name`	`str`	Project name used for the scan.
`scan_id`	`str`	Unique identifier for this scan.
`local_output_dir`	`str`	Directory where output files were written.
`files_generated`	`List[str]`	List of generated output file paths.
`files_uploaded`	`List[str]`	List of files uploaded to the backend.
`upload_response`	`Optional[Dict]`	Backend response from upload (if applicable).
`error`	`Optional[str]`	Error message if scan failed.
`timestamp`	`str`	ISO timestamp of the scan.

result_dict = result.to_dict()

`quick_scan()` — Convenience Function

A one-call function that creates a scanner, configures it, and runs a scan:

from valiqor.scanner import quick_scan

result = quick_scan(
    api_key="your-api-key",
    project_name="my-app",
    repo_path="./my-ai-app",
    verbose=True
)

Parameter	Type	Default	Description
`api_key`	`str`	—	Valiqor API key.
`project_name`	`str`	—	Project name.
`repo_path`	`str`	—	Path to scan.
`backend_url`	`str`	`None`	Backend URL override.
`verbose`	`bool`	`False`	Enable verbose logging.

Code Scanning Workflow — Step-by-step scanning guide
Configuration — .valiqorrc and env var reference

Client

Modules

Utilities

Overview

`ValiqorScanner`

Constructor

Properties

`configure()`

`scan()`

`ScanResult`

`quick_scan()` — Convenience Function

​Overview

​ValiqorScanner

​Constructor

​Properties

​configure()

​scan()

​ScanResult

​quick_scan() — Convenience Function

​Related

Overview

`ValiqorScanner`

Constructor

Properties

`configure()`

`scan()`

`ScanResult`

`quick_scan()` — Convenience Function

Related