3
3
[ ![ Discord] ( https://img.shields.io/discord/1146782921294884966?style=flat-square )] ( https://discord.com/invite/6M4QwDXn2w )
4
4
5
5
## Getting Started
6
+
6
7
[ Live Demo] ( https://code-graph.falkordb.com/ )
7
8
8
9
## Running locally
9
10
10
11
### Run FalkorDB
12
+
11
13
Free cloud instance: https://app.falkordb.cloud/signup
12
14
13
15
Or by running locally with docker:
16
+
14
17
``` bash
15
18
docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest
16
19
```
17
20
18
21
### Config
22
+
19
23
Create your own ` .env ` file from the ` .env.template ` file
20
24
21
25
Start the server:
@@ -24,16 +28,21 @@ flask --app api/index.py run --debug
24
28
```
25
29
26
30
### Creating a graph
31
+
27
32
Process a local source folder:
33
+
28
34
``` bash
29
35
curl -X POST http://127.0.0.1:5000/analyze_folder -H " Content-Type: application/json" -d ' {"path": "<FULL_PATH_TO_FOLDER>", "ignore": [<OPTIONAL_IGNORE_LIST>]}' -H " Authorization: <.ENV_SECRET_TOKEN>"
30
36
```
31
37
32
38
For example:
39
+
33
40
``` bash
34
41
curl -X POST http://127.0.0.1:5000/analyze_folder -H " Content-Type: application/json" -d ' {"path": "/Users/roilipman/Dev/GraphRAG-SDK", "ignore": ["./.github", "./build"]}' -H " Authorization: OpenSesame"
35
42
```
43
+
36
44
## Working with your graph
45
+
37
46
Once the source code analysis completes your FalkorDB DB will be populated with
38
47
a graph representation of your source code, the graph name should be the same as
39
48
the name of the folder you've requested to analyze, for the example above a graph named:
@@ -43,6 +52,8 @@ At the moment only the Python and C languages are supported, we do intend to sup
43
52
44
53
At this point you can explore and query your source code using various tools
45
54
Here are several options:
46
- 1 . FalkorDB built-in UI
55
+
56
+ 1 . [ Code-Graph UI] ( https://github.com/FalkorDB/code-graph )
57
+ 1 . FalkorDB [ Browser] ( https://github.com/FalkorDB/falkordb-browser/ )
47
58
2 . One of FalkorDB's [ clients] ( https://docs.falkordb.com/clients.html )
48
59
3 . Use FalkorDB [ GraphRAG-SDK] ( https://github.com/FalkorDB/GraphRAG-SDK ) to connect an LLM for natural language exploration.
0 commit comments