github.com/wolfi-dev/wolfictl@v0.16.11/README.md (about)

     1  # wolfictl
     2  
     3  [![Documentation](https://godoc.org/github.com/wolfi-dev/wolfictl?status.svg)](https://pkg.go.dev/mod/github.com/wolfi-dev/wolfictl)
     4  [![Go Report Card](https://goreportcard.com/badge/github.com/wolfi-dev/wolfictl)](https://goreportcard.com/report/github.com/wolfi-dev/wolfictl)
     5  
     6  `wolfictl` is a command line tool for working with Wolfi
     7  
     8  ## Installation
     9  
    10  You can install  `wolfictl` straight from its source code. To do this, clone the git repository and then run `go install`:
    11  
    12  ```bash
    13  # Clone the repo
    14  
    15  git clone git@github.com:wolfi-dev/wolfictl.git wolfictl && cd $_
    16  
    17  # Install the `wolfictl` command
    18  
    19  go install
    20  ```
    21  
    22  ## Commands
    23  
    24  See the [wolfictl command reference](https://github.com/wolfi-dev/wolfictl/blob/main/docs/cmd/wolfictl.md)
    25  
    26  ## Docs
    27  
    28  [Check so_name docs](./docs/check_so_name.md) - CI check for detecting ABI breaking changes in package version updates
    29  [Update docs](./docs/update.md) - for detecting new upstream wolfi package versions and creating a pull request to update Wolfi
    30  
    31  ## Releases
    32  
    33  This repo is configured to automatically create weekly tagged patch releases, mainly so that it can be more easily packaged in Wolfi itself.
    34  
    35  Releases happen Monday at 00:00 UTC, and can be manually run as necessary.