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

experimental

Probably broken. If you want autocompletion (useful for editing agents and uploading files)

For Bash:

eval "$(_OAICLI_COMPLETE=source_bash oaicli)"

For Zsh:

eval "$(_OAICLI_COMPLETE=source_zsh oaicli)"

Roadmap

v0.3

  • 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"

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.2.tar.gz (19.5 kB view hashes)

Uploaded Source

Built Distribution

oaicli-0.2.2-py3-none-any.whl (18.2 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