From 0ef5e720630a2bb32dcebf60b8d42427cdbc3e9c Mon Sep 17 00:00:00 2001 From: kaotisk Date: Tue, 18 Mar 2025 02:11:08 +0200 Subject: Brief documentation of ak-pkg in README --- README | 50 +++++++++++++++++++++++++++++++++++++++----------- bin/ak-pkg | 5 +++-- 2 files changed, 42 insertions(+), 13 deletions(-) diff --git a/README b/README index 1551146..a1878fe 100644 --- a/README +++ b/README @@ -169,6 +169,7 @@ Utilities - ak-gpg # Return your GPG key as IPFS CID - ak-network # Network Tools (connect to, scan for, dump peers) - ak-node-info # Returns IPFS CID or IPNS key for your online config + - ak-pkg # Package manager - ak-sblock # sblock tools - ak-schain # schain tools - ak-zblock # zblock tools @@ -329,16 +330,43 @@ FS tools ```bash $ ak fs --help +# ak-fs - AKFS tools +# ================== +# +# Tools to add, get and cat files to/from the Arching Kaos File System +# +# Usage: +# +# -h, --help Prints this help message +# --add, --import Adds/Imports a file to the AKFS system +# --get, --export Exports a file from the AKFS system +# --cat Concatenates from given hash +# --list Lists names and roots available +# --net-cat-from-map Concatenates from map via the network +# --net-get-from-map Downloads from map via the network +# --cfm Concatenates from map +# --gfm Get file from map +# +``` -Tools to add, get and cat files to/from the Arching Kaos File System - -Usage: - - -h, --help Prints this help message - - --add, --import Adds/Imports a file to the AKFS system - - --get, --export Exports a file from the AKFS system +Package manager +--------------- + - ak-pkg - --cat Concatenates from given hash -``` +```bash +$ ak pkg --help +# ak-pkg - Package Manager +# ======================== +# +# Manager of packages that can be installed and run as modules invoking the +# `ak -m ` sequence. +# +# Usage: +# +# -h, --help Prints this help message +# --make-releases-from-local Makes releases from all local installation's module +# --make-release-from-local Makes release from a local installation's module +# --install-from-zblock Installs from a zblock +# --install-from-akfs Installs from an AKFS map +# --uninstall Uninstalls a module selected from a menu +# diff --git a/bin/ak-pkg b/bin/ak-pkg index 12d5d26..971aab6 100755 --- a/bin/ak-pkg +++ b/bin/ak-pkg @@ -18,7 +18,8 @@ ### along with this program. If not, see . ### ## -## Brief description +## Manager of packages that can be installed and run as modules invoking the +## `ak -m ` sequence. ## ## Usage: ## @@ -31,7 +32,7 @@ ## fullprogrampath="$(realpath $0)" PROGRAM=$(basename $0) -descriptionString="Quick description" +descriptionString="Package Manager" # At least these source $AK_LIBDIR/_ak_log -- cgit v1.2.3