Skip to content

Commit

Permalink
rename command to move
Browse files Browse the repository at this point in the history
Signed-off-by: Dentrax <[email protected]>
  • Loading branch information
Dentrax committed Jul 11, 2024
1 parent 3eeddb4 commit dac327d
Show file tree
Hide file tree
Showing 74 changed files with 871 additions and 103 deletions.
8 changes: 6 additions & 2 deletions docs/cmd/wolfictl.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ A CLI helper for developing Wolfi
### Options

```
-h, --help help for wolfictl
-h, --help help for wolfictl
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO
Expand All @@ -18,13 +20,15 @@ A CLI helper for developing Wolfi
* [wolfictl apk](wolfictl_apk.md) -
* [wolfictl build](wolfictl_build.md) -
* [wolfictl bump](wolfictl_bump.md) - Bumps the epoch field in melange configuration files
* [wolfictl bundle](wolfictl_bundle.md) -
* [wolfictl check](wolfictl_check.md) - Subcommands used for CI checks in Wolfi
* [wolfictl dot](wolfictl_dot.md) - Generate graphviz .dot output
* [wolfictl gh](wolfictl_gh.md) - Commands used to interact with GitHub
* [wolfictl image](wolfictl_image.md) - (Experimental) Commands for working with container images that use Wolfi
* [wolfictl index](wolfictl_index.md) -
* [wolfictl lint](wolfictl_lint.md) - Lint the code
* [wolfictl ruby](wolfictl_ruby.md) - Work with ruby packages
* [wolfictl scan](wolfictl_scan.md) - Scan a package for vulnerabilities
* [wolfictl test](wolfictl_test.md) -
* [wolfictl text](wolfictl_text.md) - Print a sorted list of downstream dependent packages
* [wolfictl update](wolfictl_update.md) - Proposes melange package update(s) via a pull request
* [wolfictl version](wolfictl_version.md) - Prints the version
Expand Down
11 changes: 11 additions & 0 deletions docs/cmd/wolfictl_advisory.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,25 @@ Commands for consuming and maintaining security advisory data
-h, --help help for advisory
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl](wolfictl.md) - A CLI helper for developing Wolfi
* [wolfictl advisory alias](wolfictl_advisory_alias.md) - Commands for discovering vulnerability aliases
* [wolfictl advisory copy](wolfictl_advisory_copy.md) - Copy a package's advisories into a new package.
* [wolfictl advisory create](wolfictl_advisory_create.md) - Create a new advisory
* [wolfictl advisory diff](wolfictl_advisory_diff.md) - See the advisory data differences introduced by your local changes
* [wolfictl advisory discover](wolfictl_advisory_discover.md) - Automatically create advisories by matching distro packages to vulnerabilities in NVD
* [wolfictl advisory guide](wolfictl_advisory_guide.md) - Launch an interactive guide to help you enter advisory data for a package
* [wolfictl advisory list](wolfictl_advisory_list.md) - List advisories for specific packages, vulnerabilities, or the entire data set
* [wolfictl advisory move](wolfictl_advisory_move.md) - Move a package's advisories into a new package.
* [wolfictl advisory osv](wolfictl_advisory_osv.md) - Build an OSV dataset from Chainguard advisory data
* [wolfictl advisory secdb](wolfictl_advisory_secdb.md) - Build an Alpine-style security database from advisory data
* [wolfictl advisory update](wolfictl_advisory_update.md) - Update an existing advisory with a new event
* [wolfictl advisory validate](wolfictl_advisory_validate.md) - Validate the state of advisory data
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ Commands for discovering vulnerability aliases
-h, --help help for alias
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_alias_discover.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ than attempting any kind of merge of the separate advisories.
-p, --package strings packages to operate on
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory alias](wolfictl_advisory_alias.md) - Commands for discovering vulnerability aliases
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_alias_find.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ hyperlinked to the relevant webpage from the upstream data source.
-h, --help help for find
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory alias](wolfictl_advisory_alias.md) - Commands for discovering vulnerability aliases
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ newly created advisory and any other advisories for the same package.
-V, --vuln string vulnerability ID for advisory
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ See the advisory data differences introduced by your local changes
-h, --help help for diff
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_discover.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ Automatically create advisories by matching distro packages to vulnerabilities i
-r, --package-repo-url string URL of the APK package repository
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
Expand Down
41 changes: 39 additions & 2 deletions docs/cmd/wolfictl_advisory_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ wolfictl advisory list

List advisories for specific packages, vulnerabilities, or the entire data set.

The 'list' (or 'ls') command prints a list of advisories based on the given
The 'list' (or 'ls') command prints a table of advisories based on the given
selection criteria. By default, all advisories in the current advisory data set
will be listed.

Expand All @@ -28,6 +28,21 @@ You can list all advisories for a given vulnerability ID across all packages:

wolfictl adv ls -V CVE-2023-38545

You can filter advisories by the type of the latest event:

wolfictl adv ls -t detection

You can filter advisories by the detected component type:

wolfictl adv ls -c python

You can filter advisories by the date they were created or last updated:

wolfictl adv ls --created-since 2024-01-01
wolfictl adv ls --created-before 2023-12-31
wolfictl adv ls --updated-since 2024-06-01
wolfictl adv ls --updated-before 2024-06-01

You can show only advisories that are considered not to be "resolved":

wolfictl adv ls --unresolved
Expand All @@ -40,19 +55,41 @@ Using the --history flag, you can list advisory events instead of just
advisories' latest states. This is useful for viewing a summary of an
investigation over time for a given package/vulnerability match.'

COUNT

You get a count of the advisories that match the criteria by using the --count
flag. This will report just the count, not the full list of advisories.

wolfictl adv ls <various filter flags> --count



### Options

```
-a, --advisories-repo-dir string directory containing the advisories repository
--aliases show other known vulnerability IDs for each advisory (default true)
-c, --component-type string filter advisories by detected component type
--count show only the count of advisories that match the criteria
--created-before string filter advisories created before a given date
--created-since string filter advisories created since a given date
-h, --help help for list
--history show full history for advisories
--no-distro-detection do not attempt to auto-detect the distro
-p, --package string package name
-t, --type string filter advisories by event type
--unresolved only show advisories considered to be unresolved
--updated-before string filter advisories updated before a given date
--updated-since string filter advisories updated since a given date
-V, --vuln string vulnerability ID for advisory
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
## wolfictl advisory stream
## wolfictl advisory move

Start version streaming for a package by moving its advisories into a new package.
Move a package's advisories into a new package.

***Aliases**: stream*
***Aliases**: mv*

### Usage

```
wolfictl advisory stream <package-name> <version-streamed-package-name>
wolfictl advisory move <package-name> <version-streamed-package-name>
```

### Synopsis

Start version streaming for a package by moving its advisories into a new package.
Move a package's advisories into a new package.

This command will move most advisories for the given package into a new package. And rename the
package to the new package name. (i.e., from foo.advisories.yaml to foo-X.Y.advisories.yaml) If the
target file already exists, the command will try to merge the advisories. To ensure the advisories
are up-to-date, the command will start a scan for the new package.

This command is also useful to start version streaming for an existing package that has not been
version streamed before. Especially that requires manual intervention to move the advisories.

The command will move the latest event for each advisory, and will update the timestamp
of the event to now. The command will not copy events of type "detection", "fixed",
"analysis_not_planned", or "fix_not_planned".
Expand All @@ -28,7 +31,7 @@ of the event to now. The command will not copy events of type "detection", "fixe

```
-d, --dir string directory containing the advisories to copy (default ".")
-h, --help help for stream
-h, --help help for move
```

### Options inherited from parent commands
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_secdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ Build an Alpine-style security database from advisory data
--url-prefix string URL scheme and hostname for the package repository (default "https://packages.wolfi.dev")
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
Expand Down
7 changes: 7 additions & 0 deletions docs/cmd/wolfictl_advisory_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ required fields are missing.
-V, --vuln string vulnerability ID for advisory
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
Expand Down
10 changes: 9 additions & 1 deletion docs/cmd/wolfictl_advisory_validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,21 @@ print an error message that specifies where and how the data is invalid.
--no-distro-detection do not attempt to auto-detect the distro
-p, --package strings packages to validate
-r, --package-repo-url string URL of the APK package repository
--skip-alias skip alias completeness validation
--skip-alias skip alias completeness validation (default true)
--skip-diff skip diff-based validations
--skip-existence skip package configuration existence validation
-v, --verbose count logging verbosity (v = info, vv = debug, default is none)
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl advisory](wolfictl_advisory.md) - Commands for consuming and maintaining security advisory data
* [wolfictl advisory validate fixes](wolfictl_advisory_validate_fixes.md) - Validate fixes recorded in advisories

19 changes: 10 additions & 9 deletions docs/cmd/wolfictl_apk.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,26 @@



### Usage

```
wolfictl apk
```

### Synopsis



### Options

```
--arch string arch of package to get (default "x86_64")
-h, --help help for apk
--repo string repo to get packages from (default "wolfi")
-h, --help help for apk
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [wolfictl](wolfictl.md) - A CLI helper for developing Wolfi
* [wolfictl apk cp](wolfictl_apk_cp.md) -
* [wolfictl apk ls](wolfictl_apk_ls.md) -

42 changes: 32 additions & 10 deletions docs/cmd/wolfictl_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,38 @@ wolfictl build
### Options

```
--arch strings arch of package to build (default [x86_64,aarch64])
-d, --dir string directory to search for melange configs (default ".")
--dry-run print commands instead of executing them
-h, --help help for build
-j, --jobs int number of jobs to run concurrently (default is GOMAXPROCS)
-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])
--log-dir string subdirectory where buildlogs will be written when specified (packages/$arch/buildlogs/$apk.log) (default "buildlogs")
--pipeline-dir string directory used to extend defined built-in pipelines
-r, --repository-append strings path to extra repositories to include in the build environment (default [https://packages.wolfi.dev/os])
--runner string which runner to use to enable running commands, default is based on your platform. (default "docker")
--arch strings arch of package to build (default [x86_64,aarch64])
--bucket string gcs bucket to upload results (experimental)
--bundle string bundle of work to do (experimental)
--cache-dir string directory used for cached inputs (default "./melange-cache/")
--cache-source string directory or bucket used for preloading the cache
--destination-bucket string bucket where packages are uploaded (experimental)
--destination-repository string repo where packages will eventually be uploaded, used to skip existing packages (currently only supports http)
-d, --dir string directory to search for melange configs (default ".")
--dry-run print commands instead of executing them
--generate-index whether to generate APKINDEX.tar.gz (default true)
--gvisor enable gVisor (GKE Sandbox) for builds
-h, --help help for build
-j, --jobs int number of jobs to run concurrently (default is GOMAXPROCS)
--k8s-namespace string namespace to deploy pods into for builds. (default "default")
-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])
--machine-family string machine family for amd64 builds
--namespace string namespace to use in package URLs in SBOM (eg wolfi, alpine) (default "wolfi")
--out-dir string directory where packages will be output
--pipeline-dir string directory used to extend defined built-in pipelines
-r, --repository-append strings path to extra repositories to include in the build environment (default [https://packages.wolfi.dev/os])
--runner string which runner to use to enable running commands, default is based on your platform. (default "docker")
--service-account string service-account to run pods as. (default "default")
--signing-key string key to use for signing
--summary string file to write build summary
--trace string where to write trace output
```

### Options inherited from parent commands

```
--log-level string log level (e.g. debug, info, warn, error) (default "info")
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO
Expand Down
Loading

0 comments on commit dac327d

Please sign in to comment.