Skip to content

Commit 55b21a8

Browse files
GhostTypesGhostTypes
authored
Update README.md
1 parent 63b6c2a commit 55b21a8

1 file changed

Lines changed: 8 additions & 234 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 234 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<div align="center">
22

3-
<h1>code-search-mcp-universal-ctags</h1>
3+
<h1>universal-ctags-node</h1>
44

5-
<p><b>Node.js package bundling universal-ctags binaries for cross-platform code indexing</b></p>
5+
<p><b>Node.js wrapper for universal-ctags binaries for cross-platform code indexing</b></p>
66

77
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](LICENSE)
8-
[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg?style=for-the-badge)](package.json)
9-
[![Platform Support](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg?style=for-the-badge)](#platform-support)
8+
[![Node Version](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg?style=for-the-badge)](package.json)
9+
[![Platform Support](https://img.shields.io/badge/ctags-6.2.1-lightgrey.svg?style=for-the-badge)](#platform-support)
1010

1111
</div>
1212

@@ -55,8 +55,6 @@
5555

5656
<div align="center">
5757

58-
<h2>From GitHub Packages</h2>
59-
6058
<p>This package is published to GitHub Packages and requires authentication to install.</p>
6159

6260
<table>
@@ -84,27 +82,12 @@ echo "//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN" >> .npmrc</pre>
8482
<tr>
8583
<td><b>3. Install the Package</b></td>
8684
<td>
87-
<pre style="text-align: left;">npm install @LLMTooling/code-search-mcp-universal-ctags</pre>
85+
<pre style="text-align: left;">npm install @LLMTooling/universal-ctags-node</pre>
8886
</td>
8987
</tr>
9088
</table>
9189

9290
<br>
93-
94-
<table>
95-
<tr>
96-
<th>Alternative: Environment Variable Installation</th>
97-
</tr>
98-
<tr>
99-
<td>
100-
<pre style="text-align: left;">
101-
echo "@LLMTooling:registry=https://npm.pkg.github.com" > .npmrc
102-
export NODE_AUTH_TOKEN=YOUR_GITHUB_TOKEN
103-
npm install @LLMTooling/code-search-mcp-universal-ctags</pre>
104-
</td>
105-
</tr>
106-
</table>
107-
10891
</div>
10992

11093
<div align="center">
@@ -120,7 +103,7 @@ npm install @LLMTooling/code-search-mcp-universal-ctags</pre>
120103
<td><b>Basic Usage</b></td>
121104
<td>
122105
<pre style="text-align: left;">
123-
const { ctagsPath } = require('@LLMTooling/code-search-mcp-universal-ctags');
106+
const { ctagsPath } = require('@LLMTooling/universal-ctags-node');
124107

125108
console.log('ctags binary location:', ctagsPath);
126109
// Use ctagsPath with child_process to run ctags commands</pre>
@@ -131,7 +114,7 @@ console.log('ctags binary location:', ctagsPath);
131114
<td>
132115
<pre style="text-align: left;">
133116
const { execSync } = require('child_process');
134-
const { ctagsPath } = require('@LLMTooling/code-search-mcp-universal-ctags');
117+
const { ctagsPath } = require('@LLMTooling/universal-ctags-node');
135118

136119
// Get ctags version
137120
const version = execSync(`"${ctagsPath}" --version`, { encoding: 'utf8' });
@@ -148,7 +131,7 @@ execSync(`"${ctagsPath}" -R --fields=+nKz --extras=+q .`, {
148131
<td>
149132
<pre style="text-align: left;">
150133
const { spawn } = require('child_process');
151-
const { ctagsPath } = require('@LLMTooling/code-search-mcp-universal-ctags');
134+
const { ctagsPath } = require('@LLMTooling/universal-ctags-node');
152135

153136
const ctags = spawn(ctagsPath, ['--version']);
154137

@@ -202,8 +185,6 @@ ctags.stderr.on('data', (data) => {
202185

203186
<div align="center">
204187

205-
<h2>Package Structure</h2>
206-
207188
<table>
208189
<tr>
209190
<th>File Tree</th>
@@ -229,51 +210,12 @@ code-search-mcp-universal-ctags/
229210

230211
<div align="center">
231212

232-
<h2>How It Works</h2>
233-
234-
<table>
235-
<tr>
236-
<th>Phase</th>
237-
<th>Description</th>
238-
</tr>
239-
<tr>
240-
<td><b>Installation</b></td>
241-
<td>npm install triggers the postinstall script</td>
242-
</tr>
243-
<tr>
244-
<td><b>Platform Detection</b></td>
245-
<td>Determines operating system and CPU architecture</td>
246-
</tr>
247-
<tr>
248-
<td><b>Download</b></td>
249-
<td>Fetches appropriate binary from GitHub releases</td>
250-
</tr>
251-
<tr>
252-
<td><b>Extraction</b></td>
253-
<td>Extracts binary to the bin/ directory</td>
254-
</tr>
255-
<tr>
256-
<td><b>Permissions</b></td>
257-
<td>Sets executable permissions on Unix systems</td>
258-
</tr>
259-
<tr>
260-
<td><b>Verification</b></td>
261-
<td>Main module verifies binary existence before exporting path</td>
262-
</tr>
263-
</table>
264-
265-
</div>
266-
267-
<div align="center">
268-
269213
<h1>Configuration</h1>
270214

271215
</div>
272216

273217
<div align="center">
274218

275-
<h2>Environment Variables</h2>
276-
277219
<table>
278220
<tr>
279221
<th>Variable</th>
@@ -294,174 +236,6 @@ code-search-mcp-universal-ctags/
294236

295237
<br>
296238

297-
<table>
298-
<tr>
299-
<th>Example Usage</th>
300-
</tr>
301-
<tr>
302-
<td>
303-
<pre style="text-align: left;">
304-
# Avoid GitHub API rate limits
305-
export GITHUB_TOKEN=your_github_token
306-
npm install
307-
308-
# Skip automatic binary download
309-
SKIP_POSTINSTALL=1 npm install</pre>
310-
</td>
311-
</tr>
312-
</table>
313-
314-
</div>
315-
316-
<div align="center">
317-
318-
<h1>Development</h1>
319-
320-
<table>
321-
<tr>
322-
<th>Setup & Testing</th>
323-
</tr>
324-
<tr>
325-
<td>
326-
<pre style="text-align: left;">
327-
# Clone the repository
328-
git clone https://github.com/LLMTooling/code-search-mcp-universal-ctags.git
329-
cd code-search-mcp-universal-ctags
330-
331-
# Install dependencies
332-
npm install
333-
334-
# Run tests
335-
npm test
336-
337-
# Run linter
338-
npm run lint
339-
340-
# Fix linting issues
341-
npm run lint:fix</pre>
342-
</td>
343-
</tr>
344-
</table>
345-
346-
</div>
347-
348-
<div align="center">
349-
350-
<h2>Test Coverage</h2>
351-
352-
<p>Comprehensive tests verify binary download, extraction, executable permissions, functionality, and tag generation capabilities.</p>
353-
354-
<table>
355-
<tr>
356-
<th>CI/CD Workflows</th>
357-
<th>Purpose</th>
358-
<th>Platforms</th>
359-
</tr>
360-
<tr>
361-
<td>Platform Tests</td>
362-
<td>Automated testing on all supported platforms</td>
363-
<td>Windows, macOS (x64/ARM64), Linux</td>
364-
</tr>
365-
<tr>
366-
<td>Publish</td>
367-
<td>Publish package to GitHub Packages</td>
368-
<td>N/A</td>
369-
</tr>
370-
</table>
371-
372-
</div>
373-
374-
<div align="center">
375-
376-
<h1>Troubleshooting</h1>
377-
378-
<table>
379-
<tr>
380-
<th>Issue</th>
381-
<th>Solution</th>
382-
</tr>
383-
<tr>
384-
<td><b>Binary Not Found</b></td>
385-
<td>
386-
Ensure postinstall script ran successfully<br>
387-
Verify bin/ directory exists<br>
388-
Try reinstalling: <code>rm -rf node_modules && npm install</code>
389-
</td>
390-
</tr>
391-
<tr>
392-
<td><b>Download Failures</b></td>
393-
<td>
394-
Check internet connection and GitHub accessibility<br>
395-
Use GITHUB_TOKEN to avoid rate limits<br>
396-
Consider manual installation
397-
</td>
398-
</tr>
399-
<tr>
400-
<td><b>Permission Errors (Unix)</b></td>
401-
<td>
402-
<code>chmod +x node_modules/@LLMTooling/code-search-mcp-universal-ctags/bin/ctags</code>
403-
</td>
404-
</tr>
405-
</table>
406-
407-
</div>
408-
409-
<div align="center">
410-
411-
<h2>Manual Installation</h2>
412-
413-
<p>If automatic installation fails, install universal-ctags manually:</p>
414-
415-
<table>
416-
<tr>
417-
<th>Platform</th>
418-
<th>Installation Command</th>
419-
</tr>
420-
<tr>
421-
<td>macOS</td>
422-
<td><code>brew install universal-ctags</code></td>
423-
</tr>
424-
<tr>
425-
<td>Linux (Ubuntu/Debian)</td>
426-
<td><code>sudo apt install universal-ctags</code></td>
427-
</tr>
428-
<tr>
429-
<td>Linux (Snap)</td>
430-
<td><code>sudo snap install universal-ctags</code></td>
431-
</tr>
432-
<tr>
433-
<td>Windows</td>
434-
<td>Download from <a href="https://github.com/universal-ctags/ctags-win32/releases">ctags-win32 releases</a></td>
435-
</tr>
436-
</table>
437-
438-
</div>
439-
440-
<div align="center">
441-
442-
<h1>Contributing & License</h1>
443-
444-
<table>
445-
<tr>
446-
<th>Contributing</th>
447-
<th>License</th>
448-
</tr>
449-
<tr>
450-
<td>
451-
Fork the repository<br>
452-
Create a feature branch<br>
453-
Make changes and add tests<br>
454-
Run tests and linting<br>
455-
Submit a pull request
456-
</td>
457-
<td>
458-
Released under the MIT License<br>
459-
See <a href="LICENSE">LICENSE</a> file for details
460-
</td>
461-
</tr>
462-
</table>
463-
464-
</div>
465239

466240
<div align="center">
467241

0 commit comments

Comments
 (0)