Adding basic-messenger-cli to README

This commit is contained in:
Peter Morton 2025-04-25 17:27:24 -05:00
parent b71ab9dc0f
commit ebf7017da5

View File

@ -1,61 +1,31 @@
# Node Chat CLI # Basic Messenger CLI
## Overview ## Overview
Node Chat CLI is a command line chat program that allows users to interact with OpenAI's API using the o4-mini model. Users can maintain multiple conversations, choose to start new conversations, or continue previous ones.
## Features Basic Messenger CLI is a command line chat program that allows users to interact with IVA Studio's basic-messenger API.
- Start a new conversation
- Continue existing conversations
- Store and retrieve conversation history
- Interact with OpenAI's API for responses
## Installation ## Installation
1. Clone the repository: 1. Install the dependencies:
```
git clone <repository-url>
```
2. Navigate to the project directory:
```
cd node-chat-cli
```
3. Install the dependencies:
``` ```
npm install npm install
``` ```
4. Create a `.env` file in the root directory and add your OpenAI API key: 2. Create a `.env` file in the root directory and add your END_POINT and MODEL:
``` ```
OPENAI_API_KEY=your_api_key_here END_POINT=https://router.ivastudio.verint.live/ProxyScript/run/67bca862210071627d32ef12/current/basic_messenger
MODEL=main
``` ```
## Usage ## Usage
To start the application, run: To start the application, run:
``` ```
node src/index.js node start
``` ```
Follow the prompts to start a new conversation or continue an existing one.
## Example
1. Start a new conversation:
```
> Start a new conversation
```
2. Continue a previous conversation:
```
> Continue conversation with ID 1
```
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue for any suggestions or improvements.
## License ## License
This project is licensed under the MIT License. This project is licensed under the MIT License.