Análisis de flags y argumentos con getopts

Todo script del mundo real acaba necesitando aceptar opciones como -v, -o output.txt o -n 5. Analizarlas manualmente con $1, $2… se vuelve frágil enseguida.

getopts es el comando integrado estándar de POSIX que gestiona de forma fiable las opciones cortas (-a, -b), incluidas las que reciben un argumento. Está integrado en todos los shells POSIX, por lo que no requiere dependencias.

• Gestiona indicadores combinados: -vn 5 = -v -n 5
• Informa de las opciones desconocidas correctamente
• Establece automáticamente las variables estándar OPTIND y OPTARG

En esta lección creará desde cero una CLI completa y profesional con getopts.

La sintaxis básica consiste en un bucle while que llama a getopts en cada iteración:

while getopts "optstring" varname; do
  case "$varname" in
    ...
  esac
done

• optstring — cadena que enumera cada letra de opción aceptada. Los dos puntos después de una letra indican que esa opción requiere un argumento.
• varname — recibe la letra de la opción actual en cada iteración.
• OPTARG — se establece automáticamente con el valor del argumento cuando hay dos puntos después de la letra.
• OPTIND — índice del siguiente argumento que se procesará; después del bucle, use shift $((OPTIND - 1)) para dejar disponibles los parámetros posicionales restantes.

El optstring es una declaración compacta del contrato de su CLI. Cada carácter representa un indicador aceptado.

• 'abc' — acepta -a, -b y -c (sin argumentos)
• 'a:bc' — -a requiere un argumento; -b y -c no lo requieren
• ':abc' — los dos puntos iniciales activan el modo de error silencioso (el script gestiona las opciones incorrectas en lugar de que el shell muestre un mensaje)

El modo silencioso es preferible en los scripts de producción porque le proporciona control total sobre los mensajes de error y los códigos de salida.

Cuando un indicador va seguido de dos puntos en el optstring, getopts almacena su valor en OPTARG. El usuario puede escribir el argumento con o sin espacio:

• -o report.txt
• -oreport.txt

Ambas formas se analizan de manera idéntica. Esta es una de las principales ventajas frente al análisis manual con $1/shift.

En el modo silencioso (con ':' al principio del optstring), si falta un argumento, getopts establece varname en : y OPTARG en la letra de la opción, lo que resulta perfecto para mostrar un mensaje de error específico.

Cuando getopts termina, OPTIND contiene el índice del primer argumento que no es una opción. Use shift para eliminar todas las opciones procesadas, de modo que $1, $2… hagan referencia a los parámetros posicionales restantes (por ejemplo, los nombres de archivo).

La forma habitual es siempre:

shift $((OPTIND - 1))

Después del desplazamiento, $@ contiene únicamente los argumentos que no eran indicadores: los operandos de su comando.

Un script profesional siempre proporciona una función usage() que muestra un mensaje de ayuda y termina. La convención es:

• Mostrarlo en stderr (fd 2) para no contaminar la salida redirigida mediante tuberías
• Salir con el código 0 para -h / --help y con el código 1 para un uso no válido
• Llamar a usage 1 en las rutas de error y a usage 0 en el gestor de -h

Después del análisis, valide las entradas y establezca los valores predeterminados antes de realizar cualquier trabajo real. Mantenga separadas la fase de análisis (el bucle) y la fase lógica. Esto facilita la lectura y las pruebas de ambas secciones.

• Use ${VAR:-default} para establecer valores predeterminados en línea
• Valide los argumentos numéricos con una expresión regular o una comprobación aritmética
• Compruebe que las opciones obligatorias se hayan proporcionado realmente

getopts gestiona automáticamente los indicadores cortos combinados escritos sin espacios, según la convención estándar de Unix:

• -v -q equivale a -vq
• -n 5 -v equivale a -n5 -v o -vn5

No necesita escribir código adicional para admitir esta sintaxis: getopts recorre automáticamente cada carácter de una cadena de opciones combinadas. Esta es otra razón importante para usar getopts en lugar del análisis manual.

Los comandos de Unix aceptan -- (dos guiones) como señal explícita para detener el procesamiento de opciones. Todo lo que aparece después de -- se trata como un argumento posicional, aunque parezca un indicador.

getopts se detiene automáticamente cuando encuentra --. Después de shift $((OPTIND - 1)), los dos guiones desaparecen y $@ contiene únicamente los operandos.

Esto es importante para los scripts que operan con nombres de archivo que podrían comenzar por un guion, por ejemplo:

myscript.sh -v -- -strangefile.txt

En los scripts modulares, puede encapsular getopts dentro de una función parse_args() que establezca variables globales (o variables nameref). Esto mantiene main() limpio y permite cargar el analizador desde otros scripts.

Reglas principales de este patrón:

• Declare las variables de las opciones antes de llamar a la función
• Use variables global o pase los valores mediante nameref (declare -n)
• Devuelva un código de salida distinto de cero si la entrada no es válida, para que main pueda reaccionar

A continuación se muestra un script completo del mundo real que utiliza todo lo visto en esta lección: un optstring con argumentos obligatorios, el modo de error silencioso, una función de uso, valores predeterminados, validación y el desplazamiento de OPTIND.

Estudie la estructura: es la plantilla que debe seguir en cualquier script que escriba y que necesite una interfaz CLI.

Lea la siguiente llamada a getopts y elija la descripción correcta de su comportamiento:

while getopts ':f:vq' opt; do

Ha aprendido a crear interfaces profesionales de línea de comandos en Bash mediante getopts. Estos son los puntos clave:

• Sintaxis de optstring — las letras sin dos puntos son indicadores booleanos; los dos puntos después de una letra indican que requiere un argumento; los dos puntos iniciales activan el modo de error silencioso.
• OPTARG — contiene automáticamente el valor del argumento de las opciones que requieren uno.
• OPTIND — use shift $((OPTIND - 1)) después del bucle para dejar disponibles los parámetros posicionales restantes en $@.
• Modo de error silencioso — preferido en producción; gestione usted mismo los casos : (argumento ausente) y \? (opción desconocida) para tener un control total.
• Función usage() — escríbala siempre; muestre el mensaje en stderr, salga con 0 para -h y con 1 para los errores.
• Indicadores combinados — getopts gestiona automáticamente -vq y -n5 sin código adicional.
• Patrón modular — envuelva getopts en una función parse_args() para crear scripts limpios y reutilizables.

Dominar getopts transforma sus scripts de herramientas de propósito único en programas CLI fiables y fáciles de usar que siguen las convenciones de Unix.