Referência rápida

Folha de Dicas de Sintaxe de Páginas CLIP

Guia de referência rápida para Command Line Interface Pages (CLIP): layout de páginas, marcadores de comando e parâmetros repetíveis.

· Publicado

CLIP (Command Line Interface Pages) é uma especificação estruturada em Markdown para referências de comandos de terminal e páginas man simplificadas.

Estrutura da Página

# command_name

> Breve descrição explicando o que o comando faz.
> Mais informações: https://example.com/docs

- Descrição de tarefa de exemplo:

`command --option {{argument}}`

Sintaxe de Marcadores (Placeholders)

Marcadores Primitivos

- Pausar execução do terminal por um número definido de segundos:

`sleep {int seconds: 2}s`

Marcadores de Opções e Argumentos Repetidos

- Criar um arquivo compactado e gravá-lo no disco:

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
  • {int name: default}: Parâmetro inteiro tipado.
  • {option: --flag, -f}: Variante de opção de linha de comando.
  • {/?file name: target.tar}: Caminho de arquivo opcional.
  • {/?path+ input}: Um ou mais argumentos de caminho repetíveis.

Referências

Temas relacionados