> ## 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.

# Getting started

> End-to-end Python workflow with Moorcheh Edge.

## Prerequisites

```bash theme={null}
pip install moorcheh-edge
moorcheh-edge up
```

## Text store example

```python theme={null}
from moorcheh_edge import MoorchehEdge, MoorchehEdgeApiError

with MoorchehEdge(port=8080, skip_pull=False) as edge:
    health = edge.health()
    print(f"Items: {health['items']} / {health['max_items']}")

    edge.upload_documents([
        {"id": "doc-1", "text": "Hello world"},
        {"id": "doc-2", "text": "Vector search on device"},
    ])

    for hit in edge.search_text("Hello world", top_k=3):
        print(hit["id"], hit["score"], hit.get("text"))

    edge.delete(["doc-1"])
    edge.clear_store()
```

## Vector store example

```python theme={null}
import random
from moorcheh_edge import MoorchehEdge

def rand_vec(dim: int = 1024) -> list[float]:
    return [random.random() for _ in range(dim)]

with MoorchehEdge(port=8080) as edge:
    edge.clear_store()
    edge.upload_vectors([
        {"id": "item-1", "vector": rand_vec(), "text": "Optional label"},
    ])
    results = edge.search(rand_vec(), top_k=3)
    for r in results:
        print(r["id"], r["score"], r["label"])
```

## Attach to an existing server

```python theme={null}
from moorcheh_edge import MoorchehEdgeApiClient

client = MoorchehEdgeApiClient("http://localhost:8083")
print(client.health())
```

## CLI equivalent

```bash theme={null}
moorcheh-edge status
moorcheh-edge upload-documents --documents-file documents.json
moorcheh-edge search --query-text "Hello world" --top-k 5
moorcheh-edge delete --ids-json '["doc-1"]'
moorcheh-edge clear-store
```

## Tips

<Warning>
  * One flat store per container - text or vector mode, not both
  * Text store dimension is **768** (BGE); vector store allows **128–1536**
  * Store cap is **10,000** items - handle `MoorchehEdgeApiError` with status **409**
</Warning>

## Next steps

* [health()](/python-client/health)
* [export\_store()](/python-client/export)
* [upload](/python-client/upload)
* [search()](/python-client/search)
* [delete()](/python-client/delete)
* [clear\_store()](/python-client/clear-store)