Skip to content

Commit ef5330b

Browse files
committed
some formatting updates
1 parent 44a3927 commit ef5330b

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,17 @@ system debug.
1010
- [Example: Remote Execution](#example-remote-execution)
1111
- [Example: connection_config.json](#example-connection_configjson)
1212
- [Subcommands](#subcommands)
13+
- ['describe' subcommand](#describe-subcommand)
14+
- ['run-plugins' sub command](#run-plugins-sub-command)
15+
- ['gen-plugin-config' sub command](#gen-plugin-config-sub-command)
16+
- ['summary' sub command](#summary-sub-command)
1317
- [Configs](#configs)
18+
- [Global args](#global-args)
19+
- [Plugin config: `--plugin-configs` command](#plugin-config---plugin-configs-command)
20+
- [Reference config: `gen-reference-config` command](#reference-config-gen-reference-config-command)
1421
- [nodescraper integration](#nodescraper-integration)
1522

23+
1624
## Installation
1725
### Install From Source
1826
Node Scraper requires Python 3.10+ for installation. After cloning this repository,
@@ -107,7 +115,7 @@ Plugins to run can be specified in two ways, using a plugin JSON config file or
107115
'run-plugins' sub command. These two options are not mutually exclusive and can be used together.
108116
109117
110-
1. **'describe' subcommand**
118+
#### **'describe' subcommand**
111119
112120
You can use the `describe` subcommand to display details about built-in configs or plugins.
113121
List all built-in configs:
@@ -130,7 +138,7 @@ Show details for a specific plugin
130138
node-scraper describe plugin <plugin-name>
131139
```
132140
133-
2. **'run-plugins' sub command**
141+
#### **'run-plugins' sub command**
134142
The plugins to run and their associated arguments can also be specified directly on the CLI using
135143
the 'run-plugins' sub-command. Using this sub-command you can specify a plugin name followed by
136144
the arguments for that particular plugin. Multiple plugins can be specified at once.
@@ -176,7 +184,7 @@ Use plugin configs and 'run-plugins'
176184
node-scraper run-plugins BiosPlugin
177185
```
178186
179-
3. **'gen-plugin-config' sub command**
187+
#### **'gen-plugin-config' sub command**
180188
The 'gen-plugin-config' sub command can be used to generate a plugin config JSON file for a plugin
181189
or list of plugins that can then be customized. Plugin arguments which have default values will be
182190
prepopulated in the JSON file, arguments without default values will have a value of 'null'.
@@ -211,7 +219,7 @@ This would produce the following config:
211219
}
212220
```
213221
214-
4. **'summary' sub command**
222+
#### **'summary' sub command**
215223
The 'summary' subcommand can be used to combine results from multiple runs of node-scraper to a
216224
single summary.csv file. Sample run:
217225
```sh
@@ -248,7 +256,21 @@ tabular format to the console.
248256
}
249257
```
250258
251-
1. Plugin config: **'--plugin-configs' command**
259+
#### Global args
260+
Global args can be used to skip sudo plugins or enable/disble either collection or analysis.
261+
Below is an example that skips sudo requiring plugins and disables analysis.
262+
263+
```
264+
"global_args": {
265+
"collection_args": {
266+
"skip_sudo" : 1
267+
},
268+
"collection" : 1,
269+
"analysis" : 0
270+
},
271+
```
272+
273+
#### Plugin config: **'--plugin-configs' command**
252274
A plugin config can be used to compare the system data against the config specifications:
253275
```sh
254276
node-scraper --plugin-configs plugin_config.json
@@ -306,7 +328,7 @@ Here is an example of a comprehensive plugin config that specifies analyzer args
306328
}
307329
```
308330
309-
2. Reference config: **'gen-reference-config' command**
331+
#### Reference config: **'gen-reference-config' command**
310332
This command can be used to generate a reference config that is populated with current system
311333
configurations. Plugins that use analyzer args (where applicable) will be populated with system
312334
data.
@@ -356,7 +378,7 @@ This will generate a reference config that includes plugins with logged results
356378
357379
## nodescraper integration
358380
Nodescraper can be integrated inside another Python tool by leveraging its classes and functionality.
359-
See bellow for a comprehensive example on how to create plugins and run the associated data
381+
See below for a comprehensive example on how to create plugins and run the associated data
360382
collection and analysis.
361383
Sample run command:
362384
```

0 commit comments

Comments
 (0)