Skip to content

Commit bae53cb

Browse files
committed
scan: ability to override repository
Signed-off-by: Dentrax <[email protected]>
1 parent f10bd62 commit bae53cb

25 files changed

+1360
-6
lines changed

docs/cmd/wolfictl_advisory_copy.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## wolfictl advisory copy
2+
3+
Copy a package's advisories into a new package.
4+
5+
***Aliases**: cp*
6+
7+
### Usage
8+
9+
```
10+
wolfictl advisory copy <source-package-name> <destination-package-name>
11+
```
12+
13+
### Synopsis
14+
15+
Copy a package's advisories into a new package.
16+
17+
This command will copy most advisories for the given package into a new package.
18+
19+
The command will copy the latest event for each advisory, and will update the timestamp
20+
of the event to now. The command will not copy events of type "detection", "fixed",
21+
"analysis_not_planned", or "fix_not_planned".
22+
23+
24+
### Options
25+
26+
```
27+
-d, --dir string directory containing the advisories to copy (default ".")
28+
-h, --help help for copy
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
35+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
36+
```
37+
38+
### SEE ALSO
39+
40+
* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
41+
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## wolfictl advisory guide
2+
3+
Launch an interactive guide to help you enter advisory data for a package
4+
5+
### Usage
6+
7+
```
8+
wolfictl advisory guide
9+
```
10+
11+
### Synopsis
12+
13+
Launch an interactive guide to help you enter advisory data for a package
14+
15+
### Options
16+
17+
```
18+
-h, --help help for guide
19+
-s, --speedy Skip explanations and unnecessary time delays
20+
```
21+
22+
### Options inherited from parent commands
23+
24+
```
25+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
26+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
27+
```
28+
29+
### SEE ALSO
30+
31+
* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
32+
* [wolfictl advisory guide graph](wolfictl_advisory_guide_graph.md) - Generate a DOT graph of the advisory guide interview questions
33+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## wolfictl advisory guide graph
2+
3+
Generate a DOT graph of the advisory guide interview questions
4+
5+
### Usage
6+
7+
```
8+
wolfictl advisory guide graph
9+
```
10+
11+
### Synopsis
12+
13+
Generate a DOT graph of the advisory guide interview questions
14+
15+
### Options
16+
17+
```
18+
-h, --help help for graph
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```
24+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
25+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
26+
```
27+
28+
### SEE ALSO
29+
30+
* [wolfictl advisory guide](wolfictl_advisory_guide.md) - Launch an interactive guide to help you enter advisory data for a package
31+

docs/cmd/wolfictl_advisory_osv.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## wolfictl advisory osv
2+
3+
Build an OSV dataset from Chainguard advisory data
4+
5+
### Usage
6+
7+
```
8+
wolfictl advisory osv
9+
```
10+
11+
### Synopsis
12+
13+
Build an OSV dataset from Chainguard advisory data.
14+
15+
This command reads advisory data from one or more directories containing Chainguard
16+
advisory documents, and writes an OSV dataset to a local directory.
17+
18+
Specify directories for advisory repositories using the --advisories-repo-dir flag.
19+
20+
IMPORTANT: For now, the command assumes that the first listed advisory repository is the
21+
"Wolfi" repository, and that the rest are not. In the future, we might unify all advisory
22+
repositories into a single collection of all advisory documents, and remove the need for
23+
multiple advisory repositories.
24+
25+
The user must also specify directories for all package repositories associated with the
26+
given advisory data. This is used to make sure the OSV data includes all relevant packages
27+
and subpackages.
28+
29+
The output directory for the OSV dataset is specified using the --output flag. This
30+
directory must already exist before running the command.
31+
32+
33+
### Options
34+
35+
```
36+
-a, --advisories-repo-dir strings path to the directory(ies) containing Chainguard advisory data
37+
-h, --help help for osv
38+
-o, --output string path to a local directory in which the OSV dataset will be written
39+
-p, --packages-repo-dir strings path to the directory(ies) containing Chainguard package data
40+
```
41+
42+
### Options inherited from parent commands
43+
44+
```
45+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
46+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
47+
```
48+
49+
### SEE ALSO
50+
51+
* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
52+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## wolfictl advisory validate fixes
2+
3+
Validate fixes recorded in advisories
4+
5+
### Usage
6+
7+
```
8+
wolfictl advisory validate fixes
9+
```
10+
11+
### Synopsis
12+
13+
Validate fixes recorded in advisories
14+
15+
### Options
16+
17+
```
18+
-a, --advisories-repo-dir string directory containing the advisories repository
19+
-b, --built-packages-dir string directory containing built packages
20+
--distro string distro to use during vulnerability matching (default "wolfi")
21+
-h, --help help for fixes
22+
-v, --verbose count logging verbosity (v = info, vv = debug, default is none)
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
29+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
30+
```
31+
32+
### SEE ALSO
33+
34+
* [wolfictl advisory validate](wolfictl_advisory_validate.md) - Validate the state of advisory data
35+

docs/cmd/wolfictl_apk_cp.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## wolfictl apk cp
2+
3+
4+
5+
***Aliases**: copy*
6+
7+
### Usage
8+
9+
```
10+
wolfictl apk cp
11+
```
12+
13+
### Synopsis
14+
15+
16+
17+
### Options
18+
19+
```
20+
--gcs string copy objects from a GCS bucket
21+
-h, --help help for cp
22+
-i, --index string APKINDEX.tar.gz URL (default "https://packages.wolfi.dev/os/x86_64/APKINDEX.tar.gz")
23+
--latest copy only the latest version of each package (default true)
24+
-o, --out-dir string directory to copy packages to (default "./packages")
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
31+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
32+
```
33+
34+
### SEE ALSO
35+
36+
* [wolfictl apk](wolfictl_apk.md) -
37+

docs/cmd/wolfictl_apk_ls.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## wolfictl apk ls
2+
3+
4+
5+
### Usage
6+
7+
```
8+
wolfictl apk ls
9+
```
10+
11+
### Synopsis
12+
13+
14+
15+
### Examples
16+
17+
wolfictl apk ls https://packages.wolfi.dev/os/x86_64/APKINDEX.tar.gz
18+
19+
### Options
20+
21+
```
22+
--full print the full url or path
23+
-h, --help help for ls
24+
--json print each package as json
25+
--latest print only the latest version of each package
26+
--newer-than duration print only packages newer than this duration ago
27+
-P, --package string print only packages with the given name
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
34+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
35+
```
36+
37+
### SEE ALSO
38+
39+
* [wolfictl apk](wolfictl_apk.md) -
40+

docs/cmd/wolfictl_bundle.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## wolfictl bundle
2+
3+
4+
5+
### Usage
6+
7+
```
8+
wolfictl bundle
9+
```
10+
11+
### Synopsis
12+
13+
14+
15+
### Options
16+
17+
```
18+
-a, --annotation stringToString New annotations to add (default [])
19+
--arch strings arch of package to build (default [x86_64,aarch64])
20+
--bundle-base string base image used for melange build bundles
21+
--bundle-repo string where to push the bundles
22+
--cache-dir string directory used for cached inputs (default "./melange-cache/")
23+
--cache-source string directory or bucket used for preloading the cache
24+
--destination-repository string repo where packages will eventually be uploaded, used to skip existing packages (currently only supports http)
25+
-d, --dir string directory to search for melange configs (default ".")
26+
--dry-run print commands instead of executing them
27+
--gcsfuse strings list of gcsfuse mounts to make available to the build environment (e.g. gs://my-bucket/subdir:/mnt/my-bucket)
28+
--generate-index whether to generate APKINDEX.tar.gz (default true)
29+
-h, --help help for bundle
30+
-k, --keyring-append strings path to extra keys to include in the build environment keyring (default [https://packages.wolfi.dev/os/wolfi-signing.rsa.pub])
31+
--namespace string namespace to use in package URLs in SBOM (eg wolfi, alpine) (default "wolfi")
32+
--out-dir string directory where packages will be output
33+
--pipeline-dir string directory used to extend defined built-in pipelines
34+
-r, --repository-append strings path to extra repositories to include in the build environment (default [https://packages.wolfi.dev/os])
35+
--runner string which runner to use to enable running commands, default is based on your platform. (default "docker")
36+
--signing-key string key to use for signing
37+
```
38+
39+
### Options inherited from parent commands
40+
41+
```
42+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
43+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
44+
```
45+
46+
### SEE ALSO
47+
48+
* [wolfictl](wolfictl.md) - A CLI helper for developing Wolfi
49+

docs/cmd/wolfictl_ruby.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## wolfictl ruby
2+
3+
Work with ruby packages
4+
5+
### Usage
6+
7+
```
8+
wolfictl ruby
9+
```
10+
11+
### Synopsis
12+
13+
Work with ruby packages
14+
15+
The ruby subcommand is intended to work with all ruby packages inside the wolfi
16+
repo. The main uses right now are to check if the ruby version can be upgraded,
17+
and run Github code searches for Github repos pulled from melange yaml files.
18+
19+
This command takes a path to the wolfi-dev/os repository as an argument. The
20+
path can either be the directory itself to discover all files using ruby-* or
21+
a specific melange yaml to work with.
22+
23+
NOTE: This is currently restricted to ruby code housed on Github as that is the
24+
majority. There are some on Gitlab and adding Gitlab API support is TODO.
25+
26+
27+
### Examples
28+
29+
30+
# Run a search query over all ruby-3.2 package in the current directory
31+
wolfictl ruby code-search . --ruby-version 3.2 --search-term 'language:ruby racc'
32+
33+
# Check if all ruby-3.2 packages in the current directory can be upgraded to ruby-3.3
34+
wolfictl ruby check-upgrade . --ruby-version 3.2 --ruby-upgrade-version 3.3
35+
36+
37+
### Options
38+
39+
```
40+
-h, --help help for ruby
41+
```
42+
43+
### Options inherited from parent commands
44+
45+
```
46+
--log-level string log level (e.g. debug, info, warn, error) (default "info")
47+
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
48+
```
49+
50+
### SEE ALSO
51+
52+
* [wolfictl](wolfictl.md) - A CLI helper for developing Wolfi
53+
* [wolfictl ruby check-upgrade](wolfictl_ruby_check-upgrade.md) - Check if gemspec for restricts a gem from upgrading to a specified ruby version.
54+
* [wolfictl ruby code-search](wolfictl_ruby_code-search.md) - Run Github search queries for ruby packages.
55+

0 commit comments

Comments
 (0)