https://github.com/mirchaemanuel/aiterminal
AITerminal is an automation tool for the command line interface (CLI) that interacts with OpenAI's API to execute commands based on a given task.
https://github.com/mirchaemanuel/aiterminal
ai cli gpt gpt-4 gpt-4-api laravel-zero openai openai-api terminal
Last synced: 3 months ago
JSON representation
AITerminal is an automation tool for the command line interface (CLI) that interacts with OpenAI's API to execute commands based on a given task.
- Host: GitHub
- URL: https://github.com/mirchaemanuel/aiterminal
- Owner: mirchaemanuel
- License: mit
- Created: 2023-04-15T07:22:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-28T09:11:30.000Z (about 2 years ago)
- Last Synced: 2024-11-06T10:13:36.036Z (8 months ago)
- Topics: ai, cli, gpt, gpt-4, gpt-4-api, laravel-zero, openai, openai-api, terminal
- Language: PHP
- Homepage: https://github.com/illegalstudio/AITerminal
- Size: 60.5 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AITerminal
AITerminal is an automation tool for the command line interface (CLI) that interacts with OpenAI's API to execute
commands based on a given task.
## Disclaimer
Please note that AITerminal executes commands on the terminal received from OpenAI. We recommend running the program in
a sandbox environment, as no validation of the received commands is performed, which could pose potential security
risks.
**PRIVACY CONCERNS**: all output of the command will be sent to GPT-4.
Occasionally, the program may not exit autonomously, requiring you to terminate the execution manually using
CTRL+C.
## Credits
Thanks to _Vincenzo `vuppi` Petrucci_ for the idea and the original prompt. You can reach him
on https://github.com/illegalvuppi
We're Illegal! https://github.com/illegalstudio
## Usage
### Installing composer dependencies
```
composer install
```
or
```
docker run --rm --interactive --tty --volume $PWD:/app composer install --ignore-platform-reqs
```
### Build
You can build the application
```
php ai-terminal app:build
```
It will create a phar executable archive in `/builds`
### Usage
To use AITerminal, follow these steps:
1. Open your terminal or command prompt.
2. Navigate to the directory containing the AITerminal executable.
3. edit the .env file to include your OpenAI API key.
4. Run the following command: `./ai-terminal execute`
After executing the command, you will be prompted to enter the task to be performed. AITerminal will then interact with
the OpenAI API to execute the task using a series of commands.