Skip to main content

CLI tool to chat with OpenAI GPT

Project description

topenai

GitHub last commit (branch) GitHub Workflow Status (with event)

topenai (terminal openai) — a simple command line interface tool to interact with OpenAI.

Installation

pip install topenai

How to get an OpenAI API key

OpenAPI models

To install the latest testing version (may contain more bugs), run:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ topenai

Features

  • Multiple chat threads
  • Chat history
  • Rename, delete and switch sessions

Usage

Run topenai in your terminal

  • Enter /new to start a new chat (/n)
  • /switch <chat_id> to change chat (/s)
  • /list to list all chats (/l)
  • /rename <old_id> <new_id> to rename a chat (/r)
  • /delete <chat_id> to delete a chat (/d)
  • /apikey to change API key
  • /model to change model
  • /help to display this help message (/h)
  • /exit to exit (/e)

Known issues

  • UUIDs of sessions instead of readable names
  • Rename is not working

Developing Setup

If you want to set this package up for directly editing it's source code (for contributing):

  1. Clone the package

     git clone https://github.com/vladzima/topenai
    
  2. Create a dynamic link This will make the package dynamically update with your local changes:

     pip install -e .
    

TODO

  • Make chat history more accesible
  • Allow OpenAI API fune-tuning parameters
  • Migrate to official OpenAI python API client

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

topenai-0.0.8.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

topenai-0.0.8-py3-none-any.whl (6.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page