Skip to content

Commit 3ec749d

Browse files
committed
Add GitHub installation instructions to README
1 parent 9a7f523 commit 3ec749d

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ This MCP allows AI Agents like Cursor's Composer Agent to automatically read and
1313

1414
## Installation
1515

16+
### From NPM (Recommended)
17+
1618
```bash
1719
# Install the package globally
1820
npm install -g codebase-mcp
@@ -21,6 +23,28 @@ npm install -g codebase-mcp
2123
codebase-mcp install
2224
```
2325

26+
### From GitHub
27+
28+
```bash
29+
# Clone the repository
30+
git clone https://github.com/DeDeveloper23/codebase-mcp.git
31+
32+
# Navigate to the project directory
33+
cd codebase-mcp
34+
35+
# Install dependencies
36+
npm install
37+
38+
# Build the project
39+
npm run build
40+
41+
# Install globally
42+
npm install -g .
43+
44+
# Install RepoMix (required dependency)
45+
codebase-mcp install
46+
```
47+
2448
## Integration with Cursor
2549

2650
To use this MCP with Cursor's Composer Agent:

0 commit comments

Comments
 (0)