Skip to content

Commit b124788

Browse files
authored
Update README.md
(Minor) command arguments readability.
1 parent 37b77fb commit b124788

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ Application Inspector is a command-line tool. Run it from a command line in Wind
4343
```
4444
> dotnet AppInspector.dll or on *Windows* simply AppInspector.exe <command> <options>
4545
46-
Microsoft Application Inspector 1.0.17
47-
ApplicationInspector 1.0.17
46+
Microsoft Application Inspector 1.0.25
47+
ApplicationInspector 1.0.25
4848
4949
(c) Microsoft Corporation. All rights reserved
5050
@@ -77,17 +77,17 @@ ERROR(S):
7777
Arguments:
7878
-s, --source-path Required. Path to source code to inspect (required)
7979
-o, --output-file-path Path to output file. Ignored with -f html option which auto creates output.html
80-
-f, --output-file-format (Default: html) Output format [html|json|text]
81-
-e, --text-format (Default: Tag:%T,Rule:%N,Ruleid:%R,Confidence:%X,File:%F,Sourcetype:%t,Line:%L,Sample:%m)
80+
-f, --output-file-format Output format [html|json|text]. Default = html
81+
-e, --text-format Match text format specifiers
8282
-r, --custom-rules-path Custom rules path
83-
-t, --tag-output-only (Default: false) Output only contains identified tags
84-
-i, --ignore-default-rules (Default: false) Ignore default rules bundled with application
85-
-d, --allow-dup-tags (Default: false) Output only contains non-unique tag matches
86-
-c, --confidence-filters (Default: high,medium) Output only if matches rule pattern confidence [<value>,] [high|medium|low]
87-
-k, --file-path-exclusions Exclude source files (none|default: sample,example,test,docs,.vs,.git)
88-
-x, --console-verbosity (Default: medium) Console verbosity [high|medium|low|none]
89-
-l, --log-file-path Log file path
90-
-v, --log-file-level (Default: Error) Log file level [Debug|Info|Warn|Error|Fatal|Off]
83+
-t, --tag-output-only Output only contains identified tags. Default = false
84+
-i, --ignore-default-rules Ignore default rules bundled with application. Default = false
85+
-d, --allow-dup-tags Output only non-unique tag matches. Default = false
86+
-c, --confidence-filters Output only matches with confidence [high|medium|low]. Default = high,medium
87+
-k, --file-path-exclusions Exclude source files [none|<list>]. Default = sample,example,test,docs,.vs,.git
88+
-x, --console-verbosity Console verbosity [high|medium|low|none]. Default = medium
89+
-l, --log-file-path Log file path. Default is <application path>/log.txt
90+
-v, --log-file-level Log file level [Debug|Info|Warn|Error|Fatal|Off]. Default = Error
9191
```
9292
##### Scan a project directory, with output sent to "output.html" (default behavior includes launching default browser to this file)
9393
```
@@ -110,13 +110,13 @@ Use to analyze and report on differences in tags (features) between two project
110110
Arguments:
111111
--src1 Required. Source 1 to compare (required)
112112
--src2 Required. Source 2 to compare (required
113-
-t, --test-type (Default: equality) Type of test to run [equality|inequality]
113+
-t, --test-type Type of test to run [equality|inequality]. Default = equality
114114
-r, --custom-rules-path Custom rules path
115-
-i, --ignore-default-rules (Default: false) Ignore default rules bundled with application
115+
-i, --ignore-default-rules Ignore default rules bundled with application. Default = false
116116
-o, --output-file-path Path to output file
117-
-x, --console-verbosity Console verbosity [high|medium|low
117+
-x, --console-verbosity Console verbosity [high|medium|low]. Default = medium
118118
-l, --log-file-path Log file path
119-
-v, --log-file-level Log file level [error|trace|debug|info]
119+
-v, --log-file-level Log file level [error|trace|debug|info]. Default = error
120120
```
121121
##### Simplist way to see the delta in tag features between two projects
122122
```
@@ -145,11 +145,11 @@ Otherwise, testing for all default rules present in source will likely yield a f
145145
146146
Arguments:
147147
-s, --source-path Required. Source to test (required)
148-
-t, --test-type (Default: rulespresent) Test to perform [rulespresent|rulesnotpresent]
148+
-t, --test-type Test to perform [rulespresent|rulesnotpresent]. Default = rulespresent
149149
-r, --custom-rules-path Custom rules path
150-
-i, --ignore-default-rules (Default: true) Ignore default rules bundled with application
150+
-i, --ignore-default-rules Ignore default rules bundled with application. Default = true
151151
-o, --output-file-path Path to output file
152-
-x, --console-verbosity Console verbosity [high|medium|low
152+
-x, --console-verbosity Console verbosity [high|medium|low]. Default = medium
153153
-l, --log-file-path Log file path
154154
-v, --log-file-level Log file level
155155
```
@@ -173,9 +173,9 @@ Otherwise, testing for all default rules present in source will likely yield a f
173173
174174
Arguments:
175175
-r, --custom-rules-path Custom rules path
176-
-i, --ignore-default-rules (Default: false) Ignore default rules bundled with application
176+
-i, --ignore-default-rules Ignore default rules bundled with application. Default = false
177177
-o, --output-file-path Path to output file
178-
-x, --console-verbosity Console verbosity [high|medium|low
178+
-x, --console-verbosity Console verbosity [high|medium|low]. Default = medium
179179
```
180180
##### Export default rule tags to console
181181
```
@@ -197,9 +197,9 @@ Verification that ruleset is compatible and error free for import and analysis
197197
198198
Arguments:
199199
-r, --custom-rules-path Custom rules path
200-
-i, --ignore-default-rules (Default: false) Ignore default rules bundled with application
200+
-i, --ignore-default-rules Ignore default rules bundled with application. Default = false
201201
-o, --output-file-path Path to output file
202-
-x, --console-verbosity Console verbosity [high|medium|low
202+
-x, --console-verbosity Console verbosity [high|medium|low]. Default = medium.
203203
```
204204
##### Simplist case to verify default rules
205205
```

0 commit comments

Comments
 (0)