Skip to content

Commit f52ae8d

Browse files
sankalp771sankalp771
authored
Update installation.md
1 parent c5a5e5a commit f52ae8d

1 file changed

Lines changed: 67 additions & 51 deletions

File tree

‎docs/docs/installation.md‎

Lines changed: 67 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
# Installation
1+
## 🧩 Installation Guide
22

3-
This page details the installation process for CodeGraphContext.
3+
Welcome to **CodeGraphContext**! This guide provides a clear and seamless path to installing and configuring the tool, from prerequisites to launching your server.
44

5-
## Prerequisites
5+
## ⚙️ Prerequisites
66

7-
Before you begin, ensure you have the following installed:
7+
Ensure the following are installed before you begin:
88

9-
- **Python:** Version 3.8 or higher.
10-
- **AI Agentic Coding Tool:** An MCP-compatible AI assistant (e.g., Gemini, Claude, etc.) if you plan to use the MCP server.
9+
- **Python**: Version 3.8 or higher.
10+
- **AI Agentic Coding Tool**: An MCP-compatible AI assistant (e.g., Gemini, Claude) if you plan to use the MCP server.
1111

12-
## Getting Started
12+
## 🚀 Getting Started
13+
14+
Follow these steps to set up **CodeGraphContext** effortlessly.
1315

1416
### 1. Install from PyPI
1517

@@ -19,77 +21,91 @@ Install the `codegraphcontext` package directly from PyPI using pip:
1921
pip install codegraphcontext
2022
```
2123

22-
### 2. Configure the Server
24+
### 2. Run the Setup Wizard
2325

24-
Run the interactive setup wizard to configure your Neo4j database connection and development environment:
26+
Launch the interactive setup wizard to configure your Neo4j database and development environment:
2527

2628
```bash
2729
cgc setup
2830
```
2931

30-
The setup wizard will guide you through the following options:
32+
The wizard guides you through a series of intuitive prompts to tailor your setup.
3133

32-
!!! details "Step-by-step guide for the setup wizard"
34+
## 🧭 "Step-by-Step Guide for the Setup Wizard"
3335

34-
When you run `cgc setup`, you will be presented with a series of questions. Here’s a guide on how to answer them:
36+
When you run `cgc setup`, the wizard offers a thoughtful journey through configuration. Follow these steps to complete your setup with ease:
3537

36-
**1. Database Location:**
38+
**1. Select Your Database Location**
3739

38-
You will first be asked where you want to set up your Neo4j database.
40+
Choose where your Neo4j database will reside:
3941

40-
* **Local (Recommended):** Choose this if you want to run Neo4j on your own machine. This is the easiest option if you have Docker installed.
41-
* **Docker:** The wizard will automatically create a `docker-compose.yml` file and start a Neo4j container.
42-
* **Local Binary:** For Debian-based systems, the wizard can install Neo4j for you.
43-
* **Hosted:** Choose this if you have a remote Neo4j database like AuraDB. You will be prompted to enter your connection details.
44-
* **I already have an existing neo4j instance running:** Choose this if you already have a Neo4j instance running (local or remote) and you want to provide the credentials manually.
42+
- **Local (Recommended)**: Host Neo4j on your machine for simplicity.
43+
- **Docker**: With Docker installed, the wizard crafts a `docker-compose.yml` file and launches a Neo4j container seamlessly.
44+
- **Local Binary**: On Debian-based systems (e.g., Ubuntu), the wizard installs Neo4j directly with your permission.
45+
- **Hosted**: Connect to a remote Neo4j instance, such as AuraDB, by providing your database URI, username, and password.
46+
- **Existing Instance**: For an existing Neo4j server (local or remote), enter its connection credentials.
4547

46-
*(Image placeholder: Screenshot of the database location prompt)*
4748

48-
**2. IDE/CLI Configuration:**
49+
**2. Configure Your Development Environment**
4950

50-
After setting up the database, the wizard will ask to configure your development environment.
51+
Integrate CodeGraphContext with your preferred development tool for a harmonious workflow. Select from supported options:
5152

52-
* Choose your preferred IDE or CLI from the list. The wizard will automatically update the necessary configuration files.
53+
- VS Code
54+
- Cursor
55+
- Windsurf
56+
- Claude
57+
- Gemini CLI
58+
- ChatGPT Codex
59+
- Cline
60+
- RooCode
61+
- Amazon Q Developer
5362

54-
*(Image placeholder: Screenshot of the IDE/CLI selection prompt)*
63+
The wizard automatically updates configuration files to align with your choice.
5564

56-
**3. Configuration Files:**
5765

58-
Upon successful configuration, the wizard will create:
66+
**3. Generate Configuration Files**
5967

60-
* `mcp.json`: In your current directory, for the MCP server configuration.
61-
* `.env`: In `~/.codegraphcontext`, to store your Neo4j credentials securely.
68+
Upon completing the prompts, the wizard creates two essential files:
6269

63-
#### Database Configuration
70+
- **`mcp.json`**: Placed in your working directory, this file configures the MCP server.
71+
- **`.env`**: Stored securely in `~/.codegraphcontext`, this file safeguards your Neo4j credentials.
6472

65-
You can choose from three database setups:
73+
These files ensure smooth communication between CodeGraphContext, your Neo4j instance, and your AI assistant.
6674

67-
- **Local Setup (Docker Recommended):** The wizard can automatically set up a local Neo4j instance using Docker. This is the easiest way to get started if you have Docker and Docker Compose installed.
68-
- **Local Setup (Linux Binary):** For Debian-based systems like Ubuntu, the wizard can automate the installation of Neo4j directly on your machine. This requires `sudo` privileges.
69-
- **Hosted Setup:** If you have an existing remote Neo4j database (like Neo4j AuraDB), you can provide your credentials to connect to it.
75+
### 3. Start the Server
7076

71-
#### IDE/CLI Configuration
77+
Once configuration is complete, launch the MCP server with:
7278

73-
After setting up the database, the wizard can automatically configure your preferred development tool to work with CodeGraphContext. Supported tools include:
79+
```bash
80+
cgc start
81+
```
7482

75-
- VS Code
76-
- Cursor
77-
- Windsurf
78-
- Claude
79-
- Gemini CLI
80-
- ChatGPT Codex
81-
- Cline
82-
- RooCode
83-
- Amazon Q Developer
83+
Your **CodeGraphContext** server is now active, ready to power AI-assisted graph queries.
8484

85-
Upon successful configuration, the wizard will create the necessary files, including `mcp.json` for server configuration and a `.env` file for your credentials in `~/.codegraphcontext`.
85+
## 🧱 Database Setup Options
8686

87-
### 3. Start the Server
87+
Choose from three flexible database configurations:
8888

89-
Once the setup is complete, you can start the CodeGraphContext MCP server:
89+
| **Setup Type** | **Description** | **Requirements** |
90+
|---------------------------|------------------------------------------------------|-------------------------------|
91+
| **Local (Docker)** | Automatically sets up a Neo4j container. | Docker & Docker Compose |
92+
| **Local (Linux Binary)** | Installs Neo4j directly on Debian-based systems. | sudo privileges |
93+
| **Hosted** | Connects to a remote Neo4j instance (e.g., AuraDB). | Connection credentials |
9094

91-
```bash
92-
cgc start
93-
```
95+
## 💻 IDE/CLI Configuration Summary
96+
97+
The setup wizard streamlines integration with your preferred development tool, automatically generating configuration files for seamless interaction with the MCP server and database. Supported tools include:
98+
99+
- VS Code
100+
- Cursor
101+
- Windsurf
102+
- Claude
103+
- Gemini CLI
104+
- ChatGPT Codex
105+
- Cline
106+
- RooCode
107+
- Amazon Q Developer
108+
109+
## Next Steps
94110

95-
The server will now be running and ready to accept requests from your AI assistant.
111+
With **CodeGraphContext** installed and configured, you’re ready to explore its AI-powered capabilities. Happy coding ✨!

0 commit comments

Comments
 (0)