eckra 1.0.0 → 1.0.2

package/README.md

@@ -1,109 +1,72 @@
-# 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>
+# Eckra
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sudoeren/eckra/master/screenshot.jpg" alt="eckra terminal preview" width="800">
+</p>
+
+<p align="center">
+  <strong>The AI-powered Git CLI that turns "working on stuff" into meaningful commits.</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/eckra"><img src="https://img.shields.io/badge/npm-v1.0.2-blue.svg?style=flat-square" alt="NPM Version"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/npm/l/eckra.svg?style=flat-square" alt="License"></a>
+</p>
+
+---
+
+## 💡 Overview
+
+**eckra** is an interactive Git management tool designed for developers who value both speed and clarity. By integrating with local LLMs via **LM Studio**, it analyzes your staged changes and suggests context-aware commit messages, ensuring your project history remains professional and descriptive without the manual overhead.
+
+## 🚀 Key Features
+
+- **🤖 AI-Powered Suggestions**: Automatically generates commit messages based on actual code diffs using LM Studio.
+- **📝 Select & Edit**: Pick an AI suggestion and refine it instantly to match your specific needs.
+- **🔍 Staged Diff Review**: Inspect your changes in a beautiful, syntax-highlighted format directly before committing.
+- **🎯 Interactive Dashboard**: A comprehensive menu system for staging files, managing branches, stashing changes, and syncing with remotes.
+- **⚡ Built for Speed**: Zero-config required for standard Git operations. Fast, responsive, and intuitive.
+
+## 📦 Installation
+
+Install eckra globally using npm:
+
+```bash
+npm install -g eckra
+```
+
+## 🛠 Usage
+
+Just type `eckra` in any Git repository to launch the interactive dashboard:
+
+```bash
+eckra
+```
+
+### Quick Commands
+
+Skip the menu and jump straight into action:
+
+| Command        | Action                                        |
+| :------------- | :-------------------------------------------- |
+| `eckra commit` | Start the AI-assisted commit flow             |
+| `eckra status` | Check repository status and staged files      |
+| `eckra push`   | Sync local commits with the remote repository |
+| `eckra branch` | Open the interactive branch manager           |
+
+## ⚙️ AI Configuration
+
+By default, eckra connects to **LM Studio**'s local server:
+
+- **URL**: `http://localhost:1234`
+- **Requirement**: Ensure LM Studio is running and the "Local Server" is started with a loaded model.
+
+## 🤝 Contributing
+
+Contributions make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+
+## 📄 License
+
+Distributed under the MIT License. See `LICENSE` for more information.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eckra",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "AI-powered Git management CLI with LM Studio integration for smart commit messages",
   "main": "src/index.js",
   "bin": {

package/src/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const { Command } = require("commander");
 const { startApp, quickStatus, quickCommit, quickPush } = require("./ui/app");
@@ -21,7 +21,7 @@ async function checkGitRepo() {
 program
   .name("eckra")
   .description("AI-powered Git management CLI")
-  .version("1.0.0");
+  .version("1.0.2");
 
 program
   .command("start")

package/src/ui/modules/about.js

@@ -0,0 +1,37 @@
+const boxen = require("boxen");
+const chalk = require("chalk");
+const packageJson = require("../../../package.json");
+const { clear, pause } = require("../common");
+
+async function doAbout() {
+  clear();
+
+  const content = [
+    chalk.cyan.bold("E C K R A"),
+    chalk.white("AI-Powered Git Assistant"),
+    chalk.gray(`version ${packageJson.version}`),
+    "",
+    chalk.dim("Developed by"),
+    chalk.cyan("Eren Çakar"),
+    "",
+    chalk.blue("https://github.com/sudoeren/eckra"),
+    chalk.blue("https://www.npmjs.com/package/eckra"),
+    "",
+    chalk.dim("License: MIT"),
+  ].join("\n");
+
+  console.log(
+    boxen(content, {
+      padding: { top: 1, bottom: 1, left: 4, right: 4 },
+      margin: 1,
+      borderStyle: "round",
+      borderColor: "cyan",
+      textAlignment: "center",
+      minWidth: 50,
+    }),
+  );
+
+  await pause();
+}
+
+module.exports = { doAbout };

package/src/ui/modules/more.js

@@ -12,6 +12,7 @@ const { doBlame } = require("./blame");
 const { doWorktree } = require("./worktree");
 const { doSettings } = require("./settings");
 const { doRebase } = require("./rebase");
+const { doAbout } = require("./about");
 
 async function doMore() {
   clear();
@@ -42,6 +43,7 @@ async function doMore() {
         { name: s.text("  🌳 Worktrees"), value: "worktree" },
         { type: "separator", line: " " },
         { name: s.text("  ⚙ Settings"), value: "settings" },
+        { name: s.text("  ℹ About"), value: "about" },
         { name: s.muted("  ← Main Menu"), value: "back" },
       ],
       pageSize: 15,
@@ -88,6 +90,9 @@ async function doMore() {
     case "settings":
       await doSettings();
       break;
+    case "about":
+      await doAbout();
+      break;
   }
 }
 

package/src/ui/modules/tag.js

@@ -1,6 +1,11 @@
 const inquirer = require("inquirer");
 const ora = require("ora");
-const { listTags, createTag, deleteTag, pushTags } = require("../../helpers/git");
+const {
+  listTags,
+  createTag,
+  deleteTag,
+  pushTags,
+} = require("../../helpers/git");
 const { s, header, clear, pause, sleep } = require("../common");
 
 async function doTag() {
@@ -39,7 +44,7 @@ async function doTag() {
       {
         type: "input",
         name: "name",
-        message: s.muted("Tag name (e.g. v1.0.0):"),
+        message: s.muted("Tag name (e.g. v1.0.2):"),
         validate: (v) => v.length > 0,
       },
     ]);