ultrahope 0.1.3 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/dist/git-ultrahope.js +701 -312
- package/dist/index.js +811 -279
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,6 +39,35 @@ git diff main | ultrahope translate --target pr-intent
|
|
|
39
39
|
git diff --staged | ultrahope translate --target vcs-commit-message --models mistral/ministral-3b,xai/grok-code-fast-1
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
+
### Guide context for commit/message generation
|
|
43
|
+
|
|
44
|
+
In `git ultrahope commit` and `ultrahope jj describe`, you can use `--guide <text>` to provide intent that is not obvious from the diff alone.
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
# Additional guidance for git commit generation
|
|
48
|
+
git add -A && git ultrahope commit --guide "GHSA-gq3j-xvxp-8hrf: override reason"
|
|
49
|
+
|
|
50
|
+
# Additional guidance for jj describe generation
|
|
51
|
+
jj ultrahope describe --guide "GHSA-gq3j-xvxp-8hrf: override reason"
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
In interactive mode for `git ultrahope commit`, `ultrahope jj describe`, and `ultrahope translate --target vcs-commit-message`, use `r` to reroll and `R` (Shift+r) to reroll with additional instructions.
|
|
55
|
+
|
|
56
|
+
#### Difference Between `guide` And Refine Instructions
|
|
57
|
+
|
|
58
|
+
- `--guide`:
|
|
59
|
+
- Supplemental intent outside the diff (for example: ticket ID, background, change intent)
|
|
60
|
+
- `R refine`:
|
|
61
|
+
- Review generated results and enter inline instructions for the next reroll
|
|
62
|
+
- Examples: "more formal", "shorter"
|
|
63
|
+
- Press `Enter` with empty input to clear the previous refine instructions
|
|
64
|
+
- If specified multiple times, the last one overwrites previous values
|
|
65
|
+
- `R` means reroll with additional instructions (`refine`)
|
|
66
|
+
- At request time, refine instructions are merged into `guide` and sent to the API:
|
|
67
|
+
- `--guide` only: `guide = "<guide>"`
|
|
68
|
+
- `R refine` only: `guide = "<refine>"`
|
|
69
|
+
- both: `guide = "<guide>\n\nRefinement: <refine>"`
|
|
70
|
+
|
|
42
71
|
#### Targets
|
|
43
72
|
|
|
44
73
|
- `vcs-commit-message` - Generate a commit message
|