vontainment / v-openai-cmd-execute

FastAPI for OpenAI Custom GPTs to run commands on a server.

V-OpenAI-Cmd-Execute

This repository contains a Python application built using FastAPI that allows you to execute server commands through an API. It's designed to provide a simple and efficient way to run commands on a server.

Usage

Installation

1. Clone the repository:

   git clone https://github.com/YourUsername/v-openai-cmd-execute.git

2. Navigate to the project directory:

   cd v-openai-cmd-execute

3. Create a virtual environment (optional but recommended):

   python -m venv venv

4. Activate the virtual environment:

   • On Windows:

     venv\Scripts\activate

   • On macOS and Linux:

     source venv/bin/activate

5. Install the dependencies:

   pip install -r requirements.txt

Running the Application

• To start the FastAPI application, run the following command:

  uvicorn main:app --host 0.0.0.0 --port 3000 --reload

This will start the server on http://0.0.0.0:3000. You can change the host and port as needed.

API Endpoint

You can execute commands by sending a POST request to the /execute/ endpoint with a JSON payload containing the command you want to run. The API will return the command's output and other relevant information.

• Example JSON request:

  {
    "command": "your_command_here"
  }

• Example response:

  {
    "command": "your_command_here",
    "stdout": "command_output_stdout",
    "stderr": "command_output_stderr",
    "returncode": 0
  }

Custom OpenAPI Documentation

The API also includes custom OpenAPI documentation for easier integration and understanding. You can access the documentation at http://0.0.0.0:3000/docs.

License

This project is licensed under the MIT License - see the LICENSE file for details.