@mgamil/mapx 0.2.4 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +25 -22
  2. package/VERSION +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  **Local code graph memory for LLMs.** Scan your codebase once — instantly query symbols, trace dependencies, analyze impact, and generate structured summaries without re-reading files.
4
4
 
5
- MapX uses [tree-sitter](https://tree-sitter.github.io/) to parse source files across **22 languages**, builds a PageRank-weighted dependency graph, and persists everything to a local SQLite database. Works as a standalone CLI or as an [MCP server](https://modelcontextprotocol.io/) with **25 tools** for Claude Desktop, Cursor, VS Code, and any other MCP-compatible client.
5
+ MapXGraph _-also known as MapX-_ uses [tree-sitter](https://tree-sitter.github.io/) to parse source files across **22 languages**, builds a PageRank-weighted dependency graph, and persists everything to a local SQLite database. Works as a standalone CLI or as an [MCP server](https://modelcontextprotocol.io/) with **25 tools** for Claude Desktop, Cursor, VS Code, and any other MCP-compatible client.
6
6
 
7
7
  ---
8
8
 
@@ -26,7 +26,27 @@ MapX uses [tree-sitter](https://tree-sitter.github.io/) to parse source files ac
26
26
 
27
27
  ## Installation
28
28
 
29
- ### Pre-built binary (recommended)
29
+ ### From npm (Global Installation)
30
+
31
+ Install MapX globally (recommended):
32
+
33
+ ```bash
34
+ npm install -g @mgamil/mapx
35
+ ```
36
+
37
+ ### Zero Installation (via npx)
38
+
39
+ Run MapX directly without installing it globally:
40
+
41
+ ```bash
42
+ # Initialize project
43
+ npx @mgamil/mapx init
44
+
45
+ # Scan files
46
+ npx @mgamil/mapx scan
47
+ ```
48
+
49
+ ### Pre-built binary
30
50
 
31
51
  Download the latest release for your platform from the [Releases](../../releases) page and place it on your `PATH`:
32
52
 
@@ -47,12 +67,6 @@ cd mapx-<version>
47
67
  ./install.sh --system # installs to /usr/local/bin (needs sudo)
48
68
  ```
49
69
 
50
- ### From npm
51
-
52
- ```bash
53
- npm install -g mapx
54
- ```
55
-
56
70
  ### From source
57
71
 
58
72
  Requires [Node.js](https://nodejs.org/) ≥ 20 or [Bun](https://bun.sh/).
@@ -68,6 +82,9 @@ npx tsx src/main.ts --help
68
82
 
69
83
  ## Quick Start
70
84
 
85
+ > [!TIP]
86
+ > If using the zero-installation method, replace `mapx` with `npx @mgamil/mapx` in the commands below (e.g. `npx @mgamil/mapx init`, `npx @mgamil/mapx scan`).
87
+
71
88
  ```bash
72
89
  # 1. Initialize mapx in your project (auto-adds .mapx/ to .gitignore)
73
90
  cd /path/to/your/project
@@ -469,20 +486,6 @@ make install-local
469
486
 
470
487
  ---
471
488
 
472
- ## Publishing to npm
473
-
474
- To publish new releases of the npm package:
475
-
476
- 1. Create a tag matching the version in `package.json` and push it:
477
- ```bash
478
- git tag v0.1.7
479
- git push origin v0.1.7
480
- ```
481
- 2. The GitHub Actions publish workflow will automatically run, verify version synchronization, build WASM grammars, compile the TypeScript code using `tsup`, and publish to the npm registry with provenance.
482
- 3. **Important**: The workflow requires a repository secret named `NPM_TOKEN`. This token must be generated on `npmjs.com` as an **Automation** access token.
483
-
484
- ---
485
-
486
489
  ## License
487
490
 
488
491
  Apache 2.0 — see [LICENSE](LICENSE).
package/VERSION CHANGED
@@ -1 +1 @@
1
- 0.2.4
1
+ 0.2.5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mgamil/mapx",
3
- "version": "0.2.4",
3
+ "version": "0.2.5",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Multi-language code graph memory system for LLMs",
6
6
  "author": {