Referencia rápida

Chuleta de sintaxis de páginas CLIP

Guía de referencia rápida de la especificación Command Line Interface Pages (CLIP): estructura de páginas, marcadores de posición y parámetros repetidos.

· Publicado

CLIP (Command Line Interface Pages) es una especificación estructurada en markdown para referencias de comandos de terminal y páginas man simplificadas.

Estructura de la página

# command_name

> Breve descripción de lo que hace el comando.
> Más información: https://example.com/docs

- Descripción de tarea de ejemplo:

`command --option {{argument}}`

Sintaxis de marcadores de posición (Placeholders)

Marcadores de posición primitivos

- Pausar la ejecución de la terminal durante un número determinado de segundos:

`sleep {int seconds: 2}s`

Marcadores para opciones y argumentos repetidos

- Crear un archivo comprimido y guardarlo en disco:

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
  • {int name: default}: Parámetro entero tipado.
  • {option: --flag, -f}: Variante de indicador de línea de comandos.
  • {/?file name: target.tar}: Ruta de archivo opcional.
  • {/?path+ input}: Uno o más argumentos de ruta repetibles.

Referencias

Temas relacionados