Skip to content

Commit

Permalink
docs: add CLI usage documentation
Browse files Browse the repository at this point in the history
Generates and formats the help documentation for the `llm-cli` command-line interface using Typer and Prettier.
  • Loading branch information
liblaf committed Nov 25, 2024
1 parent 813593c commit 6ad48bd
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
69 changes: 69 additions & 0 deletions docs/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# `llm-cli`

**Usage**:

```console
$ llm-cli [OPTIONS] COMMAND [ARGS]...
```

**Options**:

- `--help`: Show this message and exit.

**Commands**:

- `commit`
- `repo`

## `llm-cli commit`

**Usage**:

```console
$ llm-cli commit [OPTIONS]
```

**Options**:

- `--help`: Show this message and exit.

## `llm-cli repo`

**Usage**:

```console
$ llm-cli repo [OPTIONS] COMMAND [ARGS]...
```

**Options**:

- `--help`: Show this message and exit.

**Commands**:

- `description`
- `topics`

### `llm-cli repo description`

**Usage**:

```console
$ llm-cli repo description [OPTIONS]
```

**Options**:

- `--help`: Show this message and exit.

### `llm-cli repo topics`

**Usage**:

```console
$ llm-cli repo topics [OPTIONS]
```

**Options**:

- `--help`: Show this message and exit.
5 changes: 5 additions & 0 deletions scripts/gen-help.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/bash
set -o errexit -o nounset -o pipefail

typer llm_cli utils docs --output docs/help.md
prettier --write docs/help.md

0 comments on commit 6ad48bd

Please sign in to comment.