@johnowennixon/diffdash 1.2.1 → 1.4.0
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 +17 -9
- package/dist/package.json +1 -1
- package/dist/src/lib_tui_block.js +2 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
A command-line tool to generate Git commit messages using AI.
|
|
4
4
|
|
|
5
|
+
|
|
6
|
+
|
|
5
7
|
## Features
|
|
6
8
|
|
|
7
9
|
* Generates Git commit messages in natural English
|
|
@@ -21,11 +23,26 @@ A command-line tool to generate Git commit messages using AI.
|
|
|
21
23
|
npm install -g @johnowennixon/diffdash
|
|
22
24
|
```
|
|
23
25
|
|
|
26
|
+
## LLM Models
|
|
27
|
+
|
|
28
|
+
Currently, for this application, the best LLM model by far is **gpt-4.1-mini** from OpenAI.
|
|
29
|
+
It is set as the default model.
|
|
30
|
+
I can only presume they have done a ton of training on diffs.
|
|
31
|
+
|
|
24
32
|
## API Keys
|
|
25
33
|
|
|
26
34
|
DiffDash requires at least one API key for an LLM provider. These must be provided as environment variables.
|
|
27
35
|
|
|
28
36
|
```bash
|
|
37
|
+
# For OpenAI (recommended)
|
|
38
|
+
export OPENAI_API_KEY=your-api-key
|
|
39
|
+
|
|
40
|
+
# For Requesty
|
|
41
|
+
export REQUESTY_API_KEY=your-api-key
|
|
42
|
+
|
|
43
|
+
# For OpenRouter
|
|
44
|
+
export OPENROUTER_API_KEY=your-api-key
|
|
45
|
+
|
|
29
46
|
# For Anthropic
|
|
30
47
|
export ANTHROPIC_API_KEY=your-api-key
|
|
31
48
|
|
|
@@ -34,15 +51,6 @@ export DEEPSEEK_API_KEY=your-api-key
|
|
|
34
51
|
|
|
35
52
|
# For Google Gemini
|
|
36
53
|
export GEMINI_API_KEY=your-api-key
|
|
37
|
-
|
|
38
|
-
# For OpenAI
|
|
39
|
-
export OPENAI_API_KEY=your-api-key
|
|
40
|
-
|
|
41
|
-
# For Requesty
|
|
42
|
-
export REQUESTY_API_KEY=your-api-key
|
|
43
|
-
|
|
44
|
-
# For OpenRouter
|
|
45
|
-
export OPENROUTER_API_KEY=your-api-key
|
|
46
54
|
```
|
|
47
55
|
|
|
48
56
|
## Usage
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { BOX_DRAWINGS_LIGHT_HORIZONTAL } from "./lib_char_box.js";
|
|
2
2
|
import { SPACE } from "./lib_char_punctuation.js";
|
|
3
3
|
import { tui_justify_centre } from "./lib_tui_justify.js";
|
|
4
|
-
export function tui_block_string({ teller, content, title, pad_char = BOX_DRAWINGS_LIGHT_HORIZONTAL,
|
|
4
|
+
export function tui_block_string({ teller, content, title, pad_char = BOX_DRAWINGS_LIGHT_HORIZONTAL, fallback_width = 80, }) {
|
|
5
|
+
const width = process.stdout.isTTY ? process.stdout.columns : fallback_width;
|
|
5
6
|
const separator = pad_char.repeat(width);
|
|
6
7
|
const top_line = title ? tui_justify_centre({ line: SPACE + title + SPACE, width, pad_char }) : separator;
|
|
7
8
|
teller(top_line);
|