Skip to content

Commit

Permalink
docs: update CLI command references to use 'ai' instead of 'ai-cli'
Browse files Browse the repository at this point in the history
- Standardizes the command references across the documentation to reflect the new CLI name 'ai'
- Adds a new `--long / --no-long` option to the `ai repo description` command
  • Loading branch information
liblaf committed Nov 30, 2024
1 parent 53b7d9d commit 06bc78a
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions docs/help.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# `ai-cli`
# `ai`

**Usage**:

```console
ai-cli [OPTIONS] COMMAND [ARGS]...
ai [OPTIONS] COMMAND [ARGS]...
```

**Options**:
Expand All @@ -15,12 +15,12 @@ ai-cli [OPTIONS] COMMAND [ARGS]...
- `commit`
- `repo`

## `ai-cli commit`
## `ai commit`

**Usage**:

```console
ai-cli commit [OPTIONS] [PATH]...
ai commit [OPTIONS] [PATH]...
```

**Arguments**:
Expand All @@ -34,12 +34,12 @@ ai-cli commit [OPTIONS] [PATH]...
- `--model TEXT`
- `--help`: Show this message and exit.

## `ai-cli repo`
## `ai repo`

**Usage**:

```console
ai-cli repo [OPTIONS] COMMAND [ARGS]...
ai repo [OPTIONS] COMMAND [ARGS]...
```

**Options**:
Expand All @@ -51,25 +51,26 @@ ai-cli repo [OPTIONS] COMMAND [ARGS]...
- `description`
- `topics`

### `ai-cli repo description`
### `ai repo description`

**Usage**:

```console
ai-cli repo description [OPTIONS]
ai repo description [OPTIONS]
```

**Options**:

- `--long / --no-long`: [default: no-long]
- `--model TEXT`
- `--help`: Show this message and exit.

### `ai-cli repo topics`
### `ai repo topics`

**Usage**:

```console
ai-cli repo topics [OPTIONS]
ai repo topics [OPTIONS]
```

**Options**:
Expand Down

0 comments on commit 06bc78a

Please sign in to comment.