specilot/README.md

Unit-tests AI generator

# Summary

Specilot is a CLI tool that simplifies unit test generation for JavaScript and TypeScript projects.
With optimized AST parsing of your code tree and the power of OpenAI API, create your unit tests in seconds!


## Features

- Generates unit tests automatically
- Supports Jest framework (more tools comming soon)
- CLI-friendly and easy to integrate


## Installation

npm install -g specilot


## Usage

1. Insert your OpenAI API KEY in project env or your system env file
SPECILOT_API_KEY = _YOUR-OPENAI-API-KEY_

2. specilot ./path-to-file method-name
will generate .spec file with unit-tests that cover the method's logic


## Licence

Apache License 2.0

## Author

Artem S.
https://github.com/artdev78889