Skip to content

Commit 3eeddb4

Browse files
committed
update docs for stream
Signed-off-by: Dentrax <furkan.turkal@chainguard.dev>
1 parent 2b2774a commit 3eeddb4

2 files changed

Lines changed: 98 additions & 0 deletions

File tree

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## wolfictl advisory stream
2+
3+
Start version streaming for a package by moving its advisories into a new package.
4+
5+
***Aliases**: stream*
6+
7+
### Usage
8+
9+
```
10+
wolfictl advisory stream <package-name> <version-streamed-package-name>
11+
```
12+
13+
### Synopsis
14+
15+
Start version streaming for a package by moving its advisories into a new package.
16+
17+
This command will move most advisories for the given package into a new package. And rename the
18+
package to the new package name. (i.e., from foo.advisories.yaml to foo-X.Y.advisories.yaml) If the
19+
target file already exists, the command will try to merge the advisories. To ensure the advisories
20+
are up-to-date, the command will start a scan for the new package.
21+
22+
The command will move the latest event for each advisory, and will update the timestamp
23+
of the event to now. The command will not copy events of type "detection", "fixed",
24+
"analysis_not_planned", or "fix_not_planned".
25+
26+
27+
### Options
28+
29+
```
30+
-d, --dir string directory containing the advisories to copy (default ".")
31+
-h, --help help for stream
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
38+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
39+
```
40+
41+
### SEE ALSO
42+
43+
* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
44+
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
.TH "WOLFICTL\-ADVISORY\-STREAM" "1" "" "Auto generated by spf13/cobra" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
wolfictl\-advisory\-stream \- Start version streaming for a package by moving its advisories into a new package.
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBwolfictl advisory stream <package-name> <version-streamed-package-name>\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Start version streaming for a package by moving its advisories into a new package.
19+
20+
.PP
21+
This command will move most advisories for the given package into a new package. And rename the
22+
package to the new package name. (i.e., from foo.advisories.yaml to foo\-X.Y.advisories.yaml) If the
23+
target file already exists, the command will try to merge the advisories. To ensure the advisories
24+
are up\-to\-date, the command will start a scan for the new package.
25+
26+
.PP
27+
The command will move the latest event for each advisory, and will update the timestamp
28+
of the event to now. The command will not copy events of type "detection", "fixed",
29+
"analysis\_not\_planned", or "fix\_not\_planned".
30+
31+
32+
.SH OPTIONS
33+
.PP
34+
\fB\-d\fP, \fB\-\-dir\fP="."
35+
directory containing the advisories to copy
36+
37+
.PP
38+
\fB\-h\fP, \fB\-\-help\fP[=false]
39+
help for stream
40+
41+
42+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
43+
.PP
44+
\fB\-\-log\-level\fP="info"
45+
log level (e.g. debug, info, warn, error)
46+
47+
.PP
48+
\fB\-\-log\-policy\fP=[builtin:stderr]
49+
log policy (e.g. builtin:stderr, /tmp/log/foo)
50+
51+
52+
.SH SEE ALSO
53+
.PP
54+
\fBwolfictl\-advisory(1)\fP

0 commit comments

Comments
 (0)