README
¶
forklift
Description
Experimental tool to manipulate container images.
Installation
Homebrew
The homeport/tap has macOS and GNU/Linux pre-built binaries available:
brew install homeport/tap/forklift
Pre-built binaries in GitHub
Prebuilt binaries can be downloaded from the GitHub Releases section.
Curl To Shell Convenience Script
There is a convenience script to download the latest release for Linux or macOS if you want to need it simple (you need curl and jq installed on your machine):
curl --silent --location https://raw.githubusercontent.com/homeport/forklift/main/hack/download.sh | bash
Build from Source
You can install forklift from source using go install:
go install github.com/homeport/forklift/cmd/forklift@latest
Please note: This will install forklift based on the latest available code base. Even though the goal is that the latest commit on the main branch should always be a stable and usable version, this is not the recommended way to install and use forklift. If you find an issue with this version, please make sure to note the commit SHA or date in the GitHub issue to indcate that it is not based on a released version. The version output will show forklift version (development) for go install based builds.
Contributing
We are happy to have other people contributing to the project. If you decide to do that, here's how to:
- get Go (
forkliftrequires Go version 1.20 or greater) - fork the project
- create a new branch
- make your changes
- open a PR.
Git commit messages should be meaningful and follow the rules nicely written down by Chris Beams:
The seven rules of a great Git commit message
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
Running test cases and binaries generation
Run test cases:
ginkgo run ./...
Create binaries:
goreleaser build --clean --snapshot
License
Licensed under MIT License
Directories