Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.05 KB

readme.md

File metadata and controls

57 lines (38 loc) · 1.05 KB
Raw
AI Checks

AI Checks

A CLI that helps you to identify potential bugs in your code and suggest changes for better code quality.

Current version

Setup

  1. Install aichecks:

    npm install -g aichecks

  2. Retrieve your API key from OpenAI

  3. Set the key:

    aichecks config set OPENAI_API_KEY=<your token>

Upgrading

First check for the installed version using:

aichecks --version

If it's not the latest version, run:

npm update -g aichecks

Usage

CLI mode

Call aichecks <file path> to generate suggestion for a specific file:

aichecks /src/index.js

Options

OPENAI_KEY

Required

The OpenAI API key. You can get it from OpenAI API Keys page.