Skip to content

Update README #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jlebon merged 5 commits into from
Jun 24, 2026
Merged

Update README #68

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90e722f
Remove FOSSA badge
alicefr Jun 23, 2026
65b6fa8
Remove reference to the container setup
alicefr Jun 23, 2026
670ddfa
Update how to build bink
alicefr Jun 23, 2026
68b3e68
Document how to source bink
alicefr Jun 23, 2026
abad6f3
Document bink auto-completion
alicefr Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# bink
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fbootc-dev%2Fbink.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fbootc-dev%2Fbink?ref=badge_shield)


A CLI tool for creating Kubernetes dev clusters from bootc images.

Expand All @@ -19,11 +17,8 @@ Bink uses the Podman client API. Make sure you have a Podman socket (e.g.
## Installation

```bash
go install ./cmd/bink
make build-bink
```

(We're working on making bink run as a container as well!)

## Running via Container

Instead of building the binary locally, you can run bink directly from a container image:
Expand Down Expand Up @@ -95,9 +90,8 @@ The `bink-storage` volume persists container images across runs so they don't ne
# Create cluster with control plane
bink cluster start

# Access the cluster
bink api expose
export KUBECONFIG=$PWD/kubeconfig-podman
# Create and export KUBECONFIG
eval $(bink api expose)
kubectl get pods -A

# Add worker nodes (optional)
Expand All @@ -123,6 +117,8 @@ bink cluster stop
bink cluster stop --remove-data
```

## Enable bink auto-completion

## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fbootc-dev%2Fbink.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fbootc-dev%2Fbink?ref=badge_large)
```bash
source <(bink completion bash)
```
Loading