Commit 95a2a10
authored
cmd: fix help text and examples (#40)
## Description
Fixes help text issues identified in internal testing. No code logic changes — text updates, codegen example fixes, and help improvements.
**Examples fixed:**
- `video create`: replaced non-existent `--avatar-id --script --voice-id` with realistic `--data` JSON
- `video-agent create`: removed non-existent `--style-id`, added `--data` alternative alongside `--prompt`
- `video-translate create`: added `--output-languages` flag example (existing flag, was missing from examples)
- `video-agent sessions resources`: fixed verb from `list` to `get` (singleton endpoint)
**Help text improvements:**
- `--data` flag now documents merge behavior: "When used with individual flags, flags override matching fields in the JSON."
- Root `--help` shows exit codes (0=success, 1=general, 2=usage, 3=auth)
- `completion` command hidden from top-level help via `CompletionOptions.HiddenDefaultCmd`
**Group descriptions:**
- `voice`: "Text-to-speech and voice management" → "Create speech audio and manage voices"
- `webhook`: "Manage webhook endpoints and events" → "Create, list, and manage webhook endpoints and events"
- Implemented via `descriptionOverrides` map in `codegen/grouper.go`
Stacked on PR #39 (spinner).
## Testing
1 new test: `TestGeneratedRoot_Help_ShowsExitCodesAndHidesCompletion` — verifies exit codes in help output and completion command hidden.
Generated files regenerated with `make generate`. Golden files unchanged (examples are not in golden test spec).1 parent a5fcb97 commit 95a2a10
11 files changed
Lines changed: 41 additions & 9 deletions
File tree
- cmd/heygen
- codegen
- examples
- gen
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
147 | 147 | | |
148 | 148 | | |
149 | 149 | | |
150 | | - | |
| 150 | + | |
151 | 151 | | |
152 | 152 | | |
153 | 153 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
130 | 130 | | |
131 | 131 | | |
132 | 132 | | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
133 | 150 | | |
134 | 151 | | |
135 | 152 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| 49 | + | |
49 | 50 | | |
50 | 51 | | |
51 | 52 | | |
| |||
77 | 78 | | |
78 | 79 | | |
79 | 80 | | |
| 81 | + | |
80 | 82 | | |
81 | 83 | | |
82 | 84 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
| 3 | + | |
3 | 4 | | |
4 | 5 | | |
5 | 6 | | |
| |||
9 | 10 | | |
10 | 11 | | |
11 | 12 | | |
12 | | - | |
| 13 | + | |
13 | 14 | | |
14 | 15 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
61 | 66 | | |
62 | 67 | | |
63 | 68 | | |
64 | 69 | | |
65 | 70 | | |
66 | 71 | | |
67 | 72 | | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
68 | 77 | | |
69 | 78 | | |
70 | 79 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments