Skip to main content

A Command Line Interface to Open AI

Project description

OAICLI 🕶️

A Command Line Interface to Open AI (pronounced Oakley (IPA oʊk.li)

OAICLI is designed to help developers create and use assistants, which were launched on OpenAI Dev Day, November 2023.

Threads, messages, and thread runs are abstracted, to make the user experience of creating and chatting with agents simpler. Your files, agent prompts, and messages will be saved to .oaicli, from which you can edit prompts and files.

Use at your own risk.

I built this for myself. Feel free to open issues and PRs. If you want a complete implementation of what Assistants are capable of, you can use the friendly OpenAI playground.

installation

pip install oaicli

Next, creat an .env file in your project home:

OPENAI_API_KEY  = "[your key]"
OPEN_AI_MODEL_TYPE = "gpt-4-1106-preview"
OPEN_AI_VISION_MODEL_TYPE = "gpt-4-1106-vision-preview"

When you first run oaicli, it will install the .oaicli directory in the project location. You could version prompts for example in your repo, and then update your agents.

Threads are given names to make it easier to choose.

Commands

oaicli -h | --help for help

Quickstart

oaicli start - allows you to start up quickly, choose a thread, agent, and start communicating.

If runs reach a time limit, they will be canceled.

File and Agent maintenance

Otherwise there is some agent and file maintenence.

oaicli file upload
oaicli file list
oaicli file download-all

Screenshot of running oaicli start

Roadmap

v0.3-0.5

  • upload doc from url, or get web contents
  • cat a directory into a single file and upload
  • share publicically OAICLI help agent, uploading entire github repo. For example "what changes would you make to README.md based on the source code"
  • pydantic refactor
  • stream response to console

v1.x

Have agents select and talk to each other.

Other:

Development

https://github.com/HumanAssistedIntelligence/OAICLI https://pypi.org/project/oaicli/

pyenv install 3.12
pyenv virtualenv 3.12 oaicli
export PYTHONPATH="[project path]/oaicli
pip install .

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

oaicli-0.2.4.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

oaicli-0.2.4-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file oaicli-0.2.4.tar.gz.

File metadata

  • Download URL: oaicli-0.2.4.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for oaicli-0.2.4.tar.gz
Algorithm Hash digest
SHA256 24e1e141c04d02b03f27e4f9b63a9dc734923f182bee5e40aad9e34797b5715e
MD5 9ae4c069e4b13edede49002058da5c29
BLAKE2b-256 72ff4a537956f223aa41ca89b4867af31df3a8b700b80d413ca1e44ab4f51170

See more details on using hashes here.

File details

Details for the file oaicli-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: oaicli-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for oaicli-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ae474133fe99ce24e04816363f018371c4ed4eeb9f1bd2f9ea1ef05979dbe97f
MD5 a4274e2815b0ba884004a63c41ea0f72
BLAKE2b-256 0bb4f1e1dc465b1c7bfdc273a80e8471c6c10e1411adb8d6527d982a61df54bd

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