API Reference

Complete reference for all NOIV commands and options.

Command Overview

NOIV provides several command groups for different testing workflows:

Command Group	Purpose	Key Commands
Core Testing	Basic test operations	quick, test run, test history
AI Features	Intelligent test generation	generate natural
Interactive	Guided test creation	build, explore
Performance	Load and stress testing	benchmark
Import/Export	Tool integration	import postman
Reporting	Result visualization	report html
Utilities	Project management	init, version

Global Options

All NOIV commands support these global options:

noiv [GLOBAL_OPTIONS] COMMAND [COMMAND_OPTIONS]

--help

Display help information for any command.

noiv --help
noiv generate --help
noiv benchmark --help

--version

Show NOIV version information.

noiv --version

Environment Variables

NOIV supports environment variables for configuration:

Variable	Description	Example
NOIV_API_KEY	Custom AI API key	export NOIV_API_KEY="your-key"
NOIV_BASE_URL	Default base URL	export NOIV_BASE_URL="https://api.example.com"
NOIV_TIMEOUT	Default request timeout	export NOIV_TIMEOUT=30
NOIV_HISTORY_DIR	Custom history directory	export NOIV_HISTORY_DIR="/custom/path"

Error Codes

NOIV returns standard exit codes:

Code	Meaning	Description
0	Success	Command completed successfully
1	General Error	Command failed with error
2	Invalid Usage	Incorrect command syntax
3	Network Error	Network connectivity issues
4	File Error	File not found or permission issues

Configuration Files

NOIV looks for configuration in these locations (in order):

1. ./noiv.yaml (current directory)
2. ~/.noiv/config.yaml (user home)
3. /etc/noiv/config.yaml (system-wide)

Example configuration:

# ~/.noiv/config.yaml
default_timeout: 30
history_limit: 100
auto_open_reports: true
default_concurrency: 10

Output Formats

NOIV supports different output formats:

Terminal Output

Rich, colored terminal output with progress bars and tables (default).

JSON Output

Machine-readable JSON for scripting:

noiv test run --output json tests.yaml

Quiet Mode

Minimal output for automated scripts:

noiv test run --quiet tests.yaml

Next Steps

Explore specific command references:

• noiv quick - Instant endpoint testing
• noiv generate - AI test generation
• noiv build - Interactive test builder
• noiv benchmark - Performance testing
• noiv test - Test execution and management
• noiv import - Import from other tools
• noiv report - Report generation

TIP

Use noiv COMMAND --help to get detailed help for any specific command.