kleiner

command module
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 10, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

README

Kleiner - CLI to set up distribution of other clis

Let's face it, go is an excellent tool to build self contained clis, however there is always a question of distribution. You could ask your friends to download new binary from the releases page, however wouldn't it be cooler to have a cli that can report about updates and update itself?

This has been done a load of time, however kleiner allows to do that at scale since it's so damn easy to generate yet another cli and have it's distribution set up immediately. All you need to do is to add your commands and you're done.

We don't need to have another tool for scaffolding, hence please have cobra-cli installed

Local cobra config was used using:

cobra-cli init --config .cobra.yaml

We won't be building binaries ourselves either, the will be done by goreleaser

Be sure to have it installed, also generate a github token and put it in GITHUB_TOKEN variable

Installation

curl -L | sh

Installation

Install Script

Download kleiner and install into a local bin directory.

MacOS, Linux, WSL

Latest version:

curl -L https://raw.githubusercontent.com/can3p/kleiner/main/generated/install.sh | sh

Specific version:

curl -L https://raw.githubusercontent.com/can3p/kleiner/main/generated/install.sh | sh -s 0.0.4

Manual download

Get the archive that fits your system from the Releases page and extract the binary into a folder that is mentioned in your $PATH variable.

Inspiration

The code is inspired a lot and uses parts of the flyctl code. The files with the borrowings mention this explicitly.

License

Apache 2.0

Documentation

Overview

Copyright © 2024 Dmitrii Petrov <dpetroff@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Directories

Path Synopsis
generated
shared

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL