QA Agent 🤖

Internal command-line tool (CLI) to help the QA team manage their work, especially during the transition to test automation.

Developed at Runtime Revolution.

---

Requirements

• Python 3.x
• pip

---

Installation

1. Clone or copy the project to your machine

2. Navigate to the project folder:

cd qa-agent

3. Create and activate the virtual environment:

python3 -m venv venv
source venv/bin/activate

4. Install dependencies:

pip install click

---

Available Commands

📋 List all test cases

python agent/cli.py list-tests

🔍 View details of a specific test case

python agent/cli.py show TC-001

✏️ Update the state of a test case

python agent/cli.py update-state TC-001 Passed

Available states: Active Passed Failed Blocked In Progress

➕ Add a new test case

python agent/cli.py add-test

🗺️ View the team roadmap

python agent/cli.py roadmap

📜 View the change history in the terminal

python agent/cli.py history

📤 Export change history to Markdown

python agent/cli.py export-history

Generates file: knowledge_base/history.md

📤

📁 qa-agent/ ├── 📁 agent/ │ └── 📄 cli.py ← CLI source code ├── 📁 knowledge_base/ │ ├── 📁 test_cases/ │ │ └── 📄 test_cases.json ← test cases database │ ├── 📁 roadmap/ │ │ └── 📄 roadmap.md ← team roadmap │ ├── 📁 guidelines/ │ │ └── 📄 guidelines.md ← QA best practices │ ├── 📄 history.json ← history in JSON (internal use) │ ├── 📄 history.md ← exported change history │ └── 📄 test_cases_history.md ← exported test cases history └── 📁 venv/ ← virtual environment (do not share)

---

Important Notes

• Always activate the virtual environment before using the tool: source venv/bin/activate
• Never delete a test case — change the state to Blocked if no longer applicable
• Update roadmap.md whenever a step is completed
• The venv/ folder should not be shared or pushed to Git

Changelog

• 2026-06-30 — Initial project setup

Requirements

Already listed above, but for AI integration add:

• Ollama installed and running
• Llama 3.2 model pulled locally

AI Integration Setup

1. Install Ollama:

curl -fsSL https://ollama.com/install.sh | sh

2. Start the Ollama server:

ollama serve

3. Pull the Llama 3.2 model:

ollama pull llama3.2

4. Install the Python Ollama library:

pip install ollama

Note: The ollama serve terminal must remain active while using the ask command.

AI Command

🤖 Ask the AI agent a question

python agent/cli.py ask "Your question here"

The agent reads the entire Knowledge Base (test cases, roadmap, guidelines) before answering, ensuring responses are always contextualised to your project.

Examples:

python agent/cli.py ask "What should I test next?"
python agent/cli.py ask "What test cases do we have for the Login module?"
python agent/cli.py ask "What are the team guidelines for automation?"

Interactive Menu

Instead of typing commands manually, you can use the interactive menu:

python agent/menu.py

Navigate with the arrow keys and press Enter to select an option. Available options:

• 📋 View Test Cases — lists all test cases
• ➕ Create Test Case — adds a new test case interactively
• 🗺️ View Roadmap — shows the team roadmap
• 📜 View History — shows the change history
• 📤 Export History — exports change history to Markdown
• 📤 Export Test Cases History — exports test cases history to Markdown
• 🤖 Ask AI — asks a question to the AI agent
• ❌ Exit — exits the menu