Skip to content

Commit

Permalink
Add Command Line Interface Pages (CLIP) page syntax examples (rstacru…
Browse files Browse the repository at this point in the history
…z#1953)

* Add CLIP page syntax examples

* Update urls

* Fix errors
  • Loading branch information
Emily Grace Seville authored Mar 13, 2023
1 parent cc9f243 commit ab9ab48
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions clip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Command Line Interface Pages
category: CLI
layout: 2017/sheet
tags: [Featured]
updated: 2023-02-23
keywords:
- CLI
---

### Page layout

```md
# command

> Some command description
> More information: https://some/link/to/url

- Some code description:

`command argument1 argument2`
```

### [Primitive placeholders](https://github.com/command-line-interface-pages/syntax/blob/main/type-specific/cli.md#primitive-placeholders)

```md
- Delay in [s]econds:

`sleep {int seconds: 2}s`
```

### [Primitive repeated placeholders](https://github.com/command-line-interface-pages/syntax/blob/main/type-specific/cli.md#repeated-primitive-placeholders)

```md
- [c]reate an archive and write it to a [f]ile:

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
```

### Also see
{: .-one-column}

* [Render](https://github.com/command-line-interface-pages/v2-tooling/tree/main/clip-view)
* [Page's repository](https://github.com/command-line-interface-pages/cli-pages)
* [Syntax](https://github.com/command-line-interface-pages/syntax/blob/main/base.md)

0 comments on commit ab9ab48

Please sign in to comment.