https://github.com/lemurpwned/cypher-shell

A cypher shell for running Cypher queries using natural language
https://github.com/lemurpwned/cypher-shell

cypher llm llm-shell neo4j

Last synced: 3 days ago
JSON representation

A cypher shell for running Cypher queries using natural language

• Host: GitHub
• URL: https://github.com/lemurpwned/cypher-shell
• Owner: LemurPwned
• Created: 2024-10-20T14:43:26.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T07:32:36.000Z (2 months ago)
• Last Synced: 2024-10-24T22:29:24.324Z (about 2 months ago)
• Topics: cypher, llm, llm-shell, neo4j
• Language: Python
• Homepage:
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cypher Shell

A shell for querying Neo4j with Cypher using LLMs.

## Installation

```bash

pip install cypher-shell

```

## How to use

```bash

python -m cypher_shell --help

```

or

```bash

python -m cypher_shell --config 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.