Wolfictl

https://github.com/wolfi-dev/wolfictl
Admin
A command-line tool for working with Wolfi packages and performing package management operations.
Tokens:5,858
Snippets:147
Trust Score:9.1
License:Apache-2.0
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install wolfictl from source

Source: https://github.com/wolfi-dev/wolfictl/blob/main/README.md

Instructions for cloning the repository and installing the `wolfictl` command using `go install`.

```bash
# Clone the repo

git clone git@github.com:wolfi-dev/wolfictl.git wolfictl && cd $_

# Install the `wolfictl` command

go install
```

--------------------------------

### Examples

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_vex_package.md

Example of generating a VEX document with author and config files.

```bash
wolfictl vex package --author=joe@doe.com config1.yaml config2.yaml
```

--------------------------------

### Examples

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_release.md

Examples of how to use the wolfictl gh release command with different bumping options.

```bash
wolfictl gh release --bump-major
```

```bash
wolfictl gh release --bump-minor
```

```bash
wolfictl gh release --bump-patch
```

```bash
wolfictl gh release --bump-prerelease-with-prefix rc
```

--------------------------------

### Example Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_vex_sbom.md

Example of how to use the wolfictl vex sbom command with an author specified.

```bash
wolfictl vex sbom --author=joe@doe.com sbom.spdx.json
```

--------------------------------

### Example

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby_code-search.md

Run a search query over all ruby-3.2 packages in the current directory.

```bash
wolfictl ruby code-search . --ruby-version 3.2 --search-terms 'language:ruby racc'
```

--------------------------------

### Example Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_withdraw.md

An example of withdrawing packages using a signing key and specifying input and output APKINDEX files.

```bash
withdraw --signing-key ./foo.rsa example-pkg-1.2.3-r4 also-bad-2.3.4-r1 <old/APKINDEX.tar.gz >new/APKINDEX.tar.gz
```

--------------------------------

### Search query over all ruby-3.2 packages

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby.md

Example of running a search query over all ruby-3.2 packages in the current directory.

```bash
wolfictl ruby code-search . --ruby-version 3.2 --search-term 'language:ruby racc'
```

--------------------------------

### Example

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc_issues.md

An example of how to use the wolfictl gc issues command to garbage collect issues on GitHub.

```bash
wolfictl gc issues https://github.com/wolfi-dev/versions --match "version-stream:"
```

--------------------------------

### Example

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc_branch.md

An example of how to use the wolfictl gh gc branch command to garbage collect branches matching a pattern.

```bash
wolfictl gh gc branch https://github.com/wolfi-dev/os --match "wolfictl-"
```

--------------------------------

### Check if ruby-3.2 packages can be upgraded

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby.md

Example of checking if all ruby-3.2 packages in the current directory can be upgraded to ruby-3.3.

```bash
wolfictl ruby check-upgrade . --ruby-version 3.2 --ruby-upgrade-version 3.3
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_apk_cp.md

The basic usage of the wolfictl apk cp command.

```bash
wolfictl apk cp [flags]
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_image_apk.md

Show APK(s) in a container image

```bash
wolfictl image apk <image> [flags]
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_apk_ls.md

The basic usage of the wolfictl apk ls command.

```bash
wolfictl apk ls [flags]
```

--------------------------------

### wolfictl apk help

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_apk.md

Displays help information for the wolfictl apk command.

```bash
wolfictl apk --help
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_apk_cp.md

Available flags for the wolfictl apk cp command.

```bash
--gcs string       copy objects from a GCS bucket
  -h, --help             help for cp
  -i, --index string     APKINDEX.tar.gz URL (default "https://packages.wolfi.dev/os/x86_64/APKINDEX.tar.gz")
      --latest           copy only the latest version of each package (default true)
  -o, --out-dir string   directory to copy packages to (default "./packages")
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_image_apk.md

Options for the wolfictl image apk command

```bash
-c, --component string     show only APKs containing the given component
-d, --distro-dir strings   path to a directory containing Melange build configuration files
-h, --help                 help for apk
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_version.md

The basic usage of the wolfictl version command.

```bash
wolfictl version [flags]
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl.md

Command-line options for the wolfictl CLI.

```bash
-h, --help               help for wolfictl
      --log-level string   log level (e.g. debug, info, warn, error) (default "WARN")
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_image.md

Help option for the image command.

```bash
  -h, --help   help for image
```

--------------------------------

### Generating the package directory

Source: https://github.com/wolfi-dev/wolfictl/blob/main/pkg/dag/testdata/cycle/README.md

Commands to set up the necessary directory structure, generate a signing key, and create a signed APKINDEX for the upstream repository.

```shell
mkdir -p testdata/cycle/packages
mkdir -p testdata/cycle/packages/x86_64
melange keygen testdata/cycle/packages/key.rsa
tar -C testdata/cycle -czf testdata/cycle/packages/x86_64/APKINDEX.tar.gz APKINDEX
melange sign-index --signing-key testdata/cycle/packages/key.rsa testdata/cycle/packages/x86_64/APKINDEX.tar.gz
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_apk_ls.md

Available flags for the wolfictl apk ls command.

```bash
--full                  print the full url or path
  -h, --help                  help for ls
      --json                  print each package as json
      --latest                print only the latest version of each package
      --newer-than duration   print only packages newer than this duration ago
  -P, --package string        print only packages with the given name
```

--------------------------------

### Synopsis

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_image.md

Commands for working with container images that use Wolfi

```bash
wolfictl image
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_lint.md

The basic usage of the wolfictl lint command.

```bash
wolfictl lint [flags]
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_bump.md

The basic usage of the wolfictl bump command.

```bash
wolfictl bump config[.yaml] [config[.yaml]...] [flags]
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_vex_package.md

Generate a VEX document from package configuration files

```bash
wolfictl vex package CONFIG [CONFIG]... [flags]
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby.md

The basic usage of the wolfictl ruby command.

```bash
wolfictl ruby [flags]
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_version.md

Available flags for the wolfictl version command.

```bash
-h, --help   help for version
      --json   print JSON instead of text
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_check_so-name.md

The command to run the wolfictl check so-name command.

```bash
wolfictl check so-name [flags]
```

--------------------------------

### Open browser to explore crane's dependencies

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_dot.md

Open browser to explore crane's dependencies recursively, only showing a minimum subgraph.

```bash
wolfictl dot --web -R -S crane
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_vex_package.md

Command-specific options for wolfictl vex package.

```bash
--author string   author of the VEX document
  -h, --help            help for package
      --role string     role of the author of the VEX document
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby_check-upgrade.md

The basic usage of the wolfictl ruby check-upgrade command.

```bash
wolfictl ruby check-upgrade [flags]
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_release.md

The basic usage of the wolfictl gh release command.

```bash
wolfictl gh release [flags]
```

--------------------------------

### Generate graphviz .dot output

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_dot.md

Generate .dot output and pipe it to dot to generate a PNG.

```bash
wolfictl dot zlib | dot -Tpng > graph.png
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby_check-upgrade.md

Command-specific options for wolfictl ruby check-upgrade.

```bash
  -h, --help                          help for check-upgrade
      --no-cache                      do not use cached results
  -u, --ruby-upgrade-version string   ruby version to check for updates
  -r, --ruby-version string           ruby version to search for
```

--------------------------------

### Open browser to explore crane

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_dot.md

Open browser to explore crane.

```bash
wolfictl dot --web crane
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_lint_yam.md

The basic usage of the wolfictl lint yam command.

```bash
wolfictl lint yam [file]... [flags]
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_check_so-name.md

Flags available for the wolfictl check so-name command.

```bash
      --apk-index-url string       apk-index-url used to get existing apks.  Defaults to wolfi (default "https://packages.wolfi.dev/os/aarch64/APKINDEX.tar.gz")
  -d, --directory string           directory containing melange configs (default ".")
  -h, --help                       help for so-name
      --package-list-file string   name of the package to compare (default "packages.log")
      --packages-dir string        directory containing new packages (default "packages")
```

--------------------------------

### wolfictl dot usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_dot.md

Basic usage of the wolfictl dot command.

```bash
wolfictl dot [flags]
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_lint.md

Available flags for the wolfictl lint command.

```bash
-h, --help                    help for lint
  -l, --list                    prints the all of available rules and exits
  -s, --severity string         minimum severity level to report (error, warning, info) (default "warning")
      --skip-rule stringArray   list of rules to skip
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_check_diff.md

The basic usage of the wolfictl check diff command.

```bash
wolfictl check diff [flags]
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_check_diff.md

Command-specific options for wolfictl check diff.

```bash
      --apk-index-url string       apk-index-url used to get existing apks.  Defaults to wolfi (default "https://packages.wolfi.dev/os/%s/APKINDEX.tar.gz")
      --dir string                 directory the command is executed from and will contain the resulting diff.log file (default ".")
  -h, --help                       help for diff
      --package-list-file string   name of the package to compare (default "packages.log")
      --packages-dir string        directory containing new packages (default "packages")
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_release.md

Available flags for the wolfictl gh release command.

```bash
      --bump-major                           bumps the major release version
      --bump-minor                           bumps the minor release version
      --bump-patch                           bumps the patch release version
      --bump-prerelease-with-prefix string   bumps the prerelease version using the supplied prefix, if no existing prerelease exists the patch version is also bumped to align with semantic versioning
      --dir string                           directory containing the cloned github repository to release (default ".")
  -h, --help                                 help for release
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_bump.md

Command-specific options for wolfictl bump.

```bash
      --dry-run       don't change anything, just print what would be done
      --epoch         bump the package epoch (default true)
  -h, --help          help for bump
      --repo string   path to the wolfi/os repository (default ".")
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_withdraw.md

The basic usage of the wolfictl withdraw command.

```bash
wolfictl withdraw example-pkg-1.2.3-r4 [flags]
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_check.md

Options for the wolfictl check command.

```bash
-h, --help   help for check
```

--------------------------------

### Generate graphviz .dot output

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_dot.md

Generate .dot output and pipe it to dot to generate an SVG.

```bash
wolfictl dot zlib | dot -Tsvg > graph.svg
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_lint_yam.md

Specific options for the wolfictl lint yam command.

```bash
-h, --help   help for yam
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby_code-search.md

The basic usage of the wolfictl ruby code-search command.

```bash
wolfictl ruby code-search [flags]
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_vex_sbom.md

Options available for the wolfictl vex sbom command.

```bash
      --author string   author of the VEX document
  -h, --help            help for sbom
      --repo string     path to a local clone of the wolfi-dev/os repo
      --role string     role of the author of the VEX document
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby.md

Options specific to the wolfictl ruby command.

```bash
-h, --help   help for ruby
```

--------------------------------

### vex command options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_vex.md

Options for the wolfictl vex command.

```bash
  -h, --help   help for vex
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_ruby_code-search.md

Options for the wolfictl ruby code-search command.

```bash
  -h, --help                       help for code-search
      --no-cache                   do not use cached results
  -r, --ruby-version string        ruby version to search for
  -s, --search-terms stringArray   GitHub code search term
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh.md

Options for the wolfictl gh command.

```bash
  -h, --help   help for gh
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_withdraw.md

Command-specific options for the wolfictl withdraw command.

```bash
-h, --help                   help for withdraw
      --packages-file string   file containing list of packages to withdraw (one per line, supports comments with #)
      --signing-key string     the signing key to use (default "melange.rsa")
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_vex_sbom.md

Generate a VEX document from wolfi packages listed in an SBOM

```bash
wolfictl vex sbom [flags] sbom.spdx.json
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc.md

Help option for the gc command.

```bash
-h, --help   help for gc
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc_issues.md

Flags available for the wolfictl gh gc issues command.

```bash
--all            close all issues if set
  -h, --help           help for issues
      --match string   pattern to match issues against
```

--------------------------------

### wolfictl apk with log level

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_apk.md

Sets the log level for the wolfictl apk command.

```bash
wolfictl apk --log-level "info"
```

--------------------------------

### Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc_branch.md

Available options for the wolfictl gh gc branch command.

```bash
      --all            close all branches if set
  -h, --help           help for branch
      --match string   pattern to match branches against
```

--------------------------------

### Inherited Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_release.md

Options inherited from parent commands for wolfictl gh release.

```bash
      --log-level string   log level (e.g. debug, info, warn, error) (default "WARN")
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc_branch.md

The basic usage of the wolfictl gh gc branch command.

```bash
wolfictl gh gc branch [flags]
```

--------------------------------

### Usage

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc_issues.md

The basic usage of the wolfictl gh gc issues command.

```bash
wolfictl gh gc issues [flags]
```

--------------------------------

### Inherited Options

Source: https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl_gh_gc.md

Inherited log level option for the gc command.

```bash
--log-level string   log level (e.g. debug, info, warn, error) (default "WARN")
```
Tokens:
Raw