Getting Started

Getting Started

System Requirements

Component	Requirement
OS	macOS 13+ / Ubuntu 22.04+ / Windows 11+
Python	3.10+
Node.js	20+ (for GUI)
Memory	8GB+ RAM
Disk	2GB free space

---

Installation

Option 1: pip (Recommended)

pip install maref

Option 2: Docker

docker pull ghcr.io/maref-org/maref:latest

Option 3: From Source

git clone https://github.com/maref-org/maref.git
cd maref
pip install -e ".[dev]"

---

Quick Start

1. Desktop Agent Demo (Dry-Run Mode)

maref desktop demo

Runs a safe demonstration of the desktop Agent操控 loop (screenshot → parse → keystroke/mouse → verify).

2. Environment Diagnosis

python scripts/check_desktop_env.py

Runs 15 environment checks to verify your setup is ready for desktop Agent操控.

3. Query Governance Status

maref status

Shows current governance state machine status and trust scores.

4. Start Sidecar Service

maref serve --port 8000 --gui

Launches the MCP sidecar service with GUI dashboard.

---

Python API Usage

from maref_lite.governance import GovernanceOverlay
from maref_lite.state_machine import GovernanceState

overlay = GovernanceOverlay()
overlay._state_machine.transition(GovernanceState.OBSERVE)
overlay._state_machine.transition(GovernanceState.ANALYZE)
print(overlay.get_status())

---

Next Steps

• Read Architecture to understand the governance model
• Check API Reference for integration details
• Follow Deployment Guide for production setup

---

← Back to Home