mobbdev 0.0.3 → 0.0.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.
- package/README.md +20 -5
- package/bin/cli.mjs +0 -0
- package/package.json +1 -1
- package/src/constants.mjs +4 -1
- package/src/index.mjs +3 -1
package/README.md
CHANGED
|
@@ -1,17 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Mobb CLI (community tool)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[Mobb](https://www.mobb.dev) automates security vulnerability remediations.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
<img width="750" alt="Screenshot 2023-03-27 at 5 23 19 PM" src="https://user-images.githubusercontent.com/96389636/228070025-2a1c3aae-6b40-427f-a1e9-2b10ef97b5ea.png">
|
|
6
|
+
|
|
7
|
+
## What is [Mobb](https://www.mobb.dev)?
|
|
8
|
+
|
|
9
|
+
[Mobb](https://www.mobb.dev) is the first vendor agnostic automatic security vulnerability remediation tool. It injests SAST results from Checkmarx One, GitHub Advanced Security, and Snyk Code and produces code fixes for the developer to review and commit to their code.
|
|
10
|
+
|
|
11
|
+
## What does Mobb CLI (Community Tool) do?
|
|
12
|
+
|
|
13
|
+
- Uses Snyk Code CLI to run a SAST analysis on a given GitHub repo
|
|
14
|
+
- Analyzes the vulnerbilities report to identify issues that can be remediated
|
|
15
|
+
- Produce the code fixes and redirect the user to the fix report page on [mobb.dev](https://www.mobb.dev)
|
|
6
16
|
|
|
7
17
|
## Disclaimer
|
|
8
18
|
|
|
9
|
-
This is
|
|
19
|
+
This is an alpha version only capable of analyzing public GitHub repositories. We wrap Snyk Code CLI to produce SAST vulnerabilities report.
|
|
10
20
|
|
|
11
|
-
Only Java projects are supported at the moment.
|
|
21
|
+
- Only Java projects are supported at the moment.
|
|
22
|
+
- Only SQLi, CMDi, XSS, and XXE are supported at the moment.
|
|
12
23
|
|
|
13
24
|
## Usage
|
|
14
25
|
|
|
15
26
|
```shell
|
|
16
27
|
npx mobbdev https://github.com/mobb-dev/simple-vulnerable-java-project
|
|
17
28
|
```
|
|
29
|
+
|
|
30
|
+
## Getting support
|
|
31
|
+
|
|
32
|
+
If you need support using Mobb CLI, or just want to share your thoughts and learn more, you are more than welcome to join our [discord server](https://discord.gg/ks6Nz3H828)
|
package/bin/cli.mjs
CHANGED
|
File without changes
|
package/package.json
CHANGED
package/src/constants.mjs
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
1
3
|
import * as dotenv from 'dotenv';
|
|
2
4
|
import { z } from 'zod';
|
|
3
5
|
|
|
4
|
-
|
|
6
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
7
|
+
dotenv.config({ path: path.join(__dirname, '../.env') });
|
|
5
8
|
|
|
6
9
|
const envVariablesSchema = z
|
|
7
10
|
.object({
|
package/src/index.mjs
CHANGED
|
@@ -18,7 +18,9 @@ const config = new Configstore(packageJson.name, { token: '' });
|
|
|
18
18
|
|
|
19
19
|
export async function main(dirname, repoUrl) {
|
|
20
20
|
if (!repoUrl) {
|
|
21
|
-
console.warn(
|
|
21
|
+
console.warn(
|
|
22
|
+
'Mobb CLI usage: npx mobbdev <public GitHub repository URL>'
|
|
23
|
+
);
|
|
22
24
|
return;
|
|
23
25
|
}
|
|
24
26
|
|