CLIP (Command Line Interface Pages) は、ターミナルコマンドのリファレンスや簡潔な man ページを作成するための構造化 Markdown 仕様です。
ページ構造のレイアウト
# 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}: 1つ以上の反復可能なパス引数。