A CLI for OpenAI's API
Project description
CLI-cloai
CLI-cloai is a Python command-line interface for interacting with the OpenAI API. It provides a set of commands to interact with various OpenAI services such as Speech-to-Text (STT), Text-to-Speech (TTS), and Image Generation.
Installation
To install CLI-cloai, you can use the following command:
poetry add git+https://github.com/cmi-dair/cli-cloai
Usage
Before running CLI-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 stt <filename>
: Transcribes audio files with OpenAI's STT models. Thefilename
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. Thetext
argument is the text to convert to speech. -
cloai image <prompt>
: Generates images with OpenAI's DALL-E. Theprompt
argument is the text prompt to generate the image from.
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
CLI-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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.