Skip to content

shinichi-takayanagi/oregpt

Repository files navigation

oregpt

workflow license release python-version pypi

A tiny GPT CLI tool. You can chat with the GPT model developped by OpenAI and save the conversation as json.

oregpt

Installation

Get your own OpenAI API Key

Assuming you have an environment variable with key named OPENAI_API_KEY. If you don't have a OpenAI API key visit here, generate one and add it as an environment variable

export OPENAI_API_KEY=<YOUR-OPENAI-API-KEY>

Instal from PyPI

You can install the package using pip:

$ pip install oregpt

Usage

Once you have installed oregpt, you can run it by typing:

$ oregpt

Configuration

You can specify the place of conversation log, style (color etc) and the model supported in /v1/chat/completions endpoint provided by OpenAI in ~/.oregpt/config.yml

❯ cat ~/.oregpt/config.yml
log: /tmp/oregpt/
openai:
    model: gpt-3.5-turbo
# You can also specify OpenAI's API key here
#     api_key: <your-api-key>
character:
    user:
        name: Me
        style: "#00BEFE"
    assistant:
        name: AI
        style: "#87CEEB"
    system:
        name: System
        style: "#cc0000"