# Library

In your task file import all commands from the taskfile library.

if [[ -d "$HOME/taskfile.build/bin" ]]; then
    for file in "$HOME/taskfile.build/bin/"*; do
        if [[ -f "$file" ]]; then
            source "$file"
        fi
    done
fi

These commands create folder in the directory of the task file and the home directory. Here is an overview of these folders:

• $PWD/tmp: Temporary directory for the task commands.
• $PWD/.prompt: LLM prompts stored as markdown files.
• $HOME/.config/taskfile.build: Default path for storing dotenv files.
• $HOME/.docker/$CONTAINER_REGISTRY: Default path for storing container registry credentials.

# Aliases

Every command in the library has an alias derived from the first letters of each word. For example, commit-with-llm can also be invoked as cwl.

Aliases are appended to each script and pass through arguments:

cwl() {
    commit-with-llm "$@"
}

If two commands would map to the same alias, the alias is extended with additional letters from the first conflicting word until it is unique. Aliases that would shadow standard shell commands (e.g. cd, ls, cp) are also extended to avoid collisions.

# Alias Map

Run list-taskfile-aliases to list all command aliases.

list-taskfile-aliases

av='activate-venv'
agf='add-git-folder'
agm='add-git-merge'
agr='add-git-remote'
aggf='aggregate-git-folders'

# Task

Configure the task enviroment.

OPEN_BROWSER=False # Default: True
TASK_DOTENV_DIR="$HOME/Odoo-Build/config" # Default: "$HOME/.config/taskfile.build"

# clone-taskfile

rows+=("clone-taskfile||Clone the taskfile.build repo.")

# init-project

rows+=("init-project||Setup a taskfile project in the current directory.")

# init-config-dir

rows+=("init-dotenv-dir||Setup task dotenv dir.")

# template-dotenv

rows+=("template-dotenv||Generate .env from .env.template.")

# open-with-os

rows+=("open-with-os||Open file or url with default application.")

# open-url-with-delay

rows+=("open-url-with-delay|[url][delay]|Open url after n seconds.")

# show-dotenv-setup

rows+=("show-dotenv-setup||Show info about the dotenv setup.")

# setup-completion

rows+=("setup-completion|[shell]|Show shell completion instructions.")

# list-taskfile-aliases

rows+=("list-taskfile-aliases||List all library command aliases.")

# Files

Managing files and directories.

# ensure-directory

rows+=("ensure-directory|[path]|Ensure directory path exists.")

# create-symlink

rows+=("create-symlink|[target][source]|Remove existing file/directory and create symlink.")

# create-symlink-files

rows+=("create-symlink-files|[target][source]|Create symlink for files in source pattern.")

# Python

Setup Python virtual enviroment.

# activate-venv

rows+=("activate-venv||Activate or initialize Python virtual env.")

# remove-venv

rows+=("remove-venv||Remove the Python virtual env.")

# Environment

Manage .env files in the task config folder.

TASK_DOTENV_DIR="$HOME/Odoo-Build/config" # Default: "$HOME/.config/taskfile.build"

# create-dotenv

rows+=("create-dotenv|[env][type]|Create .env file of type nextcloud, odoo, upgrade.")

# list-dotenv

rows+=("list-dotenv||List dotenv files.")

# show-dotenv

rows+=("show-dotenv|[env]|Output content of the .env file.")

# copy-dotenv

rows+=("copy-dotenv|[env][env]|dotenv dotenv file.")

# edit-dotenv

rows+=("edit-dotenv|[env]|Open .env file in default editor.")

# load-dotenv

rows+=("load-dotenv|[env]|Load and export .env file.")

# rename-dotenv

rows+=("rename-dotenv|[env][env]|Rename .env file.")

# remove-dotenv

rows+=("remove-dotenv|[env]|Remove .env file.")

# backup-dotenv-files

rows+=("backup-dotenv-files|[path]|Archive and copy .env files to target location.")

# restore-dotenv-files

rows+=("restore-dotenv-files|[path]|Extract and copy .env files from backup file.")

# LLM

Commands that integrate the llm cli.

# commit-with-llm

rows+=("commit-with-llm||Commit with llm generated commit message.")

# update-with-llm

rows+=("update-with-llm|[glob][prompt]|Feed files matching glob to LLM and apply changes.")

The last parameter can be either a direct prompt string or a path to a text file containing the prompt.

# update-changelog-with-llm

rows+=("update-changelog-with-llm||Update CHANGELOG.md with changes from staged git diff using LLM.")

# create-prompt

rows+=("create-prompt|[path]|Create a new prompt file from template.")

# list-prompts

rows+=("list-prompts|[path]|List all prompt files.")

# Logging

Colorful logging in task commands.

# log-error

rows+=("log-error||Colored output for errors.")

# log-success

rows+=("log-success||Colored output for success.")

# log-warning

rows+=("log-warning||Colored output for warnings.")

# Git

These commands replace the git submodule command. The commands store and retrieve additional information from the .gitmodules file.

# add-git-folder

rows+=("add-git-folder|[url][branch][path]|Add git folder to .gitmodules.")

# add-git-merge

rows+=("add-git-merge|[remote][merge][path]|Add git merge ref to git folder in .gitmodules.")

# add-git-remote

rows+=("add-git-remote|[remote][url][path]|Add git remote to git folder.")

# merge-git-remote

rows+=("merge-git-remote|[path]|Merge all remotes and refs defined in .gitmodules.")

# aggregate-git-folders

rows+=("aggregate-git-folders|[path]|Run gitaggregate for the repos.yaml.")

# aggregate-git-folders

rows+=("aggregate-git-folders|[path]|Run gitaggregate for the repos.yaml.")

# commit-git-folder

rows+=("commit-git-folder|[message][path]|Commit all changes of git folders from .gitmodules file.")

# clean-git-folder

rows+=("clean-git-folder|[path]|Clean git folder.")

# checkout-git-folder

rows+=("checkout-git-folder|[branch][path]|Checkout git commit from .gitmodules files.")

# clone-git-folder

rows+=("clone-git-folder|[path]|Clone git folder from .gitmodules file.")

# download-git-folder

rows+=("download-git-folder|[path]|Download git folder from .gitmodules file.")

# find-git-folder

rows+=("find-git-folder|[path]|Find all .git folders in path.")

# generate-ssh-key

rows+=("generate-ssh-key||Generate ssh key pair.")

# list-git-folder

rows+=("list-git-folder|[path]|List path and url of git folders from .gitmodules file.")

# ls-git-folder

rows+=("ls-git-folder|[path]|Space separated list of git folders from .gitmodules file.")

# pull-git-folder

rows+=("pull-git-folder|[branch][path]|Pull all git folders from .gitmodules file.")

# switch-git-folder

rows+=("switch-git-folder|[branch][path]|Switch branch for all git folders from .gitmodules file.")

# sync-git-folder

rows+=("sync-git-folder|[branch][path]|Switch, stash and pull all git folders from .gitmodules file.")

# push-git-folder

rows+=("push-git-folder|[path]|Push all git folders from .gitmodules file.")

# remove-git-folder

rows+=("remove-git-folder|[path]|Remove git folders in path from .gitmodules file.")

# reset-git-folder

rows+=("reset-git-folder|[path]|Abort, rebase and reset git folders from .gitmodules file.")

# run-pre-commit

rows+=("run-pre-commit|[path]|Run pre-commit in path.")

# stage-git-folder

rows+=("stage-git-folder|[path]|Stage all files in git folders from .gitmodules file.")

# status-git-folder

rows+=("status-git-folder|[path]|Show status of git folders from .gitmodules file.")

# save-git-folder

rows+=("save-git-folder||Save commit refs to .gitmodules.")

# update-submodule

rows+=("update-submodule||Update git submodules.")

# Pass

Load and store secrets from pass. The name of the entry will resolve dynamically depending on the current directory / project. Use show-dotenv to show info about the dotenv setup.

# save-dotenv-to-pass

rows+=("save-dotenv-to-pass|[file]|Store content of .env in pass entry.")

# load-dotenv-from-pass

rows+=("load-dotenv-from-pass|[file]|Restore content to .env from pass entry.")

# KeePass

Load and store secrets from KeePassXC. Set path to KeePassXC database and entry:

KEEPASS_DATABASE_FILE="/path/to/database.kdbx"
KEEPASS_DATABASE_KEY_FILE="/path/to/keepass.key"

The name of the entry will resolve dynamically depending on the current directory / project. Use show-dotenv to show info about the dotenv setup.

# save-pass-to-keepass

rows+=("save-pass-to-keepass|[pass][entry]|Store password to KeePass entry.")

# get-pass-from-keepass

rows+=("get-pass-from-keepass|[entry]|Get password from KeePass entry.")

# save-dotenv-to-keepass

rows+=("save-dotenv-to-keepass|[file]|Store content of .env in KeePass entry.")

# load-dotenv-from-keepass

rows+=("load-dotenv-from-keepass|[file]|Restore content to .env from KeePass entry.")

# Kubernetes

Manage kube config files.

# save-kubeconfig-to-pass

rows+=("save-kubeconfig-to-pass|[ctx]|Save kubeconfig file in pass.")

# save-kubeconfig-to-keepass

rows+=("save-kubeconfig-to-keepass|[ctx]|Save kubeconfig file in KeePass.")

# load-kubeconfig-from-pass

rows+=("load-kubeconfig-from-pass|[ctx]|Load kubeconfig file from pass.")

# load-kubeconfig-from-keepass

rows+=("load-kubeconfig-from-keepass|[ctx]|Load kubeconfig file from KeePass.")

# Docker

Build and push Docker images. Set Docker env vars.

BUILDX_PLATFORM="linux/amd64"
CONTAINER_REGISTRY="mintsystem"
CONTAINER_TAG="taskfile.build:latest"
DOCKERFILE="image/Dockerfile"
DOCKER_CONFIG="$HOME/.docker/$CONTAINER_REGISTRY/"

# login-docker

rows+=("login-docker|[user][token]|Run Docker login and create docker config.")

# build-image

rows+=("build-image|[output]|Build Docker image with buildx.")

# Ansible

Install scripts from the Ansible Build project.

The available roles with scripts are listed here: https://ansible.build/scripts.html

# install-ansible-build-scripts

rows+=("install-ansible-build-scripts|[role]|Install scripts of the specified Ansbile role.")