Files
fish-config/functions/cheat.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

34 lines
683 B
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# CATEGORY
# 14-miscellaneous
#
# DEPENDENCIES
# cheat, tldr, man
#
# SYNOPSIS
# cheat <topic> [args...]
#
# DESCRIPTION
# Displays colorized cheatsheets using cheat -c. Falls back to tldr, then
# man, if cheat is not installed.
#
# ARGUMENTS
# topic The command or topic to look up
# args... Additional arguments forwarded to cheat, tldr, or man
#
# EXAMPLE
# cheat tar
# cheat git
function cheat --wraps='cheat' --description 'alias cheat=cheat -c'
if type -q cheat
command cheat -c $argv
else if type -q tldr
tldr $argv
else
man $argv
end
end