Explainit Crew

Welcome to the Explainit Crew project, powered by crewAI. A basic CrewAI app that tries to explain given topics in simple terms.

Installation

Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses UV for dependency management and package handling, offering a seamless setup and execution experience.

ExplainIt uses Llama3.2, you can find the installation instructions here. Feel free to explore other LLMs based on the CrewAI documentation and speed up the inference.

First, if you haven't already, install uv:

pip install uv

Next, navigate to your project directory and install the dependencies:

(Optional) Lock the dependencies and install them by using the CLI command:

crewai install

Customizing

Add your Llama details into the .env file

• Modify src/explainit/config/agents.yaml to define your agents
• Modify src/explainit/config/tasks.yaml to define your tasks
• Modify src/explainit/crew.py to add your own logic, tools and specific args
• Modify src/explainit/main.py to add custom inputs for your agents and tasks

Running the Project

To kickstart your crew of AI agents and begin task execution, run this from the root folder of your project:

$ crewai run

This command initializes the explainIt Crew, assembling the agents and assigning them tasks as defined in your configuration.

This example, unmodified, will run the create a report.md file with the output of a research on LLMs in the root folder.

Streamlit App

Instead of dealing with the CLI, if you want to interact with the app via browser, then, go to src/explainit/main.py:

1. comment the existing code block
2. install "streamlit" using: uv pip install streamlit
3. enable the code block containing streamlit block
4. run streamlit run main.py
5. access the app at: http://localhost:8501

Result