You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -54,27 +49,32 @@ Customize the scan behavior using the following options:
54
49
**Privacy:** Zero user data collected. All processing is client-side.
55
50
→ See Data Handling in our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner-cli?tab=security-ov-file).
56
51
52
+
---
53
+
57
54
## Configuration
58
55
59
-
It is recommended to set up configuration and define:
56
+
It is recommended to set up a `.flow-scanner.yml` and define:
60
57
61
58
- The rules to be executed.
62
59
- The severity of violating any specific rule.
63
60
- Rule properties such as REGEX expressions.
64
61
- Any known exceptions that should be ignored during scanning.
65
62
63
+
### Scanner Options
64
+
66
65
```json
67
66
{
68
67
"rules": {
69
68
// Your rules here
70
69
},
71
70
"exceptions": {
72
71
// Your exceptions here
73
-
}
72
+
},
73
+
"betamode": false// include rules currently in beta
74
74
}
75
75
```
76
76
77
-
Using the rules section of your configurations, you can specify the list of rules to be run. Furthermore, you can define the severity and configure expressions of rules. To include rules currently that are currently in beta, set `betarules` to true. Below is a breakdown of the available attributes of rule configuration:
77
+
Using the rules section of your configurations, you can specify the list of rules to be run. Furthermore, you can define the severity and configure expressions of rules. Below is a breakdown of the available attributes of rule configuration:
78
78
79
79
```json
80
80
{
@@ -87,7 +87,19 @@ Using the rules section of your configurations, you can specify the list of rule
87
87
}
88
88
```
89
89
90
-
Note: if you prefer YAML format, you can create a `.flow-scanner.yml` file using the same format. For a more on configurations, review the [scanner documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/#configurations).
90
+
Note: if you prefer JSON format, you can create a `.flow-scanner.json` file using the same format. For a more on configurations, review the [scanner documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/#configurations).
91
+
92
+
---
93
+
94
+
## Installation
95
+
96
+
`lightning-flow-scanner-cli` is published to **npm** only.
0 commit comments