Skip to content

Get started

Get started with OrkMind

Install typed memory and check storage and retrieval.

Installation and requirements

OrkMind is open source under the MIT license. The reviewed sources describe version 0.4.0, alpha. Use Python 3.11 or later and PostgreSQL with pgvector for the default backend. Set ORKMIND_DATABASE_URL in the protected environment; do not publish its value.

pip install "orkmind>=0.4.0"
orkmind store info
orkmind stats

Store and query an entry

Choose a collection by content purpose and tags by retrieval context. This example stores a neutral instruction; protected or mandatory rules require appropriate identity and authorization. Confirm the backend response before claiming persistence.

orkmind add --collection instruction --content "Run the project checks before delivery" --tags '{"skill":["testing"]}'
orkmind search --tags '{"skill":["testing"]}'

Retrieval is not injection

The CLI and MCP return memory on demand; they do not build the model prompt. Prompt-building plugins for Hermes and OpenClaw perform per-turn injection. Enabling an MCP server alone does not guarantee that an agent queries it before every action.