Files
fish-config/functions/y.fish
T
rootiest 4c51ef7a33 docs(functions): add # CATEGORY to documented function headers
Records each documented function's manual category in its own header, so
Section 5 can later be generated from source instead of hand-maintained
alongside it. Values reproduce the current grouping in
docs/manual/05-functions/ exactly; no documentation changes meaning here.

Four functions are skipped because they have no header at all yet
(branch, fc, gitup, sudo-toggle); they get one in the merge that follows.
2026-07-26 03:44:03 -04:00

70 lines
1.7 KiB
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# CATEGORY
# 09-clipboard
#
# SYNOPSIS
# y [text...]
#
# DESCRIPTION
# Copies text to the system clipboard using wl-copy (Wayland) or xclip (X11).
# Reads from stdin when no arguments are given.
#
# ARGUMENTS
# text Text to copy; reads from stdin if omitted
#
# RETURNS
# 0 Text copied to clipboard
# 1 No clipboard provider found
#
# EXAMPLE
# y "hello world"
function y --description 'Yank to clipboard'
# Check for help flag
if contains -- -h $argv; or contains -- --help $argv
echo "Usage: y [TEXT] or [COMMAND] | y"
echo ""
echo "Examples:"
echo " y \"hello world\" Copy a string directly"
echo " ls | y Copy output of a command"
echo " y < file.txt Copy contents of a file"
echo " cat file.txt | y Another way to copy a file"
return 0
end
# Determine the clipboard provider
set -l copy_cmd
if type -q wl-copy
set copy_cmd wl-copy
else if type -q xclip
set copy_cmd xclip -selection clipboard
else
echo "Error: No clipboard provider (wl-copy or xclip) found." >&2
return 1
end
# Handle input
if set -q argv[1]
# If arguments are provided, echo them to the clipboard
echo $argv | eval $copy_cmd
else
# If no arguments, read from stdin (pipes/redirects)
eval $copy_cmd
end
end
# SYNOPSIS
# cb [text...]
#
# DESCRIPTION
# Alias for y — copies text to the system clipboard.
#
# ARGUMENTS
# text Text to copy; reads from stdin if omitted
#
# EXAMPLE
# ls | cb
function cb --wraps='y' --description 'Alias cb=y'
y $argv
end