Skip to main content

​
Install

pip install moorcheh-edge

​
Command groups

GroupCommandsPurpose
Runtimeup, down, statusDocker container lifecycle
Uploadupload-documents, upload-vectorsText (BGE) or precomputed vectors
SearchsearchText or vector query
AnsweranswerRAG with local LLM (qwen2.5:0.5b-instruct)
Voicevoice setup, voice ask, voice serve, …STT/TTS and kiosk voice on Linux edge hardware
Deletedelete, clear-storeRemove items or wipe the store

​
Typical workflow (text store)

moorcheh-edge up
moorcheh-edge status
moorcheh-edge upload-documents --documents-file documents.json
moorcheh-edge search --query-text "Hello world" --top-k 5
moorcheh-edge answer --query "Who won the football match?" --top-k 5
moorcheh-edge delete --ids-json '["doc-1"]'
moorcheh-edge clear-store
moorcheh-edge down

​
Output

API commands print JSON to stdout. Errors print JSON (when available) and exit with code 1.

​
Data directory

moorcheh-edge up stores data at ~/.moorcheh-edge/data. moorcheh-edge down stops the container but does not delete your data.

​
Shared flag: --base-url

--base-url http://localhost:8080
Use when the server runs on a non-default port: 
moorcheh-edge up --server-port 8083
moorcheh-edge status --base-url http://localhost:8083

​
Help

moorcheh-edge --help
moorcheh-edge up --help
moorcheh-edge search --help
moorcheh-edge answer --help
moorcheh-edge voice --help

​
Voice (Linux edge hardware)

On-device speech commands (voice setup, voice listen, voice serve, …) require Linux with ALSA. See Voice CLI overview.