TermGPT

A Terminal-based Client for ChatGPT! Say goodbye to the switch process between windows.

About The Project

Overview

TermGPT is a streamlined, terminal-based client designed for seamless interactions with OpenAI's ChatGPT. It's born from the need to eliminate the constant window switching that developers, researchers, and enthusiasts face when jumping between their coding environment and the web-based ChatGPT interface.

Why TermGPT?

Efficiency: Stay within your terminal environment. No need to switch between windows or apps.
Intuitive Interface: Designed with simplicity in mind, TermGPT ensures that the user experience is smooth, straightforward, and free of distractions.
Quick Access: With TermGPT, getting a response from ChatGPT is just a command away, making it incredibly convenient for those who need instant feedback or assistance.
Customizable: Being open-source, you can customize TermGPT to best fit your workflow and preferences.

Features

Direct Integration: Communicate with ChatGPT without leaving your terminal.
Responsive UI: An interface that's easy to navigate and understand, ensuring a seamless chat experience.
Open-Source: TermGPT is community-driven. Developers are encouraged to contribute, enhance, and tailor the project to their needs.

(back to top)

TermGPT Build Instructions

Prerequisites

Before you begin, ensure you have the following installed:

Python 3.x

Building TermGPT

Building TermGPT is straightforward. Follow these simple steps:

Standard Build

Open your terminal.
Navigate to the root directory of the TermGPT project.
Run the following command:

python3 build.py

This will compile and create the TermGPT pip package.

Building in a Virtual Environment

If you prefer to build within a virtual environment, follow these steps:

Open your terminal.
Navigate to the TermGPT project directory.
Create a virtual environment:

python3 -m venv myenv

Replace myenv with your preferred environment name.

Activate the virtual environment:

On Windows:
```
myenv\Scripts\activate
```
On Unix or MacOS:
```
source myenv/bin/activate
```

Once the environment is activated, run: python3 build.py

This builds the TermGPT package within the virtual environment.

Running TermGPT

After successfully building the package, you can run TermGPT by simply typing the following command in your terminal:

termgpt -h

Disclaimer

Before using the tool, it is necessary to generate an API key from OpenAI and insert it using the command:

termgpt setkey <YOUR_KEY>

The standard configuration can be found at the path:
/your/home/.config/termgpt/config.yaml
and has the following structure:

configuration_path: string
termGPT:
  api_key: string
  delay: float
  model: string
  role: string
  token_used: int

Additional Information

Ensure you have the necessary permissions to execute the build script.
If you encounter any issues, please check the Issues section or open a new issue.

Built With

Code of Conduct

We value the participation of every member of our community and aim to create an open and welcoming environment. We are committed to fostering a positive culture, free from harassment and discrimination. Please follow our Code of Conduct when interacting within this project. Adhering to these guidelines helps ensure a productive, harmonious environment for all contributors.

License

Mit. License