CLIP (Command Line Interface Pages) is a structured markdown specification for terminal command references and simplified man pages.
Page Structure Layout
# command_name
> Short description explaining what the command does.
> More information: https://example.com/docs
- Example task description:
`command --option {{argument}}`
Placeholder Syntax
Primitive Placeholders
- Pause terminal execution for a given number of [s]econds:
`sleep {int seconds: 2}s`
Option & Repeated Argument Placeholders
- Create an archive and write it to a file:
`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
{int name: default}: Typed integer parameter.{option: --flag, -f}: Command line flag variant.{/?file name: target.tar}: Optional file path.{/?path+ input}: One or more repeatable path arguments.