Skip to main content

Summary

RequirementRequired?Why
Python 3.10+YesInstalls moorcheh-edge (CLI + SDK)
DockerYesRuns the edge server container via moorcheh-edge up
OllamaFor answer onlyLocal LLM for RAG (qwen2.5:0.5b-instruct)

How install and startup work

pip install moorcheh-edge
moorcheh-edge up
StepWhat it does
pip install moorcheh-edgeInstalls the moorcheh-edge CLI and Python SDK
moorcheh-edge upPulls moorcheh/moorcheh-edge:latest (if needed), starts Docker container, creates ~/.moorcheh-edge/data
You do not need Rust or a local source checkout. The server runs from the published Docker image.

Python

Version: Python 3.10 or newer
python --version
pip install moorcheh-edge

Docker

Verify Docker is running:
docker --version
docker info
On first moorcheh-edge up, Docker pulls moorcheh/moorcheh-edge:latest from Docker Hub and downloads the BGE embedding model (~210 MB, one-time) to ~/.moorcheh-edge/models.

Ollama (answer / RAG)

Required only for moorcheh-edge answer, not for search or upload. On Linux, moorcheh-edge up --with-llm installs Ollama (into ~/.moorcheh-edge/ollama/) and pulls qwen2.5:0.5b-instruct (~400 MB). Use --skip-ollama on up if you only need vector search.

Ports

PortService
8080Default Moorcheh Edge API
11434Ollama (host, when using answer)
If port 8080 is in use:
moorcheh-edge up --server-port 8083
moorcheh-edge status --base-url http://localhost:8083

Next steps