Skip to content

Commit 0d688dc

Browse files
committed
adds installation section
1 parent 83a6ed6 commit 0d688dc

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,21 @@
66

77
<p align="center"><i>Detect unsafe contexts, queries in loops, hardcoded IDs, and more to optimize Salesforce Flows</i></p>
88

9-
![FlowScan example](docs/images/sfdxgif.gif)
9+
<p align="center">
10+
<img src="docs/images/sfdxgif.gif" alt="Flow Overview" width="76%" />
11+
</p>
12+
13+
---
14+
15+
## Table of contens
1016

11-
- **[Installation](#installation)**
1217
- **[Usage](#usage)**
1318
- **[Configuration](#configuration)**
19+
- **[Scanner Options](#scanner-options)**
20+
- **[Installation](#installation)**
1421
- **[Development](#development)**
1522

16-
## Installation
17-
18-
Install with SFDX:
19-
20-
```sh-session
21-
sf plugins install lightning-flow-scanner
22-
```
23-
24-
Install with NPM:
25-
26-
```sh-session
27-
npm install -g lightning-flow-scanner
28-
```
23+
---
2924

3025
## Usage
3126

@@ -54,27 +49,32 @@ Customize the scan behavior using the following options:
5449
**Privacy:** Zero user data collected. All processing is client-side.
5550
→ See Data Handling in our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner-cli?tab=security-ov-file).
5651

52+
---
53+
5754
## Configuration
5855

59-
It is recommended to set up configuration and define:
56+
It is recommended to set up a `.flow-scanner.yml` and define:
6057

6158
- The rules to be executed.
6259
- The severity of violating any specific rule.
6360
- Rule properties such as REGEX expressions.
6461
- Any known exceptions that should be ignored during scanning.
6562

63+
### Scanner Options
64+
6665
```json
6766
{
6867
"rules": {
6968
// Your rules here
7069
},
7170
"exceptions": {
7271
// Your exceptions here
73-
}
72+
},
73+
"betamode": false // include rules currently in beta
7474
}
7575
```
7676

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:
7878

7979
```json
8080
{
@@ -87,7 +87,19 @@ Using the rules section of your configurations, you can specify the list of rule
8787
}
8888
```
8989

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.
97+
98+
[![npm version](https://img.shields.io/npm/v/lightning-flow-scanner?label=npm)](https://www.npmjs.com/package/lightning-flow-scanner)
99+
100+
| **Install with sf (Salesforce CLI)** | **Install globally with npm** |
101+
|--------------------------------------|-------------------------------|
102+
| ```bash<br>sf plugins install lightning-flow-scanner``` | ```bash<br>npm install -g lightning-flow-scanner``` |
91103

92104
---
93105

0 commit comments

Comments
 (0)