Skip to content

Commit a6c7bcd

Browse files
grokifyclaude
andcommitted
docs: add score-profile command documentation
- Add score-profile to CLI commands table in README.md - Add full score-profile section to docs/reference/cli.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent a05ff23 commit a6c7bcd

2 files changed

Lines changed: 46 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ See [.api-style.yaml.example](.api-style.yaml.example) for a complete example.
141141
| `api-style lint` | Deterministic linting (supports glob patterns, `--watch`, `--recursive`) |
142142
| `api-style evaluate` | LLM-based evaluation |
143143
| `api-style analyze` | Combined lint + evaluate |
144+
| `api-style score-profile` | Score a style profile using LLM evaluation |
144145
| `api-style generate guide` | Generate Markdown documentation |
145146
| `api-style generate mkdocs` | Generate MkDocs multi-page site |
146147
| `api-style generate spectral` | Generate Spectral ruleset |

docs/reference/cli.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,51 @@ api-style analyze openapi.yaml --lint-only
137137

138138
---
139139

140+
### score-profile
141+
142+
Evaluate a style guide profile against quality criteria using LLM-as-a-Judge.
143+
144+
```bash
145+
api-style score-profile <profile-name-or-file> [flags]
146+
```
147+
148+
**Requires:** `ANTHROPIC_API_KEY` environment variable
149+
150+
This command assesses how complete and well-structured a style guide is,
151+
evaluating categories like content coverage, rule quality, examples, and more.
152+
153+
**Arguments:**
154+
155+
| Argument | Description |
156+
|----------|-------------|
157+
| `profile-name-or-file` | Built-in profile name (e.g., `default`, `azure`) or path to a custom profile file |
158+
159+
**Flags:**
160+
161+
| Flag | Short | Default | Description |
162+
|------|-------|---------|-------------|
163+
| `--format` | `-f` | `text` | Output format: `text`, `json` |
164+
| `--output` | `-o` | stdout | Output file path |
165+
| `--model` | `-m` | `claude-3-5-haiku` | LLM model to use |
166+
167+
**Examples:**
168+
169+
```bash
170+
# Score the default profile
171+
api-style score-profile default
172+
173+
# Score Azure profile with JSON output
174+
api-style score-profile azure --format json
175+
176+
# Score a custom profile file
177+
api-style score-profile ./custom-profile.json --output scores.json
178+
179+
# Use a different model
180+
api-style score-profile zalando --model claude-sonnet-4
181+
```
182+
183+
---
184+
140185
### generate
141186

142187
Generate artifacts from a style profile.

0 commit comments

Comments
 (0)