@mondoohq/xgrep_windows_arm64 0.1.2 → 0.2.0

package/README.md

@@ -7,42 +7,30 @@ language-aware, AST-based pattern matching. It optimizes for **accuracy** — wh
 it reports a vulnerability, it should be real and exploitable — and adds
 code-intelligence and AI-agent features on top of scanning.
 
-This npm package ships prebuilt `xgrep` binaries; installing it puts the
-`xgrep` command on your `PATH`.
+This npm package ships prebuilt `xgrep` binaries for Linux and Windows
+(amd64 and arm64).
 
-## Run with npx
+## Quick start
 
-No install required:
+xgrep ships with a built-in rule corpus, so no rules file is needed to get
+started — run it straight from npx:
 
 ```bash
-npx @mondoohq/xgrep --help
-npx @mondoohq/xgrep -f rules.yaml src/
+# Scan the current directory with the built-in rules (defaults to security)
+npx @mondoohq/xgrep scan .
 ```
 
-## Install
-
 ```bash
-# Global install (adds the `xgrep` command)
-npm install -g @mondoohq/xgrep
-xgrep --help
-
-# Or as a project dev dependency
-npm install --save-dev @mondoohq/xgrep
-```
-
-The wrapper package resolves and installs the correct binary for your OS and
-architecture (Linux and Windows, amd64 and arm64).
-
-## Quick start
-
-```bash
-# Scan a directory with a rule file (or a directory of rules)
-xgrep -f rules.yaml src/
+# Choose a category (default: security)
+npx @mondoohq/xgrep scan --category correctness .
 
 # Machine-readable output
-xgrep -f rules.yaml --json src/
-xgrep -f rules.yaml --sarif src/                          # GitHub Code Scanning
-xgrep -f rules.yaml --gitlab -o gl-sast-report.json src/  # GitLab SAST
+npx @mondoohq/xgrep scan --json .
+npx @mondoohq/xgrep scan --sarif .                          # GitHub Code Scanning
+npx @mondoohq/xgrep scan --gitlab -o gl-sast-report.json .  # GitLab SAST
+
+# Bring your own rules: point -f at a rule file or a directory of rules
+npx @mondoohq/xgrep scan -f rules.yaml src/
 ```
 
 A scan target can also be a **remote git repository** — xgrep clones it
@@ -50,18 +38,20 @@ A scan target can also be a **remote git repository** — xgrep clones it
 needed:
 
 ```bash
-xgrep scan github.com/mondoohq/xgrep            # host/owner/repo shorthand
-xgrep scan https://github.com/mondoohq/xgrep    # or a full HTTPS/SSH URL
-xgrep scan github.com/mondoohq/xgrep --ref v1.2.0   # a branch, tag, or commit
+npx @mondoohq/xgrep scan github.com/mondoohq/xgrep            # host/owner/repo shorthand
+npx @mondoohq/xgrep scan https://github.com/mondoohq/xgrep    # or a full HTTPS/SSH URL
+npx @mondoohq/xgrep scan github.com/mondoohq/xgrep --ref v1.2.0   # a branch, tag, or commit
 ```
 
-## Documentation
-
-Full documentation, rule-writing guides, and the CLI reference live in the
-project repository:
+## Install
 
-**https://github.com/mondoohq/xgrep**
+To add the `xgrep` command to your `PATH` instead of using npx:
 
-## License
+```bash
+# Global install
+npm install -g @mondoohq/xgrep
+xgrep scan .
 
-Apache-2.0 — see https://github.com/mondoohq/xgrep/blob/main/LICENSE
+# Or as a project dev dependency
+npm install --save-dev @mondoohq/xgrep
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondoohq/xgrep_windows_arm64",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "bin": {
     "xgrep_windows_arm64": "xgrep.exe"
   },