diff --git a/apps/codexgraph_agent/README.md b/apps/codexgraph_agent/README.md index 4189e671..84004a8e 100644 --- a/apps/codexgraph_agent/README.md +++ b/apps/codexgraph_agent/README.md @@ -7,24 +7,37 @@ **CodexGraph Agent** is an advanced multi-tasking agent that integrates a language model (LM) agent with a code graph database interface. By utilizing the structural characteristics of graph databases and the versatility of the Cypher query language, CodexGraph enables the LM agent to formulate and execute multi-step queries. This capability allows for precise context retrieval and code navigation that is aware of the code's structure. ## 🚀 How to Use -### 1️⃣ Set Up the Python Environment + +### 1️⃣ Set Up Environment +- Install Neo4j Desktop: + - Download and install [Neo4j Desktop](https://neo4j.com/download/) + - Set the password for the default user `neo4j` + - Create a new project and install a new database with database name `codexgraph` + - Get bolt port as url from the database settings, typically it is `bolt://localhost:7687` + + - Install dependencies: ```bash pip install -r requirements.txt ``` - Build the graph database environment: -Create a separate `Python 3.7` environment and install the required dependencies: +Create a separate `Python<=3.9` environment and install the required dependencies: ```bash pip install -r build_requirements.txt ``` -## 2️⃣ Locate the Graph Database Environment -- Find the Python path: +This separate environment is used to index the project and save to graph database with certain python version for some package. +### 2️⃣ Locate the Graph Database Environment +- Find the Python path on Mac/Linux: +```bash +which python +``` +or on Windows: ```bash where python ``` -## 3️⃣ Run CodexGraph Agent +### 3️⃣ Run CodexGraph Agent - Navigate to the modelscope-agent directory: ```bash cd modelscope-agent