@nueldotdev/amnesiac 1.0.0 → 1.0.2

package/.npmignore

@@ -6,6 +6,7 @@
 !lib/
 !package.json
 !README.md
+!CHANGELOG.md
 !LICENSE
 
 # Ignore config, test, and local files

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 2026-01-21 — v1.0.2
+
+### Added
+
+*   **Changelog Preview & Edit:** Introduced a new `--dry-run` option allowing users to preview and edit generated changelog entries before saving them.
+*   **Changelog Save Recovery:** Implemented a recovery mechanism to persist generated changelog content locally if saving fails.
+*   **Git Status & Diff Command:** Added a new `show-git` command with `--status` and `--diff` options to display the current Git repository status or changes directly from the CLI.
+*   **New Dependencies:** Added `open` and `update-notifier` for future enhancements and version notifications.
+
+### Changed
+
+*   **Refactored Changelog Generation:** The `generateDocs` function now returns the generated changelog entry instead of directly writing it to a file, providing more control over the saving process.
+*   **Improved Configuration Loading:** Enhanced `loadConfig` to better manage active profiles and ensure CLI options correctly override existing configurations.
+*   **Git Status JSDoc:** Added detailed JSDoc comments to the `getStatus` function in `lib/git.js` for improved code clarity.
+
+## 2025-10-03 — v1.0.1
+
+- Default model updated: Now uses `gemini-2.5-flash` by default to align with the latest Gemini API.
+
+

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 nueldotdev:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -23,6 +23,7 @@ Amnesiac is a CLI tool for keeping track of what’s changed in your code. It lo
   - [Getting Your API Key](#getting-your-api-key)
   - [Keeping Your API Key Secure](#keeping-your-api-key-secure)
   - [Understanding Gemini Models](#understanding-gemini-models)
+ - [Changelog](#changelog)
 
 ## Features
 
@@ -40,7 +41,7 @@ To install Amnesiac, you will first need to have [Node.js](https://nodejs.org/)
 Then, you can install Amnesiac globally via npm:
 
 ```bash
-npm install -g amnesiac
+npm install -g @nueldotdev/amnesiac
 ```
 
 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
 To update your globally installed Amnesiac to the latest version, simply run:
 
 ```bash
-npm update -g amnesiac
+npm update -g @nueldotdev/amnesiac
 ```
 
 ## Getting Started
@@ -79,6 +80,29 @@ npm update -g amnesiac
     - Receive a concise changelog entry.
     - Prepend the new entry to your `CHANGELOG.md` file (or the file specified in your config).
 
+### Preview/edit workflow (recommended)
+
+If you want to review and tweak the generated entry before it is written to your changelog, use `--dry-run`:
+
+```bash
+amnesiac --dry-run
+```
+
+This flow will:
+
+- Open a temporary `.md` file containing the generated entry in your default editor
+- Let you edit it
+- Ask you to confirm before saving it to your changelog
+
+**Important (Windows/editor note):** some editors don't allow the CLI to reliably detect when the file is closed. After you edit the temp file, **save it in your editor (Ctrl+S)**, then return to the terminal and press Enter when prompted.
+
+### Safety: backups and recovery
+
+When saving to your changelog file, Amnesiac writes safely:
+
+- If a changelog file already exists, it may create a best-effort backup alongside it (e.g. `CHANGELOG.md.bak.<timestamp>`).
+- If saving fails (permissions/locked file/etc.), Amnesiac will write a **recovery copy** to your OS temp directory and print the path so you don't lose the generated/edited entry.
+
 ## Configuration & Profiles
 
 Amnesiac offers a flexible configuration system that allows you to manage settings at different levels: per-project, globally, or as a one-off CLI override.
@@ -100,7 +124,7 @@ You can create an `amnesiac.config.js` file in the root of your project to defin
 ```javascript
 export default {
   apiKey: process.env.GEMINI_API_KEY, // Can be sourced from environment variables
-  model: "gemini-1.5-pro",
+  model: "gemini-2.5-flash",
   outputFile: "PROJECT_CHANGELOG.md",
   prompt: `
   Generate a comprehensive changelog entry focusing on new features and bug fixes for this project.
@@ -121,8 +145,20 @@ The main command to generate a changelog entry. It uses the configuration determ
 ```bash
 amnesiac
 amnesiac -p "Custom prompt for this run" # Override prompt for a single run
-amnesiac -m "gemini-pro" # Override model for a single run
+amnesiac -m "gemini-2.5-flash" # Override model for a single run
 amnesiac -u work # Use 'work' profile for a single run
+amnesiac -d # Preview/edit in your editor before saving
+```
+
+### `amnesiac show-git`
+
+Display the current Git status or diff for the repository you are currently in.
+
+**Usage:**
+
+```bash
+amnesiac show-git --status
+amnesiac show-git --diff
 ```
 
 ### `amnesiac init`
@@ -220,9 +256,13 @@ Your API key is a sensitive credential. Treat it like a password:
 
 ### Understanding Gemini Models
 
-The `model` parameter (e.g., `gemini-1.5-flash`, `gemini-1.5-pro`) determines which Gemini model Amnesiac uses for content generation.
+The `model` parameter (e.g., `gemini-2.5-flash`, `gemini-2.5-pro`) determines which Gemini model Amnesiac uses for content generation.
 
--   **`gemini-1.5-flash`:** A faster, more cost-effective model, suitable for many common tasks. This is the default.
--   **`gemini-1.5-pro`:** A more capable model for complex tasks, offering higher quality but potentially at a higher latency or cost.
+-   **`gemini-2.5-flash`:** A faster, more cost-effective model, suitable for many common tasks. This is the default.
+-   **`gemini-2.5-pro`:** A more capable model for complex tasks, offering higher quality but potentially at a higher latency or cost.
 
 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.
+
+## Changelog
+
+See full history in [CHANGELOG.md](./CHANGELOG.md).

package/bin/cli.js

@@ -6,6 +6,7 @@ import os from "os";
 import inquirer from "inquirer";
 import { generateDocs } from "../lib/doc_generator.js";
 import { loadConfig } from "../lib/config.js";
+import { previewAndEditChangelog, saveChangelogEntry, persistRecoveryCopy } from "../lib/display.js";
 import { readFileSync } from 'fs';
 
 const program = new Command();
@@ -26,7 +27,7 @@ program
     const localConfigPath = path.resolve(process.cwd(), "amnesiac.config.js");
     const defaultConfigContent = `export default {
   apiKey: process.env.GEMINI_API_KEY || "", // Consider adding a placeholder for API key
-  model: "gemini-1.5-flash",
+  model: "gemini-2.5-flash",
   outputFile: "CHANGELOG.md",
   prompt: \`
 You are an assistant that generates clean, developer-friendly changelog entries.
@@ -113,6 +114,41 @@ program
     }
   });
 
+
+program
+  .command("show-git")
+  .option("-s, --status", "Display the status of the files within the repository")
+  .option("-d, --diff", "Display the changes within the files of the repository")
+  .description("Display the current status or changes in your Git repository")
+  .action(async (options) => {
+    // Only allow one of --status or --diff at a time
+    if (options.status && options.diff) {
+      console.error("\n❌ You can only use one of --status or --diff at a time.\n");
+      process.exit(1);
+    }
+    if (!options.status && !options.diff) {
+      console.error("\n❌ Please specify either --status or --diff.\n");
+      process.exit(1);
+    }
+
+    try {
+      if (options.status) {
+        const { getStatus } = await import('../lib/git.js');
+        const statusStr = await getStatus();
+        console.log("\n--- Git Status ---\n" + statusStr + "\n");
+      } else if (options.diff) {
+        const { getDiff } = await import('../lib/git.js');
+        const { displayChanges } = await import('../lib/display.js');
+        const diffStr = await getDiff();
+        await displayChanges(diffStr);
+      }
+    } catch (error) {
+      console.error(`\n❌ An error occurred while displaying git info: ${error.message}`);
+      process.exit(1);
+    }
+  });
+
+
 program
   .command("config")
   .description("Set up or edit Amnesiac config")
@@ -200,7 +236,7 @@ program
           type: "input",
           name: "model",
           message: "Enter model name:",
-          default: existingConfig.model || "gemini-1.5-flash",
+          default: existingConfig.model || "gemini-2.5-flash",
         },
         {
           type: "input",
@@ -258,19 +294,62 @@ program
     }
   });
 
-program
+  program
+  .option("-d, --dry-run", "Preview and edit before saving")
   .option("-u, --use <profile>", "Use a specific profile for this run")
   .option("-p, --prompt <text>", "Override prompt")
   .option("-m, --model <name>", "Override model")
-  // Future: .option("-u, --use <profile>", "Use specific profile")
   .action(async (opts) => {
     try {
       const config = await loadConfig(opts);
-      await generateDocs(config);
+      const changelogEntry = await generateDocs(config);
+      
+      if (!changelogEntry) {
+        return; // No changes detected
+      }
+
+      if (opts.dryRun) {
+        // Preview and let user edit/confirm
+        console.log("\n🔄 Previewing changelog entry. \nYou can review and edit before saving");
+        const { content, shouldSave, wasModified } = await previewAndEditChangelog(changelogEntry);
+
+        if (shouldSave) {
+          let savedPath;
+          try {
+            savedPath = saveChangelogEntry(config, content);
+          } catch (e) {
+            const recoveryPath = persistRecoveryCopy(content, "save_failed");
+            console.error(`\n❌ Failed to save changelog: ${e.message}`);
+            console.error(`✅ Your generated entry was saved for recovery at: ${recoveryPath}\n`);
+            process.exit(1);
+          }
+
+          if (wasModified) {
+            console.log(`✅ Your edited changelog has been saved to ${savedPath}`);
+          } else {
+            console.log(`✅ Changelog updated at ${savedPath}`);
+          }
+        } else {
+          console.log("❌ Changelog not saved.");
+        }
+      } else {
+        // No preview, just save
+        console.log("🔄 Saving changelog entry...");
+        let savedPath;
+        try {
+          savedPath = saveChangelogEntry(config, changelogEntry);
+        } catch (e) {
+          const recoveryPath = persistRecoveryCopy(changelogEntry, "save_failed");
+          console.error(`\n❌ Failed to save changelog: ${e.message}`);
+          console.error(`✅ Your generated entry was saved for recovery at: ${recoveryPath}\n`);
+          process.exit(1);
+        }
+        console.log(`✅ Changelog updated at ${savedPath}`);
+      }
     } catch (error) {
       console.error(`\n❌ An error occurred: ${error.message}`);
       process.exit(1);
     }
   });
 
-program.parse(process.argv);
+program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nueldotdev/amnesiac",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A command-line tool to automatically generate documentation for recent codebase changes using the Gemini API.",
   "keywords": [
     "cli-tool",
@@ -34,6 +34,8 @@
     "@google/generative-ai": "^0.24.1",
     "commander": "^14.0.1",
     "inquirer": "^12.9.6",
-    "simple-git": "^3.28.0"
+    "open": "^11.0.0",
+    "simple-git": "^3.28.0",
+    "update-notifier": "^7.3.1"
   }
-}
+}