Quick Start

This guide will get you up and running with NOIV in under 5 minutes.

Step 1: Install NOIV

Linux/macOS Recommended

pip install --user --upgrade noiv
export PATH="$HOME/.local/bin:$PATH"

Windows

pip install --upgrade noiv

Step 2: Your First Test

Let's test a public API endpoint to see NOIV in action:

Linux/macOS

noiv quick https://api.github.com/users/octocat

Windows

noiv quick https://api.github.com/users/octocat

You should see output similar to this:

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                                              Quick Test Results                                              ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

🎯 Status: 200 OK (✓)
⏱️  Response Time: 342ms
📦 Content Type: application/json
📏 Response Size: 1.2KB
🔒 HTTPS: Yes

Step 3: Generate Tests with AI

Now let's use AI to generate a comprehensive test suite:

Linux/macOS

noiv generate natural "test GitHub user API with profile validation and error handling"

Windows

noiv generate natural "test GitHub user API with profile validation and error handling"

This creates a YAML file with multiple test scenarios:

name: 'Tests: Test GitHub user API with profile validation and error handling'
tests:
- name: Get Valid User Profile
  url: https://api.github.com/users/octocat
  method: GET
  expected_status: 200
  validations:
    - type: json_path
      path: $.login
      expected: octocat
- name: Get Invalid User Profile
  url: https://api.github.com/users/nonexistentuser123456
  method: GET
  expected_status: 404

Step 4: Run Generated Tests

Execute your AI-generated tests:

noiv test run generated_tests.yaml

You'll see a beautiful progress bar and detailed results:

Running test suite: Tests: Test GitHub user API...
Total tests: 2
Running tests... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01

      Test Results Summary      
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ Metric            ┃ Value    ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
│ Total Tests       │ 2        │
│ Passed            │ 2        │
│ Failed            │ 0        │
│ Success Rate      │ 100.0%   │
│ Avg Response Time │ 285.5ms  │
└───────────────────┴──────────┘

Step 5: Performance Testing

Test how well an API performs under load:

noiv benchmark https://api.github.com/users/octocat -n 50 -c 5

Get detailed performance metrics:

       Benchmark Results       
┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
┃ Metric          ┃ Value     ┃
┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
│ Total Requests  │ 50        │
│ Successful      │ 50        │
│ Failed          │ 0         │
│ Requests/sec    │ 15.23     │
│ Avg Response    │ 328.45ms  │
│ 95th Percentile │ 456.78ms  │
└─────────────────┴───────────┘

Step 6: Interactive Test Builder

For more control, use the interactive builder:

noiv build

This opens a step-by-step wizard:

╭──────────────────────────╮
│ Interactive Test Builder │
╰──────────────────────────╯

Test name: My API Tests
Base URL (https://api.example.com): https://api.github.com

Creating test #1
HTTP method [GET/POST/PUT/DELETE/PATCH] (GET): GET
Endpoint path (/): /users/octocat
Add custom headers? [y/n] (n): y
Header name: Accept
Value for Accept: application/json
...

What's Next?

Congratulations! You've completed the quick start. Here are some next steps:

• Learn AI Generation - Master natural language test creation
• Performance Testing - Deep dive into benchmarking
• Import Tools - Migrate from Postman collections
• HTML Reports - Generate beautiful test reports
• View Examples - Real-world testing scenarios

Common Commands Reference

Command	Description
noiv quick <url>	Test endpoint instantly
noiv generate natural "<desc>"	AI test generation
noiv build	Interactive test builder
noiv benchmark <url>	Performance testing
noiv test run <file>	Execute test suite
noiv test history	View test history
noiv report html	Generate HTML report

TIP

All NOIV commands have help available with --help flag:

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