Skip to content

🚀 Installation & Usage ​

The Master Orchestration Protocol is engineered for easy bootstrapping alongside maximum production durability. Follow these steps to spin up the system locally.

1. Prerequisites ​

Ensure you have the following system utilities installed:

  • Python: Version 3.11 or higher.
  • uv: A lightning-fast Python package manager. Install it via:
    bash
    curl -LsSf https://astral.sh/uv/install.sh | sh
  • Node.js & npm: Required to run the VitePress documentation server.

2. Installation & Virtual Environment Setup ​

Clone the repository and sync the Python virtual environment:

bash
# Sync dependencies via the uv package manager
uv sync

# Activate the virtual environment
source .venv/bin/activate

3. API Key Management ​

IMPORTANT

MOP strictly respects the API VERIFICATION rule. Before the orchestrator fires any external LLM calls, the developer must verify that API keys are properly configured.

Create a .env file in the project root:

env
GEMINI_API_KEY=your_gemini_api_key
SQLITE_DB_PATH=data/memory.db
LOG_LEVEL=INFO

4. Running the Test Suite ​

Before deployment, verify the system integrity by running the 8 core automated tests:

bash
uv run pytest -v

All tests should return a PASSED status.


5. Running the VitePress Site ​

To boot this premium documentation site locally on your developer workstation:

bash
# Navigate to the docs-site directory
cd docs-site

# Run the local development server
npm run dev

The site will be hosted at http://localhost:5173. To build the static assets for production:

bash
npm run build

Izgrađeno sa Antigravity & DocKit Premium