Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 1.61 KB

README.md

File metadata and controls

89 lines (57 loc) · 1.61 KB

AI CLI Tool

A command-line interface tool that allows you to interact with OpenAI's GPT models directly from your terminal.

Prerequisites

  • Node.js (version 14 or higher)
  • An OpenAI API key (Get one here)

Installation

Since this package isn't published to npm yet, you can install it locally:

  1. Clone this repository
git clone git@github.com:gasatrya/ai-cli.git
cd ai-cli
  1. Install dependencies
npm install
  1. Link the package locally
npm link

Configuration

Before using the tool, you need to configure your OpenAI API key. You have two options:

Option 1: First-time setup

When you run the tool for the first time without a configured API key, it will prompt you to enter your OpenAI API key.

Option 2: Configuration menu

Run the configuration menu:

ai-cli config

In the configuration menu, you can:

  1. Add/Update your API key
  2. Choose the AI model:
    • gpt-4o-2024-11-20
    • gpt-4o-mini-2024-07-18

Usage

Start Interactive Session

ai-cli

This will start an interactive session where you can:

  • Type your questions and get responses from the AI
  • Type 'exit' to quit the session

Example

ai-cli> What is the capital of France?
[AI will respond with the answer]

ai-cli> exit
Goodbye!

Features

  • Interactive CLI interface
  • Markdown rendering for AI responses
  • Loading animation while waiting for responses
  • Configuration persistence
  • Support for multiple GPT models

Configuration File

The configuration is stored in ~/.ai-cli-config.json in your home directory.