Files
fish-config/functions/dockup.fish
T
Claude fceddfc43f docs: add DEPENDENCIES sections to function doc headers
Documents what each function needs for full functionality -- other
repo functions it calls, and external CLI tools it uses or falls
back gracefully without (e.g. rm/trash, ls/eza+lsd) -- matching the
existing CLASSIFICATION convention's placement and the ~20 functions
that already carried this label.

Also broadens verify-manual.py's dependency-resolution check to
recognize this repo's other existence-check idioms (command -q,
command -v, which -- not just type -q) and dng2avif's dynamic
type -q $cmd loop, since several genuine dependencies (eza, lsd,
fastfetch, fd, ps, ...) are only ever guarded that way.
2026-09-22 22:22:27 -04:00

85 lines
2.4 KiB
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# CATEGORY
# 14-miscellaneous
#
# DEPENDENCIES
# docker
#
# CLASSIFICATION
# network
#
# SYNOPSIS
# dockup [-h] [directory]
#
# DESCRIPTION
# Pulls the latest Docker images and restarts all services in a Docker Compose
# project, then prunes dangling images. Accepts an optional target directory.
#
# ARGUMENTS
# -h, --help Show help message
# directory Path to the compose project (defaults to current directory)
#
# EXIT STATUS
# 0 Services updated and running
# 1 Directory not found or no docker-compose.yml present
#
# EXAMPLE
# dockup ~/myapp
function dockup --description 'Pull and restart docker compose containers'
# Define colors
set -l clr_error (set_color red)
set -l clr_info (set_color -b blue white)
set -l clr_success (set_color green)
set -l clr_off (set_color normal)
# Handle help flags
if contains -- -h $argv; or contains -- --help $argv
__fish_palette
echo "$c_head""Usage:$c_reset $c_cmd""dockup$c_reset $c_arg""[DIRECTORY]$c_reset"
echo ""
echo "$c_head""Options:$c_reset"
echo " $c_flag-h$c_reset, $c_flag--help$c_reset Show this help message"
echo ""
echo "$c_head""Arguments:$c_reset"
echo " $c_arg""DIRECTORY$c_reset Optional path to the compose project (defaults to current dir)"
return 0
end
# Handle directory navigation
if count $argv >/dev/null
set -l target_dir $argv[1]
if test -d $target_dir
pushd $target_dir >/dev/null
else
echo $clr_error"Error: Directory '$target_dir' not found."$clr_off
return 1
end
end
# Check for compose file
if not test -f docker-compose.yml -o -f docker-compose.yaml
echo $clr_error"Error: No docker-compose.yml found in "(pwd)$clr_off
if count $argv >/dev/null
popd >/dev/null
end
return 1
end
# Execution
echo $clr_info" UPDATING "$clr_off" Containers in "(set_color -o)(pwd)$clr_off"..."
if docker compose pull && docker compose up -d --remove-orphans
echo $clr_success"✔ Upgrade complete!"$clr_off
docker image prune -f
else
echo $clr_error"✘ Upgrade failed."$clr_off
end
# Cleanup directory state
if count $argv >/dev/null
popd >/dev/null
end
end