Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.moorcheh.ai/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Starts the Moorcheh API in Docker and wires it to Ollama for embeddings. Data is stored under ~/.moorcheh/data. Unlike API commands, moorcheh up prints human-readable status lines (not JSON). Docker compose logs may appear on stdout/stderr.

Synopsis

moorcheh up [options]

Options

FlagDefaultDescription
--server-imagemoorcheh/server:latestDocker image for the API server
--server-port8080Host port for http://localhost:<port>
--ollama-imageollama/ollama:latestImage when starting bundled Ollama
--ollama-port11434Host port to probe for existing Ollama, or publish bundled Ollama
--ollama-host127.0.0.1Host to probe for existing Ollama
--ollama-modelnomic-embed-textEmbedding model passed to the server
--bundled-ollamaoffAlways start moorcheh-ollama container
--use-host-ollamaoffNever start moorcheh-ollama; use host Ollama only
You cannot use --bundled-ollama and --use-host-ollama together (exit code 1).

Default Ollama behavior

If Ollama is already reachable on http://127.0.0.1:11434, moorcheh up reuses it and starts only the Moorcheh server container. If not reachable, it starts both the server and moorcheh-ollama (bundled Ollama).

Examples

# Auto-detect Ollama (default)
moorcheh up

# Different API port
moorcheh up --server-port 8081

# Force Docker Ollama
moorcheh up --bundled-ollama

# Force host Ollama only (fail if host Ollama is not running)
moorcheh up --use-host-ollama

# Bundled Ollama on another host port
moorcheh up --bundled-ollama --ollama-port 11435

Output

Always prints these lines on success:
Data directory: <path to ~/.moorcheh/data>
<ollama mode line>
Moorcheh API: http://localhost:<server-port>
Host Ollama (auto or --use-host-ollama):
Using Ollama already running at http://127.0.0.1:11434 (moorcheh-ollama container not started)
Bundled Ollama:
Started Moorcheh server + Ollama container (Ollama on host port 11434)
Docker compose progress (for example Container moorcheh-onprem-server Started) may print to stdout/stderr before the lines above.

Exit codes

CodeMeaning
0Stack started (or already running)
1Conflicting flags, Docker error, or compose failure

Requirements

  • Docker running
  • Pull access for moorcheh/server:latest (and ollama/ollama:latest if bundled Ollama starts)