https://github.com/brumhard/krewfile

Declarative krew plugin management
https://github.com/brumhard/krewfile

krew kubernetes

Last synced: about 1 month ago
JSON representation

Declarative krew plugin management

• Host: GitHub
• URL: https://github.com/brumhard/krewfile
• Owner: brumhard
• License: mit
• Created: 2022-09-12T11:08:54.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T15:50:53.000Z (3 months ago)
• Last Synced: 2024-09-09T19:27:53.178Z (3 months ago)
• Topics: krew, kubernetes
• Language: Go
• Homepage:
• Size: 383 KB
• Stars: 19
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# krewfile

krewfile is just like [Brewfile (brew

bundle)](https://github.com/Homebrew/homebrew-bundle) or

[Gemfiles](https://bundler.io/man/gemfile.5.html) but for the

[krew](https://github.com/kubernetes-sigs/krew) kubernetes plugin manager.

## Demo

![krewfile demo](docs/term-animation.svg)

## Usage

Define a krewfile like the following at `~/.krewfile`:

```krewfile

index foo https://github.com/foo/custom-index.git

# this is a comment

foo/some-package

explore # great module

modify-secret

neat

oidc-login

pv-migrate

stern

krew

```

Now run `krewfile` and it will install all the plugins defined in the file and

also remove all the plugins that are not in the file.

If you want to install plugins from a different index than the default one, you

can add indices to your krewfile (see first line in the example), and then use

that index just like you would in the krew CLI. Have look at the [krew

docs](https://krew.sigs.k8s.io/docs/user-guide/custom-indexes/) for more info.

You can also put your krewfile at any other location and point to that using the

`-file` CLI parameter.

Lastly, you can use the `-command` flag to overwrite the binary to call. By

default, `krew` is used, but you might as well use `-command "kubectl krew"` to

use the kubectl plugin instead.

## Installation

### From source

If you have Go 1.16+, you can directly install by running:

```bash

go install github.com/brumhard/krewfile@latest

```

> Based on your go configuration the `krewfile` binary can be found in

> `$GOPATH/bin` or `$HOME/go/bin` in case `$GOPATH` is not set. Make sure to add

> the respective directory to your `$PATH`. [For more information see go docs

> for further information](https://golang.org/ref/mod#go-install). Run `go env`

> to view your current configuration.

### nix

This repo contains a [`flake.nix`](flake.nix) file which you can use for example

with

```shell

nix run github:brumhard/krewfile# -- -help

```

**Using home-manager module**

If you're using flakes to manage your system, add the `krewfile` input as

follows:

```nix

# ...

inputs.krewfile = {

  url = "github:brumhard/krewfile";

  inputs.nixpkgs.follows = "nixpkgs";

};

```

You can now access the module via `inputs.krewfile.homeManagerModules.krewfile`.

Assuming a setup with properly configured imports via

`home-manager.extraSpecialArgs`, the module can be imported and configured as

shown below:

```nix

{ inputs, pkgs, ... }: {

  imports = [

    # ...

    inputs.krewfile.homeManagerModules.krewfile

  ];

  programs.krewfile = {

    enable = true;

    krewPackage = pkgs.krew;

    indexes = { foo = "https://github.com/nilic/kubectl-netshoot.git" };

    plugins = [

      "foo/some-package"

      "explore"

      "modify-secret"

      "neat"

      "oidc-login"

      "pv-migrate"

      "stern"

    ];

  };

}

```