Skip to content

Commit 66b11ac

Browse files
committed
Regenerate documentation
1 parent f92d912 commit 66b11ac

6 files changed

Lines changed: 151 additions & 1 deletion

File tree

docs/commands/phylum.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Usage: phylum [OPTIONS] [COMMAND]
3939

4040
* [phylum analyze](./phylum_analyze.md)
4141
* [phylum auth](./phylum_auth.md)
42+
* [phylum exception](./phylum_exception.md)
4243
* [phylum extension](./phylum_extension.md)
4344
* [phylum firewall](./phylum_firewall.md)
4445
* [phylum group](./phylum_group.md)

docs/commands/phylum_exception.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# phylum exception
2+
3+
Manage analysis exceptions
4+
5+
```sh
6+
Usage: phylum exception [OPTIONS] <COMMAND>
7+
```
8+
9+
## Options
10+
11+
`-o`, `--org` `<ORG>`
12+
&emsp; Phylum organization
13+
14+
`-v`, `--verbose`...
15+
&emsp; Increase the level of verbosity (the maximum is -vvv)
16+
17+
`-q`, `--quiet`...
18+
&emsp; Reduce the level of verbosity (the maximum is -qq)
19+
20+
`-h`, `--help`
21+
&emsp; Print help
22+
23+
## Commands
24+
25+
* [phylum exception add](./phylum_exception_add.md)
26+
* [phylum exception list](./phylum_exception_list.md)
27+
* [phylum exception remove](./phylum_exception_remove.md)
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# phylum exception add
2+
3+
Add a new analysis exception
4+
5+
```sh
6+
Usage: phylum exception add [OPTIONS] <--group <GROUP_NAME>|--project <PROJECT_NAME>>
7+
```
8+
9+
## Options
10+
11+
`-g`, `--group` `<GROUP_NAME>`
12+
&emsp; Group to add exception to
13+
14+
`-p`, `--project` `<PROJECT_NAME>`
15+
&emsp; Project to add exceptions to
16+
17+
`-e`, `--ecosystem` `<ECOSYSTEM>`
18+
&emsp; Ecosystem of the package to add an exception for
19+
&emsp; Accepted values: `npm`, `rubygems`, `pypi`, `maven`, `nuget`, `golang`, `cargo`
20+
21+
`-n`, `--name` `<PACKAGE_NAME>`
22+
&emsp; Name and optional namespace of the package to add an exception for
23+
24+
`--version` `<VERSION>`
25+
&emsp; Version of the package to add an exception for
26+
27+
`--purl` `<PURL>`
28+
&emsp; Package in PURL format
29+
30+
`-r`, `--reason` `<REASON>`
31+
&emsp; Reason for adding this exception
32+
33+
`-s`, `--no-suggestions`
34+
&emsp; Do not query package firewall to make suggestions
35+
36+
`-o`, `--org` `<ORG>`
37+
&emsp; Phylum organization
38+
39+
`-v`, `--verbose`...
40+
&emsp; Increase the level of verbosity (the maximum is -vvv)
41+
42+
`-q`, `--quiet`...
43+
&emsp; Reduce the level of verbosity (the maximum is -qq)
44+
45+
`-h`, `--help`
46+
&emsp; Print help
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# phylum exception list
2+
3+
List active analysis exceptions
4+
5+
```sh
6+
Usage: phylum exception list [OPTIONS] <--group <GROUP_NAME>|--project <PROJECT_NAME>>
7+
```
8+
9+
## Options
10+
11+
`-j`, `--json`
12+
&emsp; Produce output in json format (default: false)
13+
14+
`-g`, `--group` `<GROUP_NAME>`
15+
&emsp; Group to list exceptions for
16+
17+
`-p`, `--project` `<PROJECT_NAME>`
18+
&emsp; Project to list exceptions for
19+
20+
`-o`, `--org` `<ORG>`
21+
&emsp; Phylum organization
22+
23+
`-v`, `--verbose`...
24+
&emsp; Increase the level of verbosity (the maximum is -vvv)
25+
26+
`-q`, `--quiet`...
27+
&emsp; Reduce the level of verbosity (the maximum is -qq)
28+
29+
`-h`, `--help`
30+
&emsp; Print help
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# phylum exception remove
2+
3+
Remove an existing analysis exception
4+
5+
```sh
6+
Usage: phylum exception remove [OPTIONS] <--group <GROUP_NAME>|--project <PROJECT_NAME>>
7+
```
8+
9+
## Options
10+
11+
`-g`, `--group` `<GROUP_NAME>`
12+
&emsp; Group to add exception to
13+
14+
`-p`, `--project` `<PROJECT_NAME>`
15+
&emsp; Project to add exceptions to
16+
17+
`-e`, `--ecosystem` `<ECOSYSTEM>`
18+
&emsp; Ecosystem of the exception which should be removed
19+
&emsp; Accepted values: `npm`, `rubygems`, `pypi`, `maven`, `nuget`, `golang`, `cargo`
20+
21+
`-n`, `--name` `<PACKAGE_NAME>`
22+
&emsp; Package name and optional namespace of the exception which should be removed
23+
24+
`--version` `<VERSION>`
25+
&emsp; Package version of the exception which should be removed
26+
27+
`--purl` `<PURL>`
28+
&emsp; Package in PURL format
29+
30+
`--id` `<ISSUE_ID>`
31+
&emsp; Issue ID of the exception which should be removed
32+
33+
`--tag` `<ISSUE_TAG>`
34+
&emsp; Issue tag of the exception which should be removed
35+
36+
`-o`, `--org` `<ORG>`
37+
&emsp; Phylum organization
38+
39+
`-v`, `--verbose`...
40+
&emsp; Increase the level of verbosity (the maximum is -vvv)
41+
42+
`-q`, `--quiet`...
43+
&emsp; Reduce the level of verbosity (the maximum is -qq)
44+
45+
`-h`, `--help`
46+
&emsp; Print help

docs/commands/phylum_firewall_log.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Usage: phylum firewall log [OPTIONS] <GROUP_NAME>
99
## Arguments
1010

1111
`<GROUP_NAME>`
12-
&emsp; Specify a group to use for analysis
12+
&emsp; Firewall group to list log activity for
1313

1414
## Options
1515

0 commit comments

Comments
 (0)