eckra 1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to eckra
+
+Thank you for your interest in contributing to eckra! This guide will help you get started with the development environment and understand the project structure.
+
+## 🚀 Getting Started
+
+### Prerequisites
+- **Node.js**: Version 14.0.0 or higher.
+- **Git**: Installed and configured on your system.
+- **LM Studio** (Optional): For AI-powered features, ensure LM Studio is running and accessible (default: `http://localhost:1234`).
+
+### Setup
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/eckra.git
+   cd eckra
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Run in development mode:
+   ```bash
+   npm start
+   ```
+
+## 🧪 Testing
+
+We use **Jest** for testing. To run the tests:
+
+```bash
+npm test
+```
+
+Please ensure that all tests pass before submitting a pull request. Adding new tests for new features is highly encouraged.
+
+## 🏗 Architecture
+
+The project is structured into three main layers:
+
+### 1. Entry Point (`src/index.js`)
+Handles CLI command definitions using `commander`. It routes commands to the appropriate UI or helper functions.
+
+### 2. UI Layer (`src/ui/`)
+Responsible for all user interactions.
+- **`app.js`**: The main application loop and dashboard menu.
+- **`common.js`**: Shared styles, icons, and UI utility functions (like `clear`, `header`, `box`).
+- **`modules/`**: Contains individual feature modules. Each module (e.g., `commit.js`, `status.js`) handles a specific git flow.
+
+#### UI Module Pattern
+Most UI modules follow this pattern:
+```javascript
+async function doFeature(info) {
+  // 1. Clear screen and show header
+  clear();
+  header();
+  
+  // 2. Perform logic or ask questions via inquirer
+  const { choice } = await inquirer.prompt([...]);
+  
+  // 3. Execute git/helper operations
+  // 4. Show results/feedback
+}
+```
+
+### 3. Helpers (`src/helpers/`)
+Core business logic separated from the UI.
+- **`git.js`**: Wraps `simple-git` for all Git operations.
+- **`ai.js`**: Handles communication with AI providers (like LM Studio) for suggestions.
+- **`config.js`**: Manages user configuration.
+- **`patch.js`**: Utilities for handling git patches and diffs.
+
+## 🎨 Style Guide
+
+- Use the styles defined in `src/ui/common.js` (e.g., `s.primary`, `s.success`) to maintain visual consistency.
+- Prefer `inquirer` for interactive prompts.
+- Keep UI logic in `src/ui/modules` and Git/AI logic in `src/helpers`.
+
+## 📝 Pull Request Process
+
+1. Create a new branch for your feature or bugfix.
+2. Make your changes and add tests if applicable.
+3. Ensure `npm test` passes.
+4. Commit your changes with a clear and descriptive message.
+5. Submit a pull request!

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eren Çakar
+
+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

@@ -0,0 +1,109 @@
+# Eckra
+
+Eckra is a command-line interface (CLI) for Git repository management. It provides an interactive terminal interface for standard Git operations and integrates with Large Language Models (LLMs) to automate the generation of commit messages.
+
+<p align="center">
+  <img src="screenshot.jpg" alt="Eckra Interface" width="800">
+</p>
+
+## Overview
+
+The tool is designed to streamline version control workflows by providing a structured interface for staging, committing, and branch management. It supports integration with local LLM providers such as LM Studio and Ollama, as well as cloud-based services including OpenAI and Anthropic.
+
+## Core Features
+
+- **Automated Commit Generation**: Uses git diff data to generate contextually relevant commit messages via configured AI providers.
+- **Interactive Status Management**: Provides a visual interface for viewing repository status and staging changes.
+- **Partial Staging**: Supports the selection of specific file hunks for staging.
+- **Branch Management**: Tools for creating, deleting, and switching branches, including ahead/behind tracking.
+- **Conflict Resolution**: Structured workflow for resolving merge conflicts.
+- **History Visualization**: Renders commit history and branch graphs within the terminal.
+
+## Installation
+
+### Prerequisites
+
+- Node.js (version 14.0.0 or higher)
+- Git
+
+### Setup from Source
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/sudoeren/eckra.git
+   cd eckra
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   npm install
+   ```
+
+3. Link the application globally:
+   ```bash
+   npm link
+   ```
+
+## Usage
+
+Execute the primary command within a Git repository to launch the dashboard:
+
+```bash
+eckra
+```
+
+### Direct Commands
+
+The tool also supports direct access to specific modules:
+
+- `eckra status`: Open the status and staging interface.
+- `eckra commit`: Initiate the AI-assisted commit flow.
+- `eckra push`: Push changes to the remote repository.
+
+## AI Integration
+
+Eckra can be configured to use various AI backends for commit message generation.
+
+| Provider  | Endpoint               | Use Case                               |
+| :-------- | :--------------------- | :------------------------------------- |
+| LM Studio | http://localhost:1234  | Local inference and privacy            |
+| Ollama    | http://localhost:11434 | Local inference (Llama, Mistral, etc.) |
+| OpenAI    | API                    | Cloud-based GPT models                 |
+| Anthropic | API                    | Cloud-based Claude models              |
+
+## Configuration
+
+Configuration is managed through JSON files. The application follows a cascading priority:
+
+1.  **Global Configuration**: Located at `~/.eckra/config.json`.
+2.  **Local Configuration**: Defined in a `.eckrarc` file within the project root.
+
+### Configuration Example
+
+```json
+{
+  "aiProvider": "ollama",
+  "ollamaModel": "llama3",
+  "aiInstruction": "Ensure commit messages follow Conventional Commits specification."
+}
+```
+
+## Development and Testing
+
+The project uses Jest for unit testing. To execute the test suite:
+
+```bash
+npm test
+```
+
+## License
+
+This project is licensed under the MIT License.
+
+---
+
+<p align="center">
+  Developed by <b>Eren Çakar</b>
+</p>

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "eckra",
+  "version": "1.0.0",
+  "description": "AI-powered Git management CLI with LM Studio integration for smart commit messages",
+  "main": "src/index.js",
+  "bin": {
+    "eckra": "./src/index.js"
+  },
+  "scripts": {
+    "start": "node src/index.js",
+    "test": "jest"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "verbose": true
+  },
+  "keywords": [
+    "git",
+    "cli",
+    "ai",
+    "commit",
+    "lm-studio",
+    "version-control"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.2",
+    "boxen": "^5.1.2",
+    "chalk": "^4.1.2",
+    "cli-table3": "^0.6.3",
+    "commander": "^11.1.0",
+    "inquirer": "^8.2.6",
+    "ora": "^5.4.1",
+    "simple-git": "^3.21.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "devDependencies": {
+    "jest": "^30.2.0"
+  }
+}

package/src/helpers/ai.js

@@ -0,0 +1,240 @@
+const axios = require("axios");
+const { getConfig } = require("./config");
+
+/**
+ * Call the selected AI provider
+ */
+async function callProvider(provider, messages, temperature = 0.3, max_tokens = 100) {
+  const config = getConfig();
+  let url, headers, body;
+
+  switch (provider) {
+    case "openai":
+      url = "https://api.openai.com/v1/chat/completions";
+      headers = {
+        "Content-Type": "application/json",
+        "Authorization": `Bearer ${config.openaiApiKey}`,
+      };
+      body = {
+        model: config.openaiModel || "gpt-4o",
+        messages,
+        temperature,
+        max_tokens,
+      };
+      break;
+
+    case "anthropic":
+      url = "https://api.anthropic.com/v1/messages";
+      headers = {
+        "Content-Type": "application/json",
+        "x-api-key": config.anthropicApiKey,
+        "anthropic-version": "2023-06-01",
+      };
+      // Anthropic messages format is slightly different (system is a separate field)
+      const systemMessage = messages.find(m => m.role === "system")?.content;
+      const userMessages = messages.filter(m => m.role !== "system");
+      body = {
+        model: config.anthropicModel || "claude-3-5-sonnet-20240620",
+        system: systemMessage,
+        messages: userMessages,
+        max_tokens,
+        temperature,
+      };
+      break;
+
+    case "ollama":
+      url = `${config.ollamaUrl || "http://localhost:11434"}/api/chat`;
+      headers = { "Content-Type": "application/json" };
+      body = {
+        model: config.ollamaModel || "llama3",
+        messages,
+        temperature,
+        stream: false,
+      };
+      break;
+
+    case "lmstudio":
+    default:
+      url = `${config.lmStudioUrl || "http://localhost:1234"}/v1/chat/completions`;
+      headers = { "Content-Type": "application/json" };
+      body = {
+        model: config.model,
+        messages,
+        temperature,
+        max_tokens,
+        stream: false,
+      };
+      break;
+  }
+
+  try {
+    const response = await axios.post(url, body, { headers, timeout: 30000 });
+    
+    let content = "";
+    if (provider === "anthropic") {
+      content = response.data.content[0].text;
+    } else if (provider === "ollama") {
+      content = response.data.message.content;
+    } else {
+      content = response.data.choices[0].message.content;
+    }
+
+    return content.trim();
+  } catch (error) {
+    if (error.response) {
+      throw new Error(`AI Provider Error (${provider}): ${error.response.status} - ${JSON.stringify(error.response.data)}`);
+    }
+    throw error;
+  }
+}
+
+/**
+ * Generate commit message using the configured AI provider
+ */
+async function generateCommitMessage(diff, filesList) {
+  const config = getConfig();
+  const instructionText = config.aiInstruction 
+    ? `\nIMPORTANT USER INSTRUCTION: ${config.aiInstruction}\n` 
+    : "";
+
+  const prompt = `You are a Git commit message generator. Based on the following changes${config.aiInstruction ? " and the user instruction" : ""}, create a short, descriptive commit message in Conventional Commits format.
+${instructionText}
+Conventional Commits format:
+- feat: A new feature
+- fix: A bug fix
+- docs: Documentation only changes
+- style: Changes that do not affect the code (whitespace, formatting, missing semicolons, etc.)
+- refactor: Code change that neither fixes a bug nor adds a feature
+- perf: Code change that improves performance
+- test: Adding missing tests or correcting existing tests
+- chore: Changes to the build process or auxiliary tools
+
+Changed files:
+${filesList.join("\n")}
+
+Diff:
+${diff.substring(0, 3000)}
+
+Write only the commit message, do not add any other explanation. The message should be in English and should not exceed 72 characters.`;
+
+  const messages = [
+    {
+      role: "system",
+      content: "You are a helpful assistant that generates concise and meaningful Git commit messages following Conventional Commits specification.",
+    },
+    {
+      role: "user",
+      content: prompt,
+    },
+  ];
+
+  let message = await callProvider(config.aiProvider, messages, 0.3, 100);
+  
+  // Clean up the message
+  message = message.replace(/^["']|["']$/g, "");
+  message = message.split("\n")[0]; // Take only first line
+  return message;
+}
+
+/**
+ * Generate multiple commit message suggestions
+ */
+async function generateCommitSuggestions(diff, filesList, count = 3, instruction = null) {
+  const config = getConfig();
+  const activeInstruction = instruction || config.aiInstruction;
+  
+  let instructionText = "";
+  if (activeInstruction) {
+    instructionText = `\nIMPORTANT USER INSTRUCTION: ${activeInstruction}\n`;
+  }
+
+  const prompt = `You are a Git commit message generator. Based on the following changes${activeInstruction ? " and the user instruction" : ""}, suggest ${count} different commit messages. Each should be in Conventional Commits format.
+${instructionText}
+Changed files:
+${filesList.join("\n")}
+
+Diff:
+${diff.substring(0, 3000)}
+
+Write ${count} different commit messages, each on a new line. Write only the messages, do not add numbers or explanations.`;
+
+  const messages = [
+    {
+      role: "system",
+      content: "You are a helpful assistant that generates concise and meaningful Git commit messages.",
+    },
+    {
+      role: "user",
+      content: prompt,
+    },
+  ];
+
+  try {
+    const content = await callProvider(config.aiProvider, messages, 0.7, 200);
+    
+    // Clean backtick blocks
+    let cleanedContent = content.replace(/```[\s\S]*?```/g, "");
+    cleanedContent = cleanedContent.replace(/`/g, "");
+
+    const suggestions = cleanedContent
+      .split("\n")
+      .map((line) => {
+        let cleaned = line
+          .replace(/^\d+[\.)\-:]\s*/, "") // Remove numbers
+          .replace(/^[-*]\s*/, "") // Remove list markers
+          .replace(/^["']|["']$/g, "") // Remove quotes
+          .trim();
+        return cleaned;
+      })
+      .filter((line) => line.length > 5 && !line.startsWith("```"))
+      .slice(0, count);
+
+    if (suggestions.length === 0) {
+      return ["chore: update files", "refactor: improve code", "feat: add changes"];
+    }
+
+    return suggestions;
+  } catch (error) {
+    return ["chore: update files", "refactor: improve code", "feat: add changes"];
+  }
+}
+
+/**
+ * Check if the configured AI provider is available
+ */
+async function checkAIConnection() {
+  const config = getConfig();
+  const provider = config.aiProvider || "lmstudio";
+
+  try {
+    if (provider === "lmstudio") {
+      const response = await axios.get(`${config.lmStudioUrl}/v1/models`, { timeout: 5000 });
+      return { connected: true, models: response.data?.data || [] };
+    } else if (provider === "ollama") {
+      const response = await axios.get(`${config.ollamaUrl}/api/tags`, { timeout: 5000 });
+      return { connected: true, models: response.data?.models || [] };
+    } else if (provider === "openai") {
+      if (!config.openaiApiKey) return { connected: false, error: "OpenAI API Key is missing" };
+      // Simple check by listing models
+      const response = await axios.get("https://api.openai.com/v1/models", {
+        headers: { "Authorization": `Bearer ${config.openaiApiKey}` },
+        timeout: 5000
+      });
+      return { connected: true, models: response.data?.data || [] };
+    } else if (provider === "anthropic") {
+        if (!config.anthropicApiKey) return { connected: false, error: "Anthropic API Key is missing" };
+        return { connected: true, note: "Anthropic connection assumed (listing models not supported via simple GET)" };
+    }
+    return { connected: true };
+  } catch (error) {
+    return { connected: false, error: error.message };
+  }
+}
+
+module.exports = {
+  generateCommitMessage,
+  generateCommitSuggestions,
+  checkAIConnection,
+  // Alias for backward compatibility
+  checkLMStudioConnection: checkAIConnection,
+};

package/src/helpers/config.js

@@ -0,0 +1,122 @@
+const fs = require("fs");
+const path = require("path");
+const os = require("os");
+
+const CONFIG_DIR = path.join(os.homedir(), ".eckra");
+const CONFIG_FILE = path.join(CONFIG_DIR, "config.json");
+const LOCAL_CONFIG_FILENAME = ".eckrarc";
+
+const DEFAULT_CONFIG = {
+  aiProvider: "lmstudio",
+  lmStudioUrl: "http://localhost:1234",
+  openaiApiKey: "",
+  openaiModel: "gpt-4o",
+  anthropicApiKey: "",
+  anthropicModel: "claude-3-5-sonnet-20240620",
+  ollamaUrl: "http://localhost:11434",
+  ollamaModel: "llama3",
+  model: "git-commit-message/unsloth.Q4_K_M.gguf",
+  language: "en",
+  autoStage: false,
+  autoPush: false,
+  commitPrefix: true,
+  aiInstruction: "Use concise, present tense, and descriptive language. Focus on the 'why' of the changes.",
+};
+
+/**
+ * Ensure config directory exists
+ */
+function ensureConfigDir() {
+  if (!fs.existsSync(CONFIG_DIR)) {
+    fs.mkdirSync(CONFIG_DIR, { recursive: true });
+  }
+}
+
+/**
+ * Find local configuration file in current or parent directories
+ */
+function findLocalConfig(startDir = process.cwd()) {
+  let currentDir = startDir;
+  while (currentDir !== path.parse(currentDir).root) {
+    const localPath = path.join(currentDir, LOCAL_CONFIG_FILENAME);
+    if (fs.existsSync(localPath)) {
+      return localPath;
+    }
+    currentDir = path.dirname(currentDir);
+  }
+  // Check root
+  const rootLocalPath = path.join(currentDir, LOCAL_CONFIG_FILENAME);
+  if (fs.existsSync(rootLocalPath)) {
+    return rootLocalPath;
+  }
+  return null;
+}
+
+/**
+ * Get current configuration
+ */
+function getConfig() {
+  ensureConfigDir();
+
+  let config = { ...DEFAULT_CONFIG };
+
+  // 1. Global config
+  if (fs.existsSync(CONFIG_FILE)) {
+    try {
+      const globalData = fs.readFileSync(CONFIG_FILE, "utf8");
+      config = { ...config, ...JSON.parse(globalData) };
+    } catch (error) {
+      // Silently ignore errors
+    }
+  }
+
+  // 2. Local config (overrides global)
+  const localConfigPath = findLocalConfig();
+  if (localConfigPath) {
+    try {
+      const localData = fs.readFileSync(localConfigPath, "utf8");
+      config = { ...config, ...JSON.parse(localData) };
+    } catch (error) {
+      // Silently ignore errors
+    }
+  }
+
+  return config;
+}
+
+/**
+ * Save configuration
+ */
+function saveConfig(config) {
+  ensureConfigDir();
+
+  const currentConfig = getConfig();
+  const newConfig = { ...currentConfig, ...config };
+
+  fs.writeFileSync(CONFIG_FILE, JSON.stringify(newConfig, null, 2));
+  return newConfig;
+}
+
+/**
+ * Reset configuration to defaults
+ */
+function resetConfig() {
+  ensureConfigDir();
+  fs.writeFileSync(CONFIG_FILE, JSON.stringify(DEFAULT_CONFIG, null, 2));
+  return DEFAULT_CONFIG;
+}
+
+/**
+ * Get config file path
+ */
+function getConfigPath() {
+  return CONFIG_FILE;
+}
+
+module.exports = {
+  getConfig,
+  saveConfig,
+  resetConfig,
+  getConfigPath,
+  DEFAULT_CONFIG,
+};