Mewtwo is a lightweight AI assistant designed to help server administrators manage their systems efficiently. It leverages OpenAI's API to provide intelligent responses and actionable insights based on server-specific documentation.

• Introduction
• Features
• Installation
  • Prerequisites
  • Installation Steps
• Usage
• Documentation Overview
• Setup Script
  • Usage
  • Commands
  • How It Works
  • Help Command
• Contributing
• License

Mewtwo is an AI assistant tailored for server administrators. It reads and interprets documentation stored on your server to provide detailed responses and instructions based on the specific setup. Whether you're setting up a PostgreSQL database, configuring an NGINX server, or managing cron jobs, Mewtwo can assist you by accessing and understanding the documentation you've provided.

• Documentation-Aware: Mewtwo can access and understand server-specific documentation to answer questions accurately.
• Command Execution: Mewtwo can run server commands directly, allowing for seamless automation of tasks.
• Customizable: Easily extend Mewtwo's capabilities by adding more documentation or tools.

• Ubuntu or Windows Subsystem for Linux (WSL)
• Python 3.x
• OpenAI API Key and Organization ID

1. Download the .deb package via Github or using wget:

   wget https://github.com/alshival/Mewtwo/raw/main/mewtwo-1.1.1-all.deb

2. Install the package using:

   sudo dpkg -i mewtwo-1.1.1-all.deb

3. Configure your OpenAI API credentials. For personal credentials (stored in ~/.mewtwo.db), run

   mewtwo-setup 

   If you would like to set up credentials for the team instead (stored in /usr/share/mewtwo/mewtwo.db), use:

   mewtwo-setup --team

   Team credentials are used by all users who have not defined personal credentials.

4. Point Mewtwo to your documentation folder. By default, Mewtwo's algorithm searches through documentation located in /usr/share/mewtwo/Documentation. But documentation within this directory may not persist when updating Mewtwo. Therefore, it is best to keep your server documentation in another directory that your team has permission to read from, such as /Documentation/. You can set the directory Mewtwo's search algorithm uses by running

   mewtwo-setup doc-directory

   After you have set the directory, run mewtwo-setup rag to update the search algorithm. Note that you should run mewtwo-setup rag after updating any documentation contained within the folder. We may include a service that monitors for changes within the documentation directory sometime in the future.

Once installed, you can start using Mewtwo by running:

mewtwo How do I set up a new PostgreSQL user?

Mewtwo will read the relevant documentation and provide step-by-step instructions. Note that some characters require escape. Terminals require single quotes be closed, so an apostrophe must be escaped: \'. The pipe operator,\| is another example. As is \<, and a few others. You can avoid worrying about escape characters by wrapping your prompt around double quotes.

mewtwo I\'m so happy \<3
mewtwo "I'm so happy <3"

If you run into errors, try wiping Mewtwo's memory: mewtwo-setup wipe-memory.

Mewtwo can run commands for you as well. You can ask it which files are older than one week but not older than two weeks and it will run

find . -maxdepth 1 -type f -mtime +7 -mtime -14

Mewtwo can also run sudo commands like sudo apt update & sudo apt upgrade. You can provide your sudo password during setup to grant Mewtwo the ability to bypass the sudo password request. sudo passwords are always stored in your personal database ~/.mewtwo.db since they are user-specific.

By default, Mewtwo's algorithm searches through documentation stored in the /usr/share/mewtwo/Documentation/ directory. You can change this using mewtwo-setup doc-directory. When updating documentation, it is important to run mewtwo-setup rag to update the search algorithm. You could use github to track your documentation and point mew to it, for example. Sample documentation is provided in the default directory. You can delete the files or change the documentation directory and they will be removed from the vector database used for retrieval-augmented generation.

Mewtwo includes a setup script, mewtwo-setup, that allows you to configure OpenAI API credentials, customize the text color for Mewtwo's responses, set the documentation directory, and update the sudo password used by Mewtwo. The script can be run for the local user or globally for the team.

To start the setup script, use the following commands:

• User-Level Setup: Configures Mewtwo for the current user only. The configuration is stored in the ~/.mewtwo.db database within the user's home directory.

  mewtwo-setup --user

• Team-Level Setup: Configures Mewtwo for all users on the server. The configuration is stored in the /usr/share/mewtwo/mewtwo.db database. Running this setup requires elevated privileges.

  sudo mewtwo-setup --team

You can also use specific commands with mewtwo-setup to manually set or repair your configuration:

• Set Documentation Directory: Set the directory containing your server's documentation.

  • For the current user:

    mewtwo-setup --user doc-directory

  • For the team:

    sudo mewtwo-setup --team doc-directory

• Set OpenAI API Credentials: Set the OpenAI API key and Organization ID.

  • For the current user:

    mewtwo-setup --user openai-api

  • For the team:

    sudo mewtwo-setup --team openai-api

• Set Text Color: Choose and set the text color for Mewtwo's responses.

  • For the current user:

    mewtwo-setup --user text-color

  • For the team:

    sudo mewtwo-setup --team text-color

• Update Sudo Password: Update the sudo password used by Mewtwo.

  • For the current user:

    mewtwo-setup --user sudo

• Update Documentation Search Algorithm (RAG): After updating documentation, run this command to update Mewtwo's vector database for searching through documentation (requires sudo)

  • For the team:

    sudo mewtwo-setup --team rag

• Wipe Memory: Clear Mewtwo's chat history.

  • For the current user:

    mewtwo-setup --user wipe-memory

Chat history is stored within a user's database. No chats are stored within the team database.

• Credential Lookup: Mewtwo first checks if credentials are defined within the user's database (~/.mewtwo.db). If not, it will search for them in the team database (/usr/share/mewtwo/mewtwo.db). You can safely delete any of these databases to set up Mewtwo from scratch.

• Text Color Customization: You can define a text color at both the user and team levels, which will change the color of Mewtwo's responses in the terminal. Similar to the Credential Lookup, it prioritizes any user-defined configuration before a team configuration.

• Documentation Directory: You can specify a custom directory for your server's documentation. By default, Mewtwo will look in /usr/share/mewtwo/Documentation, but you can change this with the doc-directory command.

• Sudo Password: Mewtwo can use a sudo password for executing privileged commands. This should be defined at the user level since every user's sudo password will vary.

• Updating Documentation Search Algorithm: After making changes to your documentation, run mewtwo-setup rag to update Mewtwo's search algorithm and ensure that the assistant can access the latest information.

For more information on the available options and commands, run:

mewtwo-setup --help

This will display detailed usage instructions and a list of commands.

Add support for multiple documentation folders.

Contributions are welcome! Feel free to submit issues or pull requests. Please make sure to follow the contribution guidelines.

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