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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file topenai-0.0.8.tar.gz.

File metadata

  • Download URL: topenai-0.0.8.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for topenai-0.0.8.tar.gz
Algorithm Hash digest
SHA256 d0d5fca85d18da2385c9a30454bf112f7b18d92e4d87c2a8c5b3a153065cf52f
MD5 1e25776fb94fdb57c6eef31e36373a32
BLAKE2b-256 eaf8febbfac6ca11c49c3f3180ec39ca00e8b50dfaba368710ddf70d1353c404

See more details on using hashes here.

File details

Details for the file topenai-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: topenai-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for topenai-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c112cf1d5a2b463f23a8b97b81e8463f0c28355687384e3d81d0de7024079942
MD5 1c27d5472d4e924faa54dbbe241420c8
BLAKE2b-256 0cecbb7be7a1cda0b08ed24039f951aa364d1836c7766e84c5bf9915871681c2

See more details on using hashes here.

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