Quick Start Guide
Get up and running with AIToTest in minutes
Prerequisites
- Node.js 14 or higher (16.x LTS recommended)
- npm (v7+) or yarn (v1.22+) package manager
- Git version control system
- A code repository (GitHub, GitLab, or Bitbucket)
- Python 3.8+ (for advanced features)
System Requirements
- Minimum 4GB RAM (8GB recommended)
- 2GB free disk space
- Multi-core processor (4+ cores recommended)
- Active internet connection for AI model access
Installation Steps
1. Install the AIToTest CLI
Install our command-line interface globally:
npm install -g aitotest-cli
For yarn users: yarn global add aitotest-cli
2. Initialize Your Project
Navigate to your project directory and initialize AIToTest:
cd your-project
aitotest init
This will create:
aitotest.config.js
- Main configuration fileaitotest.ignore
- Files to exclude from testing.aitotest/
- Directory for AI models and cache
3. Configure Your Project
Edit aitotest.config.js
to match your project needs:
module.exports = {
testFramework: 'jest', // or 'mocha', 'vitest'
language: 'typescript', // or 'javascript', 'python'
coverage: {
threshold: 80,
reporter: ['text', 'lcov']
},
ai: {
model: 'standard', // or 'advanced' for enterprise
customPrompts: './prompts',
temperature: 0.7
},
integrations: {
github: true,
jira: false,
slack: false
}
}
4. Generate Your First Tests
Start generating tests for your code:
# Generate tests for a specific file
aitotest generate src/components/Button.tsx
# Generate tests for an entire directory
aitotest generate src/components
# Generate tests with specific options
aitotest generate --coverage 90 --framework jest src/
5. CI/CD Integration
Add AIToTest to your CI/CD pipeline:
# GitHub Actions Example
name: AIToTest CI
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: aitotest/github-action@v1
with:
api-key: ${{ secrets.AITOTEST_API_KEY }}
config: aitotest.config.js
Next Steps
Advanced Configuration
Learn how to customize AIToTest for your specific needs
CI/CD Setup
Detailed guides for various CI/CD platforms
Best Practices
Tips and tricks for effective AI-powered testing
Troubleshooting
Common issues and their solutions
Need Help?
Join our Discord community for support, or check out our FAQ for common questions. Enterprise customers can access priority support through their dedicated portal.