https://github.com/clebsf/terminal-ai
https://github.com/clebsf/terminal-ai
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/clebsf/terminal-ai
- Owner: clebsf
- Created: 2024-10-03T20:37:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-03T21:10:16.000Z (over 1 year ago)
- Last Synced: 2025-02-21T01:39:24.296Z (over 1 year ago)
- Language: Python
- Size: 11.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TERMINAL AI
## Description
Terminal AI is an AI assistant that runs directly in the user's terminal, utilizing the OpenAI API.
## Prerequisites
- Python 3.6 or higher
- A valid OpenAI API key
## Installation
1. Clone this repository:
```bash
git clone https://github.com/byClebert/terminal-ai.git
cd terminal-ai
```
2. Create a virtual environment (optional, but recommended):
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. Install the dependencies:
```bash
pip install -r requirements.txt
```
4. Set the environment variable with your OpenAI API key:
```bash
setx OPENAI_API_KEY "your_api_key_here" # On Windows
export OPENAI_API_KEY="your_api_key_here" # On Linux/Mac
```
## Usage
1. Start the application:
```bash
python main.py
```
2. Interact with the assistant by typing your questions or commands in the terminal.
3. To exit the application, type `exit` or press `Ctrl+C`.
## Creating an Executable
To create an executable of the project, follow these steps:
1. Install PyInstaller if you haven't already:
```bash
pip install pyinstaller
```
2. Run PyInstaller on the main script:
```bash
pyinstaller --onefile main.py
```
3. The executable will be located in the `dist` directory.
4. Run the executable directly on your system.
## Contribution
Feel free to open issues or submit pull requests for improvements.