CLI Overview

Installation

The CLI is included with the Valiqor Python SDK. Install it with pip:

pip install valiqor

After installation the valiqor command is available system-wide.

valiqor --version

--version also lists which optional modules are installed (Trace, Scanner, Eval, Security, Failure Analysis).

Command Structure

valiqor <command> [subcommand] [flags]

Command Group	Description
`login`	Authenticate via browser or credentials
`signup`	Create a new account
`logout`	Clear stored credentials
`verify`	Verify your email address
`keys`	Create, list, or delete API keys
`config`	Interactive setup, show, or update project settings
`status`	Show auth, config, and connection status
`test`	Validate configuration and connectivity
`upload`	Upload trace and scan files
`trace`	Initialize, apply, remove, and refresh tracing
`scan`	Run AST-based code scans
`eval`	Run evaluations and inspect results
`security`	Security audits and red-team simulations
`fa`	Failure analysis on traces and datasets

Global Options

Every command supports:

Flag	Description
`--help` / `-h`	Show help for any command or subcommand
`--version` / `-v`	Print SDK version and module availability

Credential Storage

The CLI stores credentials in two locations:

Location	Purpose	File
Global	Shared across all projects	`~/.valiqor/credentials.json`
Local	Per-project override	`.valiqorrc` in the project root

Credential resolution order:

CLI flag (--api-key)
Local .valiqorrc
Global ~/.valiqor/credentials.json
Environment variable VALIQOR_API_KEY

Configuration File

Project settings are stored in .valiqorrc (JSON) at the project root.

{
  "project_name": "my-app",
  "api_key": "vq-...",
  "trace_dir": "valiqor_output/traces",
  "scan_dir": "valiqor_output/scans",
  "environment": "development",
  "valiqor_intelligence": true,
  "debug": false
}

See Configuration for details on every key.

Module Availability

Some commands require optional SDK modules. The CLI checks availability at runtime and provides install hints when a module is missing.

Module	Required For
`valiqor.trace`	`trace` commands
`valiqor.scanner`	`scan` commands
`valiqor.eval`	`eval` commands
`valiqor.security`	`security` commands
`valiqor.failure_analysis`	`fa` commands

Run valiqor --version to see which modules are installed.

Quick Start

# 1. Sign up or log in
valiqor signup
valiqor login

# 2. Initialize a project
valiqor config

# 3. Verify everything works
valiqor test

# 4. Run your first evaluation
valiqor eval run --dataset data.json --metrics factual_accuracy,coherence

Getting Started

Commands

Installation

Command Structure

Global Options

Credential Storage

Configuration File

Module Availability

Quick Start

​Installation

​Command Structure

​Global Options

​Credential Storage

​Configuration File

​Module Availability

​Quick Start

Installation

Command Structure

Global Options

Credential Storage

Configuration File

Module Availability

Quick Start