testcode.ai

Automated test generation powered by AI.

Generate comprehensive unit tests with the CLI tool that analyzes your code and creates tests using advanced LLM technology.

Get started
quickstart.sh
# Step 1: Install testcode.ai
curl -fsSL https://testcode.ai/install.sh | LICENSE_KEY=your-license-key sh


# Step 2: Validate your license key
probe validate YOUR_LICENSE_KEY


# Step 3: Generate tests for your Python code
probe testgen --source path/to/your/file.py

Introduction

Getting started with testcode.ai

Learn how to use testcode.ai, a powerful CLI tool that generates comprehensive unit tests for your Python code.

Installation

Step-by-step guides to installing testcode.ai and setting up your environment.

Core concepts

Learn how testcode.ai analyzes your code and generates tests.

CLI commands

Explore the available commands and options in the testcode.ai CLI.

testcode.ai is a CLI software testing tool developed by CodeIntegrity, Inc. that analyzes code structure, identifies dependencies, and generates comprehensive unit tests using advanced LLM technology. testcode.ai uses probe as its core engine to generate tests through static code analysis.

Python Only (BETA)

probe currently only supports Python. Support for other languages will be added in future releases.

Quick start

Get up and running with testcode.ai in just a few minutes by following these simple steps.

Installing testcode.ai

Unlike many Python tools, testcode.ai is distributed as a fully built binary, so you don't need to install any Python dependencies. Simply run:

curl -fsSL https://testcode.ai/install.sh | LICENSE_KEY=your-license-key sh

This will install the probe binary on your system, which is the command-line interface for testcode.ai.

License required

testcode.ai requires a valid license key to function. You can obtain a license key by visiting testcode.ai. We use Keygen for secure license validation.

Validating your license (first step)

After installation, your first step should be to validate your license key that you received via email:

probe validate YOUR_LICENSE_KEY

This will store your license key locally, and it will be valid for 14 days before requiring revalidation. You must complete this step before you can generate any tests.

Generating your first test

Once your license is validated, you can generate a unit test for a specific method in your Python file:

probe testgen --source path/to/your/file.py

testcode.ai will analyze your file using static code analysis, display a list of methods, and let you select which one to test. It will then generate a comprehensive unit test for the selected method.

Method selection example

When you run the testgen command, you'll see a list of methods to choose from:

Analyzing src/utils/calculator.py...
Select a method to test:
→ add
  subtract
  multiply
  divide

Use the arrow keys to select a method and press Enter to generate tests for it.

Privacy and data handling

testcode.ai is designed with your privacy as a top priority:

  • Zero data retention: None of your code or test data is stored on our servers
  • Direct OpenAI integration: testcode.ai uses the OpenAI Python package to make API calls directly from your machine
  • Local processing: All code analysis happens locally on your machine
  • No server transmission: Your code never passes through testcode.ai servers

By default, testcode.ai uses OpenAI's o3-mini model for test generation, which provides a good balance of performance and cost. Your code is sent directly to OpenAI's API from your machine, and we never see or store it.

Basic usage

testcode.ai is designed to be simple yet powerful, making it easy to generate high-quality unit tests for your Python code.

Selecting a method to test

When you run the testgen command, testcode.ai will analyze your source file and display a list of available methods. Use the arrow keys to select the method you want to test, and press Enter to confirm your selection.

testcode.ai will then analyze the selected method, identify its dependencies, and generate a comprehensive unit test that covers the method's functionality.

Understanding the generated tests

The generated tests are written using pytest, a popular Python testing framework. Each test includes:

  • Proper imports and setup
  • Mock objects for dependencies
  • Test cases that cover different scenarios
  • Assertions to verify expected behavior

The tests are saved in the specified test directory (default: tests/) and follow standard naming conventions.

Customizing test generation

You can customize the test generation process by providing additional options to the testgen command:

probe testgen --source path/to/your/file.py --test-dir custom/test/dir --root-dir /path/to/project/root

This allows you to control where tests are generated and how testcode.ai analyzes your project structure.

Getting help

If you need assistance with testcode.ai, there are several resources available to help you.

Command-line help

You can get help for any testcode.ai command by using the -h or --help option:

probe --help
probe testgen --help

Community support

Join the testcode.ai community to get help from other users and the development team:

  • Visit testcode.ai for documentation and resources
  • Join our community forums for discussions and support
  • Follow us on social media for updates and tips

Reporting issues

If you encounter any issues with testcode.ai, please report them on our issue tracker. Be sure to include:

  • The version of testcode.ai you're using
  • A description of the issue
  • Steps to reproduce the problem
  • Any error messages or logs

We're committed to making testcode.ai the best testing tool available, and your feedback helps us improve.

Next
Installation