Skip to content

Commit d662db3

Browse files
committed
prep to test workflow
1 parent d6e7bb1 commit d662db3

File tree

2 files changed

+30
-11
lines changed

2 files changed

+30
-11
lines changed

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,37 @@ This package is designed for use with the Model Context Protocol (MCP) and other
4141

4242
### From GitHub Packages
4343

44-
```bash
45-
npm install code-search-mcp-universal-ctags
46-
```
44+
This package is published to GitHub Packages and requires authentication to install.
45+
46+
#### Step 1: Create a GitHub Personal Access Token
4747

48-
> Note: This package is distributed via GitHub Packages. You may need to configure npm to use the GitHub Package Registry for the @LLMTooling scope.
48+
1. Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
49+
2. Generate new token with `read:packages` scope
50+
3. Copy the token
4951

50-
### Configuration for GitHub Packages
52+
#### Step 2: Configure npm Authentication
5153

52-
Create or update your `.npmrc` file:
54+
Create or update `.npmrc` in your project root or home directory:
5355

5456
```
5557
@LLMTooling:registry=https://npm.pkg.github.com
58+
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
59+
```
60+
61+
Replace `YOUR_GITHUB_TOKEN` with your personal access token.
62+
63+
#### Step 3: Install the Package
64+
65+
```bash
66+
npm install @LLMTooling/code-search-mcp-universal-ctags
67+
```
68+
69+
**Alternative: Using environment variable**
70+
71+
```bash
72+
echo "@LLMTooling:registry=https://npm.pkg.github.com" > .npmrc
73+
export NODE_AUTH_TOKEN=YOUR_GITHUB_TOKEN
74+
npm install @LLMTooling/code-search-mcp-universal-ctags
5675
```
5776

5877
---
@@ -62,7 +81,7 @@ Create or update your `.npmrc` file:
6281
### Basic Usage
6382

6483
```javascript
65-
const { ctagsPath } = require('code-search-mcp-universal-ctags');
84+
const { ctagsPath } = require('@LLMTooling/code-search-mcp-universal-ctags');
6685

6786
console.log('ctags binary location:', ctagsPath);
6887
// Use ctagsPath with child_process to run ctags commands
@@ -72,7 +91,7 @@ console.log('ctags binary location:', ctagsPath);
7291

7392
```javascript
7493
const { execSync } = require('child_process');
75-
const { ctagsPath } = require('code-search-mcp-universal-ctags');
94+
const { ctagsPath } = require('@LLMTooling/code-search-mcp-universal-ctags');
7695

7796
// Get ctags version
7897
const version = execSync(`"${ctagsPath}" --version`, { encoding: 'utf8' });
@@ -86,7 +105,7 @@ execSync(`"${ctagsPath}" -R --fields=+nKz --extras=+q .`, { cwd: '/path/to/proje
86105

87106
```javascript
88107
const { spawn } = require('child_process');
89-
const { ctagsPath } = require('code-search-mcp-universal-ctags');
108+
const { ctagsPath } = require('@LLMTooling/code-search-mcp-universal-ctags');
90109

91110
const ctags = spawn(ctagsPath, ['--version']);
92111

@@ -288,7 +307,7 @@ If the download fails:
288307
If you encounter permission errors:
289308

290309
```bash
291-
chmod +x node_modules/code-search-mcp-universal-ctags/bin/ctags
310+
chmod +x node_modules/@LLMTooling/code-search-mcp-universal-ctags/bin/ctags
292311
```
293312

294313
---

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "code-search-mcp-universal-ctags",
2+
"name": "@LLMTooling/code-search-mcp-universal-ctags",
33
"version": "0.1.0",
44
"description": "Node module for using universal-ctags with pre-built binaries",
55
"main": "lib/index.js",

0 commit comments

Comments
 (0)