Skip to main content

A CLI for OpenAI's API

Project description

CLI OpenAI

CLI OpenAI (cloai) is a command-line interface for interacting with the OpenAI API. It provides a set of commands to interact with various OpenAI services such as GPT, Speech-to-Text (STT), Text-to-Speech (TTS), and Image Generation.

Installation

To install cloai, you can use the following command:

pip install cloai

Usage

Before running cloai, make sure the environment variable OPENAI_API_KEY is set to your OpenAI API key.

To use the CLI, run cloai --help in your terminal. This will display a list of available commands and their descriptions.

Here is a brief overview of the main commands:

  • cloai gpt --help: Shows the usages of the GPT command. The GPT command is used to generate text with OpenAI's GPT models. As there are several usage options, the help command is the best way to learn how to use it.

  • cloai dalle <prompt>: Generates images with OpenAI's DALL-E. The prompt argument is the text prompt to generate the image from.

  • cloai stt <filename>: Transcribes audio files with OpenAI's STT models. The filename argument is the file to transcribe. It can be any format that ffmpeg supports. Use the --clip option to clip the file if it is too large.

  • cloai tts <text>: Generates audio files with OpenAI's Text to Speech models. The text argument is the text to convert to speech.

Each command has additional options that can be viewed by running cloai <command> --help.

Contributing

Contributions are welcome! Please see the contributing guidelines for more information.

License

cloai is licensed under the terms of the L-GPLv2.1 license.

Support

If you encounter any issues or have any questions, please report them on our issues page.

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

cloai-0.1.0.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

cloai-0.1.0-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file cloai-0.1.0.tar.gz.

File metadata

  • Download URL: cloai-0.1.0.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cloai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 85984f3f2c73d9cc2aaaffa777b4912c8d761e3ccc74ee3148f8dbb7e1c569a2
MD5 10adcaefc91e27376edbaf0ecc1e5735
BLAKE2b-256 78a9e074f1e8bcff5dfaa7e9753326a21f27900d6090b67cadae7cc8ee89d13f

See more details on using hashes here.

File details

Details for the file cloai-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: cloai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 25.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cloai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7febaa8354ca29caf13630742285e1f6d6d12d086539d4720f0627434c8c75d3
MD5 9b5683439b6bfc715a2e286401eb2adc
BLAKE2b-256 9673b1514bcc543fe85a31f443244d672763fbf9585ef2990bf92daef50e84d4

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