Skip to main content

​
Install

pip install moorcheh-client
The moorcheh command is installed with the package.

​
Command groups

GroupCommandsPurpose
Runtimeconfigure, up, down, statusEmbedding setup and Docker containers
Namespacesnamespace-create, namespace-list, namespace-delete, namespace-delete-job-statusNamespace lifecycle
Dataupload-documents, upload-vectors, upload-job-statusIngest JSON documents/vectors
Filesupload-file, list-files, file-get, delete-file, file-job-statusUpload from ~/.moorcheh/uploads
Itemsitems-get, items-deleteRead or remove items by id
SearchsearchSemantic search
AIanswerRAG / direct LLM

​
Typical workflow

moorcheh configure   # optional; first moorcheh up can prompt
moorcheh up
moorcheh status
moorcheh namespace-create --name docs --type text
moorcheh upload-documents --namespace-name docs --documents-file docs.json
moorcheh upload-job-status --namespace-name docs --job-id <job_id>
moorcheh search --query "your question" --namespaces docs --top-k 5
moorcheh down

​
Output

API commands print JSON to stdout. status also prints a one-line quota summary before the JSON. Errors print to stderr and exit with code 1.

​
Data directory

moorcheh up stores index data at ~/.moorcheh/data and mounts ~/.moorcheh/uploads as /uploads in the server. moorcheh down stops containers but does not delete your data or uploaded files.

​
Shared flag: --base-url

Most API commands accept: 
--base-url http://localhost:8080
Use a different port if you started the server with moorcheh up --server-port 8081.

​
Help

moorcheh --help
moorcheh up --help
moorcheh search --help