PeacockGPT

PeacockGPT is an AI-powered assistant designed to help new and temporary employees navigate our company’s internal systems with ease. Leveraging advanced GPT technology, PeacockGPT provides quick answers, step-by-step guidance, and contextual support to ensure you can complete your daily tasks confidently and efficiently.

Screenshot

---

Table of Contents

• Introduction
• Key Features
• Installation
• Getting Started: How to Use PeacockGPT
• Everyday Use Cases
• FAQ
• Contributing
• License
• Support

---

Introduction

Navigating new systems and processes can be challenging, especially when you’re just getting started. PeacockGPT is here to help! It acts as your personal guide, answering your questions about logging in, accessing applications, troubleshooting common issues, and understanding internal procedures—all in real time.

Whether you’re trying to locate documentation, learn how to use a particular system, or need a refresher on company policies, PeacockGPT provides on-demand assistance to make your onboarding and daily tasks smoother.

---

Key Features

• Instant Answers: Quickly get responses to your queries about company systems and procedures.
• Step-by-Step Guidance: Detailed instructions and walkthroughs for common tasks.
• User-Friendly Interface: Interact via an intuitive chat interface or command line.
• Regularly Updated: Always reflects the latest company procedures, policies, and system updates.
• Contextual Help: Provides answers tailored to your role and current task.

---

Installation

Prerequisites

• Python 3.8+: Ensure Python is installed on your system.
• (Optional) Node.js: Required if you prefer using the web-based interface.
• API Key for GPT Services: If your installation requires a GPT API key, please have it ready.

Setup Steps

1. Clone the Repository:

   git clone https://github.com/ottojonas/peacockgpt.git
   cd peacockgpt

2. Create and Activate a Virtual Environment:

   python -m venv env
   source env/bin/activate  # On Windows: env\Scripts\activate

3. Install Python Dependencies:

   pip install -r requirements.txt

4. Configure Environment Variables:

   Create a .env file in the root directory and add any necessary configurations. For example:

   GPT_API_KEY=your_api_key_here
   COMPANY_SYSTEM_URL=https://internal.company.system

5. Run the Application:

   • For the CLI Version:

     python main.py

   • For the Web Interface (if available):

     npm install
     npm start

---

Getting Started: How to Use PeacockGPT

PeacockGPT can be accessed in several ways depending on your needs:

1. Chat Interface

• What it is: A user-friendly chat window where you can type natural language questions.
• How to use it: Simply type your query (e.g., “How do I access the HR portal?”) and receive an immediate, detailed response.

2. Command Line Interface (CLI)

• What it is: A quick and efficient method for users comfortable with the terminal.

• How to use it: Run commands such as:

  python main.py --query "How do I submit an expense report?"

3. Integrated Company Dashboard

• What it is: PeacockGPT may be integrated within our company’s internal dashboard to offer in-context assistance.
• How to use it: Look for the PeacockGPT icon or widget on your dashboard and click to start a conversation.

---

Everyday Use Cases

PeacockGPT is designed to support you throughout your workday. Here are a few common scenarios:

• Onboarding and System Access: Example: “How do I log into the internal email system?” Response: Provides a step-by-step guide, including troubleshooting tips if you experience issues.

• Troubleshooting: Example: “I can’t access the timekeeping system—what should I do?” Response: Offers diagnostic steps, common issues, and instructions for contacting IT support if necessary.

• Learning Procedures: Example: “What is the process for submitting a project report?” Response: Details the required steps, links to official documentation, and tips for efficiency.

• Finding Documentation: Example: “Where can I find the user manual for the new CRM?” Response: Supplies a direct link and a summary of the contents.

---

FAQ

Q: Do I need technical expertise to use PeacockGPT? A: No, PeacockGPT is built for users of all technical backgrounds.

Q: How often is the information updated? A: The system is maintained regularly to reflect the latest updates in company procedures and policies.

Q: What if my question isn’t answered? A: If you encounter an unanswered query, refer to the official documentation or contact IT support directly.

---

Contributing

We welcome contributions to improve PeacockGPT! To contribute:

1. Fork the Repository: Click the “Fork” button on GitHub to create your own copy.

2. Create a New Branch: Use a descriptive name for your feature or bug fix.

3. Commit and Push Your Changes: Ensure your code follows our style guidelines.

4. Submit a Pull Request: Provide a detailed description of your changes for review.

---

License

This project is licensed under the MIT License.

---

Support

If you have any questions, issues, or need further assistance, please contact our support team at ottobjonas@outlook.com.

---

Happy exploring and welcome to the team!

This README provides an overview of PeacockGPT, detailed installation instructions, and practical examples of how to use the tool in your daily work. It’s designed to be a helpful resource for anyone new to our systems.