Installation

This guide will walk you through the process of installing testcode.ai, validating your license, and preparing your environment for generating unit tests.

Prerequisites & OS Requirements

While testcode.ai is built using Python and leverages open-source tools internally, you don't need to install Python or any dependencies yourself. We distribute testcode.ai as a fully built binary.

Installation

Streamlined Installation with uv

testcode.ai uses uv to provide a seamless installation experience. This approach solves common Python installation challenges like:

• Dependency version conflicts
• Virtual environment management
• Python version requirements
• System-wide Python installation issues

Our installation script handles everything automatically:

1. Installs uv if not present
2. Uses uv to create an isolated environment
3. Installs Python 3.12 if needed
4. Installs testcode.ai and all its dependencies
5. Updates your shell's PATH

One-line Installation (Recommended)

Install testcode.ai with a single command, even if you don't have Python installed:

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

This command:

• Downloads and installs uv
• Creates an isolated Python environment
• Installs testcode.ai with all dependencies
• Configures your environment automatically

How it Works

Under the hood, our installer:

1. Uses uv's installation script (based on https://astral.sh/uv/install.sh)
2. Creates an isolated Python environment with version 3.12
3. Installs testcode.ai from our private PyPI repository
4. Configures your PATH to access the probe command

This approach ensures:

• Consistent Python version (3.12)
• No conflicts with existing Python installations
• All dependencies are properly isolated
• No system-wide Python modifications
• Works even without Python pre-installed

License validation

After installation, the first step is to validate your license key:

probe validate YOUR_LICENSE_KEY

Replace YOUR_LICENSE_KEY with the license key you received via email when purchasing testcode.ai.

License validation system

testcode.ai uses Keygen for license validation, a secure and reliable licensing system. When you validate your license:

1. Your license key is securely sent to the Keygen API
2. The validation status is verified
3. A local validation token is stored for offline use
4. Periodic revalidation occurs to ensure license compliance

Obtaining a license

If you don't have a license key, you can get one from the testcode.ai website.

License validation status

To check if your license is valid, you can run any testcode.ai command. If your license is invalid or expired, you'll be prompted to validate it again.

LLM integration and privacy

OpenAI integration

testcode.ai uses the OpenAI Python package internally to interact with LLM models for test generation. By default, testcode.ai is configured to use the o3-mini model, which provides a good balance of performance and cost.

Data privacy

We take your privacy seriously:

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

This architecture ensures that your code remains private and secure while still benefiting from advanced LLM capabilities.

Verifying installation

To verify that testcode.ai is installed correctly, run:

probe --help

This should display the help information for testcode.ai, including available commands and options.

Testing the installation

After validating your license, try generating a simple test to ensure everything is working correctly:

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

If you see the method selection interface, your installation is working correctly.

Uninstallation

If you need to remove testcode.ai from your system:

Automatic uninstallation

See existing uv tool lists

uv tool list

Run the following command to remove probe and its dependencies:

uv tool uninstall probe

Complete removal

To completely remove everything including uv and the virtual environment:

1. Remove the probe command:

rm -f ~/.local/bin/probe

2. Remove uv:

rm -f ~/.local/bin/uv ~/.local/bin/uvx

3. Remove the probe virtual environment and configuration:

rm -rf ~/.probe

4. Remove uv's cache (optional):

rm -rf ~/.uv

Troubleshooting

Common installation issues

Binary not found

If the probe command is not found after installation:

• Ensure the installation directory is in your PATH
• Try restarting your terminal
• Check if the binary was installed to a different location

License validation issues

If you encounter issues with license validation:

• Ensure you have an active internet connection for initial validation
• Check that your license key is entered correctly
• Contact support if your license should be active but isn't being recognized

Getting help

If you continue to experience issues with installation, please contact our support team contact@codeintegrity.ai

Next steps

Now that you have testcode.ai installed and your license validated, you're ready to start generating unit tests for your Python code. Check out the Getting Started guide to learn how to use testcode.ai effectively.