Cypher Shell

A shell for querying Neo4j with Cypher using LLMs.

Installation

pip install cypher-shell

How to use

python -m cypher_shell --help

or

python -m cypher_shell --cfg-path configs/movies.yaml

where configs/movies.yaml is a configuration file that contains the node and relationship descriptions.

If no configuration file is provided, the tool will try to generate a schema automatically. This might give worse results.

You need to set the .env file with your OpenAI API key and Neo4j credentials. See .env_template for more information.

Docker

You can also run the tool using Docker.

docker run --env .env -it ghcr.io/lemurpwned/cypher-shell:latest python3 -m cypher_shell --cfg-path configs/movies.yaml

Run query without LLM

Just preface the query with: cs: and the query will not be rewritten by the llm.