get-lem-ai 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,108 @@
+# get-lem-ai 🚀
+
+> **Lem AI Git-Jira Automation Hook**  
+> Automatically generate `Implementation.md` documentation from Jira tickets upon creating new local Git branches.
+
+`get-lem-ai` is a lightweight, stack-agnostic Git hook CLI tool designed to link your local development environment directly to the **Lem AI** knowledge graph. By capturing branch creation transactions, it dynamically fetches issue details, outlines architectural expectations, and generates detailed implementation specifications without delaying your Git checkout flow.
+
+---
+
+## Key Features ⚡
+
+* **Instantaneous Git Checkout:** Spawns a detached background node process so your terminal checkouts proceed instantly without waiting for API responses.
+* **Smart Jira-Key Resolution:** Employs robust pattern-matching regex to extract Jira IDs directly from branch naming conventions (e.g. `feature/PROJ-123-auth`).
+* **Automated Evidence Collection:** Communicates with the Lem AI platform to automatically generate `Implementation.md` files in the root of your project.
+* **SOC 2 & SOP Compliance Guardrail:** Standardizes developmental structure by aligning your branch intent with administrative Jira tickets.
+* **Easy Hook Management:** Single commands to install, configure, or cleanly uninstall hook integrations.
+
+---
+
+## Prerequisites 📋
+
+* **Node.js** (v14.0.0 or higher)
+* **Git** installed and initialized in your workspace (`git init`)
+* **Lem SDK API Key** (obtainable from your Lem workspace developer settings page)
+
+---
+
+## Quick Start Setup Guide 🔧
+
+Follow these three simple steps to integrate `get-lem-ai` into your local development repository:
+
+### Step 1: Install the Package Globally
+Install the package globally via `npm` to expose the global `get-lem-ai` executable commands:
+```bash
+npm install -g get-lem-ai
+```
+
+### Step 2: Configure Your API Profile
+Initialize your configuration by running the wizard. You will be prompted to enter your preferred documentation filename and your secure API key:
+```bash
+get-lem-ai setup
+```
+* **Output filename [Implementation.md]:** Press enter to accept the default or specify a custom documentation path.
+* **SDK API Key:** Paste your secure Lem developer token.
+
+This creates a global configuration saved inside your environment as a local `.lem-ai.json` profile.
+
+### Step 3: Install Hook in Your Git Repository
+Navigate to the root directory of your active local Git project and initialize the hook:
+```bash
+cd /path/to/your/git/repository
+get-lem-ai install
+```
+*This command injects a reference-transaction shell script into `.git/hooks/reference-transaction` designed to capture branch shifts.*
+
+---
+
+## How It Works Under the Hood 🛠️
+
+```
+┌─────────────────┐       ┌───────────────────────────┐       ┌─────────────────┐
+│  git checkout   │ ────> │  reference-transaction   │ ────> │   get-lem-ai    │
+│  -b PROJ-123    │       │  hook intercepts event    │       │   background    │
+└─────────────────┘       └───────────────────────────┘       └────────┬────────┘
+                                                                       │
+                                                                       ▼
+┌─────────────────┐       ┌───────────────────────────┐       ┌─────────────────┐
+│ Write completed │ <──── │   Lem platform returns    │ <──── │   Request API   │
+│ Document file   │       │   context & architecture  │       │  with Jira key  │
+└─────────────────┘       └───────────────────────────┘       └─────────────────┘
+```
+
+1. **Transaction Capture:** The reference-transaction hook triggers whenever local branches are created (using `git branch`, `git checkout -b`, or `git switch -c`).
+2. **Jira Key Extraction:** The tool parses the branch string searching for active Jira keys (e.g. `SOP-42`, `PROJ-999`).
+3. **Decoupled Request:** A detached background worker is spawned with `LEMAI_BG=true` redirecting outputs to `.lem-ai.log`. The parent process exits immediately to prevent terminal blocking.
+4. **Document Generation:** The worker sends the context payload to the Lem AI engine which analyzes the corresponding ticket parameters, synthesizes architectural directions, and compiles a comprehensive `Implementation.md` locally.
+
+---
+
+## Commands Reference 📖
+
+### `get-lem-ai setup`
+Launches the setup prompt wizard to configure your output target file and credentials.
+
+### `get-lem-ai install`
+Safely registers the `reference-transaction` hook inside the current repository's `.git/hooks` folder. If a hook already exists, it intelligently appends or keeps legacy hooks safe.
+
+### `get-lem-ai uninstall`
+Cleans up the workspace by deleting the active git hook and removing the project-level `.lem-ai.json` config profile.
+
+### `get-lem-ai checkout <branchName>`
+The internal entrypoint callback fired by the Git transaction hook. Can also be called manually to dry-run or force generation:
+```bash
+get-lem-ai checkout feature/PROJ-123-api-limits
+```
+
+---
+
+## Troubleshooting & Files 🔍
+
+* **`.lem-ai.json`**: Located in the root of your project or home directory. Contains your secure authorization keys and output targets. **Keep this ignored from public git repositories!**
+* **`.lem-ai.log`**: Standard output log compiled during background runs. If your `Implementation.md` file did not generate, inspect this file to diagnose connection or API authorization issues.
+
+---
+
+## License 📄
+
+This project is licensed under the **MIT License**.

package/bin/cli.js

@@ -7,8 +7,8 @@ const { install, uninstall } = require('../src/install');
 const { checkout } = require('../src/checkout');
 
 program
-  .name('lem-ai')
-  .description('lem-ai — generate Implementation.md on branch creation')
+  .name('get-lem-ai')
+  .description('get-lem-ai — generate Implementation.md on branch creation')
   .version('1.0.0');
 
 program.command('setup').description('Configure webhook URL').action(setup);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "get-lem-ai",
-  "version": "1.0.0",
-  "description": "lem-ai — Automate Implementation.md generation from Jira tickets on branch creation",
+  "version": "1.0.1",
+  "description": "get-lem-ai — Automate Implementation.md generation from Jira tickets on branch creation",
   "main": "src/index.js",
   "bin": {
     "get-lem-ai": "bin/cli.js"
@@ -14,10 +14,10 @@
     "git",
     "hook",
     "jira",
-    "lem-ai",
+    "get-lem-ai",
     "automation"
   ],
-  "author": "lem-ai",
+  "author": "get-lem-ai",
   "license": "MIT",
   "dependencies": {
     "axios": "^1.15.1",

package/src/checkout.js

@@ -15,7 +15,7 @@ async function checkout(branchName) {
   const config = loadConfig();
 
   if (!config) {
-    console.log(chalk.yellow('\n⚠️  Not configured. Run: lem-ai setup\n'));
+    console.log(chalk.yellow('\n⚠️  Not configured. Run: get-lem-ai setup\n'));
     return;
   }
 
@@ -23,9 +23,9 @@ async function checkout(branchName) {
   // PHASE 1: Main Process — Spawn Background Worker & Exit
   // ────────────────────────────────────────────────────────────
   if (!process.env.LEMAI_BG) {
-    console.log(chalk.cyan(`\n[lem-ai] 🚀 Branch detected: ${chalk.bold(branchName)}`));
-    console.log(chalk.gray(`[lem-ai] ⚡ Generating Implementation.md in background...`));
-    console.log(chalk.gray(`[lem-ai] 🏁 Git checkout will proceed instantly.\n`));
+    console.log(chalk.cyan(`\n[get-lem-ai] 🚀 Branch detected: ${chalk.bold(branchName)}`));
+    console.log(chalk.gray(`[get-lem-ai] ⚡ Generating Implementation.md in background...`));
+    console.log(chalk.gray(`[get-lem-ai] 🏁 Git checkout will proceed instantly.\n`));
 
     const gitRoot = findGitRoot(process.cwd()) || process.cwd();
     const logPath = path.join(gitRoot, '.lem-ai.log');

package/src/install.js

@@ -5,7 +5,7 @@ const chalk = require('chalk');
 const { findGitRoot, getConfigPath } = require('./config');
 
 const HOOK_SCRIPT = `#!/bin/sh
-# Injected by lem-ai
+# Injected by get-lem-ai
 # This hook captures all branch creation events (git branch, git checkout -b, git switch -c)
 if [ "$1" = "committed" ]; then
     while read -r old_rev new_rev ref_name; do
@@ -13,7 +13,7 @@ if [ "$1" = "committed" ]; then
         if [ "$old_rev" = "0000000000000000000000000000000000000000" ] && [ "\${ref_name#refs/heads/}" != "$ref_name" ] && [ "$new_rev" != "0000000000000000000000000000000000000000" ]; then
             BRANCH_NAME=\${ref_name#refs/heads/}
             # Run synchronously since we fixed the Node hang issue
-            lem-ai checkout "$BRANCH_NAME"
+            get-lem-ai checkout "$BRANCH_NAME"
         fi
     done
 fi
@@ -46,7 +46,7 @@ async function install() {
     if (fs.existsSync(p)) {
       const content = fs.readFileSync(p, 'utf-8');
       if (content.includes('git-jira-hook') || content.includes('getlem') || content.includes('lem')) {
-        if (h === 'reference-transaction' && content.includes('Injected by lem-ai')) {
+        if (h === 'reference-transaction' && (content.includes('Injected by lem-ai') || content.includes('Injected by get-lem-ai'))) {
           // This is current, skip
           continue;
         }
@@ -84,12 +84,12 @@ function uninstall() {
     const content = fs.readFileSync(hookPath, 'utf-8');
     if (content.includes('lem-ai') || content.includes('getlem') || content.includes('lem') || content.includes('git-jira-hook')) {
       fs.unlinkSync(hookPath);
-      console.log(chalk.green('\n✅  lem-ai Git Hook uninstalled successfully.\n'));
+      console.log(chalk.green('\n✅  get-lem-ai Git Hook uninstalled successfully.\n'));
     } else {
-      console.log(chalk.yellow('\n⚠️   Hook at this path was not created by lem-ai. Skipping.\n'));
+      console.log(chalk.yellow('\n⚠️   Hook at this path was not created by get-lem-ai. Skipping.\n'));
     }
   } else {
-    console.log(chalk.gray('\nℹ️   No lem-ai hook found to uninstall.\n'));
+    console.log(chalk.gray('\nℹ️   No get-lem-ai hook found to uninstall.\n'));
   }
 
   // Also remove the project-level config file if it exists

package/src/setup.js

@@ -9,7 +9,7 @@ function ask(rl, question) {
 
 async function setup() {
   const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
-  console.log(chalk.cyan('\n🔧  lem-ai Setup\n'));
+  console.log(chalk.cyan('\n🔧  get-lem-ai Setup\n'));
 
   const outputFile = await ask(rl, 'Output filename [Implementation.md]: ') || 'Implementation.md';
   const apiKey = await ask(rl, 'SDK API Key (from Lem settings): ');
@@ -21,7 +21,7 @@ async function setup() {
   });
 
   console.log(chalk.green('\n✅  Config saved to .lem-ai.json'));
-  console.log(chalk.yellow('👉  Now cd into a git repo and run: lem-ai install\n'));
+  console.log(chalk.yellow('👉  Now cd into a git repo and run: get-lem-ai install\n'));
 }
 
 module.exports = { setup };