Skip to content
This repository has been archived by the owner on Oct 6, 2024. It is now read-only.

Latest commit

 

History

History
34 lines (22 loc) · 1.45 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.45 KB

AI-Assistant

A CLI tool designed to help you with a variety of tasks. Makes it easy to interact with the OpenAI API. Whether you have a question, need an image, want to convert text to speech, or want to transcribe something, AI-Assistant is here to help.

If you need any help, please feel free to ask the AI-Assistant Helper GPT for assistance.

Installation

Follow these steps to get up and running. It is recommended to use a virtual environment to avoid package conflicts. Before doing any of this, navigate to the desired directory. You will also need to have Python installed on your machine.

  1. Clone the Repository:

    $ git clone https://github.com/johannesschiessl/AI-Assistant.git
    
  2. Navigate to the Project Directory:

    $ cd AI-Assistant
    
  3. Install Requirements:

    # On Windows / Linux: $ pip install -r requirements.txt
    # On MacOS: $ pip3 install -r requirements.txt
    
  4. Export your OpenAI API key to environmental variables

    # On MacOS / Linux: $ export OPENAI_API_KEY="your openai api key"
    # On Windows: $ setx OPENAI_API_KEY "your openai api key"
    
  5. Run the AI Assistant

    # On MacOS: $ python3 assistant/main.py
    # On Windows / Linux: $ python assistant/main.py
    

Issues

If you encounter any issues or have feature requests, feel free to open an issue.