CLIP (Command Line Interface Pages) — это структурированная спецификация Markdown для справочников команд терминала и упрощенных страниц man.
Макет структуры страницы
# command_name
> Краткое описание функциональности команды.
> Дополнительная информация: https://example.com/docs
- Пример описания задачи:
`command --option {{argument}}`
Синтаксис плейсхолдеров (Placeholder Syntax)
Примитивные плейсхолдеры
- Приостановить выполнение терминала на указанное количество секунд:
`sleep {int seconds: 2}s`
Плейсхолдеры опций и повторяемых аргументов
- Создать архив и записать его в файл:
`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
{int name: default}: Типизированный целочисленный параметр.{option: --flag, -f}: Вариант флага командной строки.{/?file name: target.tar}: Необязательный путь к файлу.{/?path+ input}: Один или несколько повторяемых путей.