@mondoohq/xgrep_linux_arm64 0.28.2 → 0.30.0

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 +54 -21
  2. package/package.json +1 -1
  3. package/xgrep +0 -0
package/README.md CHANGED
@@ -10,27 +10,46 @@ code-intelligence and AI-agent features on top of scanning.
10
10
  This npm package ships prebuilt `xgrep` binaries for Linux, macOS, and Windows
11
11
  (amd64 and arm64; the macOS binaries are signed and notarized).
12
12
 
13
- ## Quick start
13
+ ## Install
14
14
 
15
- xgrep ships with a built-in rule corpus, so no rules file is needed to get
16
- started run it straight from npx:
15
+ Install globally to add the `xgrep` command to your `PATH` the recommended way
16
+ to use it interactively:
17
17
 
18
18
  ```bash
19
- # Scan the current directory with the built-in rules (defaults to security)
20
- npx @mondoohq/xgrep scan .
19
+ npm install -g @mondoohq/xgrep
20
+ xgrep scan .
21
21
  ```
22
22
 
23
+ Or add it as a project dev dependency:
24
+
23
25
  ```bash
24
- # Choose a category (default: security)
25
- npx @mondoohq/xgrep scan --category correctness .
26
+ npm install --save-dev @mondoohq/xgrep
27
+ ```
28
+
29
+ Prefer zero-install? Run any command below through `npx @mondoohq/xgrep …`
30
+ instead of `xgrep …` (handy for one-offs and CI). Pin a version
31
+ (`@mondoohq/xgrep@<version>`) for reproducible builds.
32
+
33
+ ## Quick start
34
+
35
+ xgrep ships with a built-in rule corpus, so no rules file is needed to get
36
+ started:
37
+
38
+ ```bash
39
+ # Scan the current directory with the built-in rules. `xgrep scan` with no path
40
+ # defaults to the current directory.
41
+ xgrep scan
42
+
43
+ # Choose a category (default: security, secrets)
44
+ xgrep scan --category correctness .
26
45
 
27
46
  # Machine-readable output
28
- npx @mondoohq/xgrep scan --json .
29
- npx @mondoohq/xgrep scan --sarif . # GitHub Code Scanning
30
- npx @mondoohq/xgrep scan --gitlab -o gl-sast-report.json . # GitLab SAST
47
+ xgrep scan --json .
48
+ xgrep scan --sarif . # GitHub Code Scanning
49
+ xgrep scan --gitlab -o gl-sast-report.json . # GitLab SAST
31
50
 
32
51
  # Bring your own rules: point -f at a rule file or a directory of rules
33
- npx @mondoohq/xgrep scan -f rules.yaml src/
52
+ xgrep scan -f rules.yaml src/
34
53
  ```
35
54
 
36
55
  A scan target can also be a **remote git repository** — xgrep clones it
@@ -38,20 +57,34 @@ A scan target can also be a **remote git repository** — xgrep clones it
38
57
  needed:
39
58
 
40
59
  ```bash
41
- npx @mondoohq/xgrep scan github.com/mondoohq/xgrep # host/owner/repo shorthand
42
- npx @mondoohq/xgrep scan https://github.com/mondoohq/xgrep # or a full HTTPS/SSH URL
43
- npx @mondoohq/xgrep scan github.com/mondoohq/xgrep --ref v1.2.0 # a branch, tag, or commit
60
+ xgrep scan github.com/mondoohq/xgrep # host/owner/repo shorthand
61
+ xgrep scan https://github.com/mondoohq/xgrep # or a full HTTPS/SSH URL
62
+ xgrep scan github.com/mondoohq/xgrep --ref v1.2.0 # a branch, tag, or commit
44
63
  ```
45
64
 
46
- ## Install
65
+ ## Add it to CI
47
66
 
48
- To add the `xgrep` command to your `PATH` instead of using npx:
67
+ Scaffold a ready-to-commit CI workflow for your provider (GitHub Actions, GitLab,
68
+ or Azure Pipelines) — it installs xgrep and runs a diff-aware scan on every pull
69
+ request:
49
70
 
50
71
  ```bash
51
- # Global install
52
- npm install -g @mondoohq/xgrep
53
- xgrep scan .
72
+ xgrep ci --init
73
+ ```
54
74
 
55
- # Or as a project dev dependency
56
- npm install --save-dev @mondoohq/xgrep
75
+ ## AI-agent skills (Claude Code)
76
+
77
+ xgrep bundles [Claude Code](https://www.claude.com/product/claude-code) skills for
78
+ triaging findings, fixing them, and navigating code with the code graph. Install
79
+ them into Claude Code or Codex:
80
+
81
+ ```bash
82
+ xgrep skill list # see the bundled skills
83
+ xgrep skill install # Claude Code plugins (into ~/.claude/plugins/)
84
+ xgrep skill install --target codex # Codex custom prompts (into ~/.codex/prompts/)
57
85
  ```
86
+
87
+ `xgrep fix` also drives an agent directly (`--agent codex`, or a custom command)
88
+ if you'd rather not install the skills. See the
89
+ [documentation](https://github.com/mondoohq/xgrep) for the full scan → triage →
90
+ fix workflow.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mondoohq/xgrep_linux_arm64",
3
- "version": "0.28.2",
3
+ "version": "0.30.0",
4
4
  "bin": {
5
5
  "xgrep_linux_arm64": "xgrep"
6
6
  },
package/xgrep CHANGED
Binary file