Skip to content

Commit fe3d1e5

Browse files
authored
docs: add supported AI providers section (#27)
Documents that the --ai flag accepts any stdin→stdout CLI and provides a table of common providers (Amp, Claude, OpenAI, Gemini, Ollama) with their commands, required secrets, and install instructions.
1 parent 9e278b0 commit fe3d1e5

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Or download directly from [GitHub Releases](https://github.com/wevm/changelogs-r
8686
|---------|-------------|
8787
| `init` | Initialize `.changelog/` directory |
8888
| `add` | Create a new changelog interactively |
89-
| `add --ai "claude -p"` | Generate changelog using AI |
89+
| `add --ai "<command>"` | Generate changelog using AI (see [Supported AI Providers](#supported-ai-providers)) |
9090
| `status` | Show pending changelogs and releases |
9191
| `version` | Apply version bumps and update changelogs |
9292
| `publish` | Publish unpublished packages to crates.io |
@@ -129,6 +129,29 @@ Added new feature X that does Y.
129129
Fixed bug Z in the parser.
130130
```
131131

132+
## Supported AI Providers
133+
134+
The `--ai` flag and GitHub Action `ai` input accept any CLI command that reads from stdin and outputs text. The diff is piped to the command, and the output becomes the changelog entry.
135+
136+
| Provider | Command | Required Secret | Install |
137+
|----------|---------|-----------------|---------|
138+
| Amp | `amp -x` | `AMP_API_KEY` | `npm install -g @sourcegraph/amp` |
139+
| Claude Code | `claude -p` | `ANTHROPIC_API_KEY` | `npm install -g @anthropic-ai/claude-code` |
140+
| OpenAI | `openai api chat.completions.create -m gpt-4o` | `OPENAI_API_KEY` | `pip install openai` |
141+
| Gemini | `gemini` | `GOOGLE_API_KEY` | `npm install -g @anthropic-ai/gemini-cli` |
142+
143+
144+
### Examples
145+
146+
```bash
147+
# Using Amp
148+
changelogs add --ai "amp -x"
149+
150+
# Using Claude
151+
changelogs add --ai "claude -p"
152+
153+
```
154+
132155
## GitHub Actions
133156

134157
### Auto-generate Changelogs on PRs

0 commit comments

Comments
 (0)