From e5a8651e57f0e50be1268a311902c6509d3f12b7 Mon Sep 17 00:00:00 2001 From: setop Date: Thu, 2 Feb 2023 10:07:46 +0100 Subject: [PATCH] more entries in the catalog ; more readme and faq --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++----- catalog.yaml | 11 +++++++++++ 2 files changed, 57 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f31d611..c731bf9 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,11 @@ Inspired by envinstall (private), [webinstall](gh:webinstall/webi-installers), [ - [ ] download last release - [ ] from GH release - [ ] install for user - - [ ] from tar.gz + - [ ] in various shapes: + - [ ] from tar.gz + - [ ] exe + - [ ] wheel (python) + - [ ] overriding info from the caralog (repo, version) - [ ] list installed - [ ] identify installed version - [ ] can install itself @@ -47,6 +51,47 @@ Inspired by envinstall (private), [webinstall](gh:webinstall/webi-installers), [ # FAQ +#### What does it do, again ? + +CliGet automates the followingi process: + +1. go to my useful tool website +1. navigate to release section +1. check if it has been updated +1. if so, download, extract, install +1. repeat for all the useful small toos I use +1. repeat periodically + +CliGet has nice defaults, favors convention over configuration, and does its best to "guess" how to get current version numner, get last version number, download last release and install it properly. + +Tools developper / mantainers are not supposed to know CliGet exists. It adapts to the way they deliver thier software. Of course if they use GitHub release and TGZ, it's easier for Cliget to manage :') + +#### so I have to do this process for CliGet ? + +Only the first time. After being installed, CliGet is managed by CliGet. + +#### I already use [asdf](https://asdf-vm.com/), why would I need cliget ? + +asdf is a wonderful tool when it comes to do software development in various programing language while mixing versions from one project to an other. + +But this power comes with some constraints : a plugin has to be developped in order to integrate a new tool to asdf ; And versions of every tool that will be used for a project has to be declared in a config file. + +CliGet does not handle multiversions, tools are deployed for your whole profile. + +In short, if you want to manage development environment, use asfd. If you want to install small tools, use CliGet. They do not conflict, they are complement each other. + +#### I already use the package manager of my OS to install tools, why would I need cliget ? + +Package managers handle dependencies and install software system wide, for all users. Not all sofwares are packaged for all OS distributions because this is hard work for mantainers. So you end up with some softwares not available or not up to date. + +CliGet only install standalone programs, in the user profile (`.local/bin`). It does its best to find the last version and the best way to install the software. The is no need to package for CliGet. + +#### I already use Flatpack, AppImage, Snap to install tools in my profile, why would I need CliGet ? + +These are package managers for the user profile. They come with heavy runtime. And, as classic package manager, not all tools are packaged nor up to date as it requires work from mantainers. + +CliGet does not sandbox, nor manage dependencies but does not any special packaging. + #### I don't want to install python on my machine CliGet is written in Python but packaged as a standalone program with no dependencies except lic and zlib. @@ -61,7 +106,3 @@ CliGet is written in Python but packaged as a standalone program with no depende #### I want this for macos or mswindows Currently only Linux is supported. It shoud work on all unix like OS. For others, contributions are wellcome as long as they do not compicate the tool too much. - - - - diff --git a/catalog.yaml b/catalog.yaml index e1ddbd3..09e8541 100644 --- a/catalog.yaml +++ b/catalog.yaml @@ -1,7 +1,14 @@ +- asdf: + desc: manage developement environments for many languages with multiple concurrent versions + repo: asdf-vm/asdf - bat: desc: a better less +- cliget: + desc: install various tools in your user profile + repo: setop/cliget + - exa: desc: enhanced ls @@ -24,6 +31,10 @@ desc: flatter json to make it greppable repo: tomnomnom/gron +- hishtory: + desc: Better Shell History + repo: ddworken/hishtory + - hx: name: helix desc: text editor, inspired by vim