@nueldotdev/amnesiac 1.0.0 → 1.0.1
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/.npmignore +1 -0
- package/CHANGELOG.md +5 -0
- package/LICENSE +21 -0
- package/README.md +12 -7
- package/bin/cli.js +2 -2
- package/package.json +2 -2
package/.npmignore
CHANGED
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 nueldotdev:
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -23,6 +23,7 @@ Amnesiac is a CLI tool for keeping track of what’s changed in your code. It lo
|
|
|
23
23
|
- [Getting Your API Key](#getting-your-api-key)
|
|
24
24
|
- [Keeping Your API Key Secure](#keeping-your-api-key-secure)
|
|
25
25
|
- [Understanding Gemini Models](#understanding-gemini-models)
|
|
26
|
+
- [Changelog](#changelog)
|
|
26
27
|
|
|
27
28
|
## Features
|
|
28
29
|
|
|
@@ -40,7 +41,7 @@ To install Amnesiac, you will first need to have [Node.js](https://nodejs.org/)
|
|
|
40
41
|
Then, you can install Amnesiac globally via npm:
|
|
41
42
|
|
|
42
43
|
```bash
|
|
43
|
-
npm install -g amnesiac
|
|
44
|
+
npm install -g @nueldotdev/amnesiac
|
|
44
45
|
```
|
|
45
46
|
|
|
46
47
|
This will make the `amnesiac` command available from any directory in your terminal.
|
|
@@ -50,7 +51,7 @@ This will make the `amnesiac` command available from any directory in your termi
|
|
|
50
51
|
To update your globally installed Amnesiac to the latest version, simply run:
|
|
51
52
|
|
|
52
53
|
```bash
|
|
53
|
-
npm update -g amnesiac
|
|
54
|
+
npm update -g @nueldotdev/amnesiac
|
|
54
55
|
```
|
|
55
56
|
|
|
56
57
|
## Getting Started
|
|
@@ -100,7 +101,7 @@ You can create an `amnesiac.config.js` file in the root of your project to defin
|
|
|
100
101
|
```javascript
|
|
101
102
|
export default {
|
|
102
103
|
apiKey: process.env.GEMINI_API_KEY, // Can be sourced from environment variables
|
|
103
|
-
model: "gemini-
|
|
104
|
+
model: "gemini-2.5-flash",
|
|
104
105
|
outputFile: "PROJECT_CHANGELOG.md",
|
|
105
106
|
prompt: `
|
|
106
107
|
Generate a comprehensive changelog entry focusing on new features and bug fixes for this project.
|
|
@@ -121,7 +122,7 @@ The main command to generate a changelog entry. It uses the configuration determ
|
|
|
121
122
|
```bash
|
|
122
123
|
amnesiac
|
|
123
124
|
amnesiac -p "Custom prompt for this run" # Override prompt for a single run
|
|
124
|
-
amnesiac -m "gemini-
|
|
125
|
+
amnesiac -m "gemini-2.5-flash" # Override model for a single run
|
|
125
126
|
amnesiac -u work # Use 'work' profile for a single run
|
|
126
127
|
```
|
|
127
128
|
|
|
@@ -220,9 +221,13 @@ Your API key is a sensitive credential. Treat it like a password:
|
|
|
220
221
|
|
|
221
222
|
### Understanding Gemini Models
|
|
222
223
|
|
|
223
|
-
The `model` parameter (e.g., `gemini-
|
|
224
|
+
The `model` parameter (e.g., `gemini-2.5-flash`, `gemini-2.5-pro`) determines which Gemini model Amnesiac uses for content generation.
|
|
224
225
|
|
|
225
|
-
- **`gemini-
|
|
226
|
-
- **`gemini-
|
|
226
|
+
- **`gemini-2.5-flash`:** A faster, more cost-effective model, suitable for many common tasks. This is the default.
|
|
227
|
+
- **`gemini-2.5-pro`:** A more capable model for complex tasks, offering higher quality but potentially at a higher latency or cost.
|
|
227
228
|
|
|
228
229
|
You can specify the model in your global or local configurations, or override it for a single run using `amnesiac -m <model_name>`. Refer to the [Gemini API documentation](https://ai.google.dev/models/gemini) for the latest information on available models and their capabilities.
|
|
230
|
+
|
|
231
|
+
## Changelog
|
|
232
|
+
|
|
233
|
+
See full history in [CHANGELOG.md](./CHANGELOG.md).
|
package/bin/cli.js
CHANGED
|
@@ -26,7 +26,7 @@ program
|
|
|
26
26
|
const localConfigPath = path.resolve(process.cwd(), "amnesiac.config.js");
|
|
27
27
|
const defaultConfigContent = `export default {
|
|
28
28
|
apiKey: process.env.GEMINI_API_KEY || "", // Consider adding a placeholder for API key
|
|
29
|
-
model: "gemini-
|
|
29
|
+
model: "gemini-2.5-flash",
|
|
30
30
|
outputFile: "CHANGELOG.md",
|
|
31
31
|
prompt: \`
|
|
32
32
|
You are an assistant that generates clean, developer-friendly changelog entries.
|
|
@@ -200,7 +200,7 @@ program
|
|
|
200
200
|
type: "input",
|
|
201
201
|
name: "model",
|
|
202
202
|
message: "Enter model name:",
|
|
203
|
-
default: existingConfig.model || "gemini-
|
|
203
|
+
default: existingConfig.model || "gemini-2.5-flash",
|
|
204
204
|
},
|
|
205
205
|
{
|
|
206
206
|
type: "input",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nueldotdev/amnesiac",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "A command-line tool to automatically generate documentation for recent codebase changes using the Gemini API.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"cli-tool",
|
|
@@ -36,4 +36,4 @@
|
|
|
36
36
|
"inquirer": "^12.9.6",
|
|
37
37
|
"simple-git": "^3.28.0"
|
|
38
38
|
}
|
|
39
|
-
}
|
|
39
|
+
}
|