@riflo/ryte 1.1.1 → 1.1.3

package/README.md

@@ -12,22 +12,22 @@
 
 ![RYTE Demo](demo.gif)
 
-## Introduction
+Writing meaningful commit messages shouldn't feel like extra work. But in fast-paced teams, it often does. 
 
-Writing meaningful commit messages and well-structured Pull Requests is critical for team collaboration, but it’s often a friction point in a fast-paced development cycle. 
-
-**ryte** is your CLI companion that **bridges** the gap between "coding" and "documenting". It reads your git diffs, understands the context of your changes, and generates professional, semantic-compliant messages in seconds.
+**RYTE** is your AI-powered CLI companion that **bridges** the gap between "coding" and "documenting". It reads your git diffs, understands the context of your changes, and generates professional, semantic-compliant messages in seconds.
 
 ### Core Value
-- **Zero Friction**: Stay in the terminal. No Web UI, no heavy extensions.
-- **Semantic by Default**: Automatically follows [Conventional Commits](https://www.conventionalcommits.org/).
-- **Intelligent Context**: Infers motivation from diffs and branch names.
-- **Interactive Control**: You are always in charge with an `Accept/Edit/Regenerate` workflow.
+- **Stay in Flow**: No context switching. Pure terminal workflow.
+- **Structured by Default**: Clean Conventional Commits automatically.
+- **Context-Aware**: Understands diffs and branch intent.
+- **Human-in-the-Loop**: Accept, edit, or regenerate — your call.
 
 ---
 
 ## ⚡ Quick Start
 
+> ⚡ **TL;DR**: `git add .` → `ryte c` → **done.**
+
 ```bash
 # 1. Install globally
 npm install -g @riflo/ryte
@@ -79,6 +79,18 @@ One command. Same diff. Clean history.
 
 ---
 
+## 🧑‍💻 Built for Developers Who Care
+
+If your git history looks like:
+- `fix`
+- `update`
+- `asdf`
+- `final-final-real`
+
+**RYTE is for you.**
+
+---
+
 ## Installation
 
 ### Via NPM (Recommended)
@@ -145,6 +157,8 @@ Introduces a complete JWT-based authentication system, including login, registra
 3. **Generation**: Crafts a semantic message (feat, fix, chore, etc.) based on the actual logic changes.
 4. **Interaction**: Presents a TUI (Terminal UI) for you to review and finalize the entry.
 
+The result? **AI assistance without surrendering control.**
+
 ---
 
 ## Why Not Just Use GitHub Copilot?
@@ -156,6 +170,7 @@ Fair question. Here's an honest comparison:
 | Works natively in terminal | ❌ | ✅ |
 | Diff-aware (reads what you actually changed) | ❌ | ✅ |
 | Enforces Conventional Commits format | ❌ | ✅ |
+| Works with any editor | ❌ | ✅ |
 | No IDE required | ❌ | ✅ |
 | Free tier available | ❌ | ✅ (via Groq) |
 | BYOK (Bring Your Own Key) | ❌ | ✅ |
@@ -185,7 +200,7 @@ We understand that sending code to an external API is a sensitive decision. Here
 
 ## Configuration
 
-**ryte** requires an API key to function. We support high-performance LLM providers like Groq and OpenAI.
+**RYTE** requires an API key to function. We support high-performance LLM providers like Groq and OpenAI.
 
 ### Groq (Recommended - Free & Instant)
 Get your free key at [console.groq.com](https://console.groq.com/keys).
@@ -212,14 +227,26 @@ export OPENAI_API_KEY="sk-..."
 
 We believe that **every commit should be written right**. A clean git history is not just about aesthetics; it's about debuggability, revertability, and understanding the "why" behind the code months after it was written.
 
+*Your future self will thank you.*
+
+---
+
+## ⭐ Why Developers Love It
+
+- **No more “wip” commits**: No more generic, lazy history.
+- **Cleaner PR reviews**: Reviewers understand the *why* instantly.
+- **Better team collaboration**: Professional communication by default.
+- **Future-proof project history**: Debug and revert with confidence.
+
 ---
 
 ## Roadmap
 
-- [ ] **Context-Aware Radius**: Analyze importing files to suggest impact warnings.
-- [ ] **JIRA / Linear / GitHub Issues**: Automatic ticket status sync.
-- [ ] **Custom Rulesets**: Define your own commit linting rules for the AI.
+- [ ] **GitHub Action**: Automate commit linting and PR generation in CI/CD.
+- [ ] **Custom Rulesets**: Define your own organization-specific commit styles.
+- [ ] **Ticket Integration**: Automatic JIRA / Linear / GitHub Issues syncing.
 - [ ] **Local LLM Support**: Support for Ollama/Llama.cpp for offline-only environments.
+- [ ] **Context-Aware Radius**: Analyze importing files to suggest impact warnings.
 
 ---
 
@@ -243,6 +270,9 @@ A: No. It only sends the `git diff` of your staged changes. It automatically ign
 **Q: Is it free?**  
 A: The tool itself is free. If you use Groq, the API usage is currently free. If you use OpenAI, you pay for what you use (extremely cheap, ~$0.01 for dozens of commits).
 
+**Q: Can I use this in a private company repository?**  
+A: **Yes.** RYTE only sends the staged diff to your configured AI provider using your own API key (BYOK). No code or credentials are ever stored by RYTE itself.
+
 ---
 
 Developed with ❤️ by **Riflo**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riflo/ryte",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "AI Git Workflow Assistant - Generate semantic commits and PRs",
   "main": "src/index.js",
   "bin": {

package/src/ai.js

@@ -44,9 +44,13 @@ export async function generateAIResponse(messages) {
             if (response.status === 429) {
                 // Rate limited — parse retry-after header or use exponential backoff
                 const retryAfter = parseInt(response.headers.get("retry-after") || "15", 10);
-                const waitMs = (retryAfter + 1) * 1000;
-                console.warn(`\x1b[33m⚠ Rate limit hit. Waiting ${retryAfter + 1}s before retry (${attempt}/${MAX_RETRIES})...\x1b[0m`);
-                await new Promise(r => setTimeout(r, waitMs));
+                const waitSeconds = retryAfter + 1;
+
+                for (let i = waitSeconds; i > 0; i--) {
+                    process.stdout.write(`\r\x1b[33m⚠ Rate limit hit. Waiting ${i}s before retry (${attempt}/${MAX_RETRIES})...\x1b[0m`);
+                    await new Promise(r => setTimeout(r, 1000));
+                }
+                process.stdout.write("\r" + " ".repeat(80) + "\r"); // Clear the line
                 continue;
             }
 

package/src/index.js

@@ -22,8 +22,11 @@ function editInteractively(initialText) {
         const tmpFile = path.join(os.tmpdir(), `ryte_edit_${Date.now()}.txt`);
         fs.writeFileSync(tmpFile, initialText, "utf-8");
 
-        const editor = process.env.EDITOR || "vim";
-        console.log(`\nOpening in ${editor}... Close the editor to save.`);
+        const defaultEditor = process.platform === "win32" ? "notepad" : "vim";
+        const editor = process.env.EDITOR || defaultEditor;
+
+        console.log(`\n\x1b[33m💡 Tip: Don't forget to SAVE (Ctrl+S) before closing the editor!\x1b[0m`);
+        console.log(`Opening in ${editor}... Close the editor to save.`);
         try {
             execSync(`${editor} ${tmpFile}`, { stdio: "inherit" });
             const result = fs.readFileSync(tmpFile, "utf-8").trim();
@@ -128,15 +131,15 @@ async function main() {
         await handlePR();
     } else {
         console.log(`
- \x1b[1;38;5;39m██████╗ \x1b[1;38;5;63m██╗   ██╗\x1b[1;38;5;129m████████╗\x1b[1;38;5;161m███████╗\x1b[0m
- \x1b[1;38;5;39m██╔══██╗\x1b[1;38;5;63m╚██╗ ██╔╝\x1b[1;38;5;129m╚══██╔══╝\x1b[1;38;5;161m██╔════╝\x1b[0m
- \x1b[1;38;5;39m██████╔╝\x1b[1;38;5;63m ╚████╔╝ \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m█████╗  \x1b[0m
- \x1b[1;38;5;39m██╔══██╗\x1b[1;38;5;63m  ╚██╔╝  \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m██╔══╝  \x1b[0m
- \x1b[1;38;5;39m██║  ██║\x1b[1;38;5;63m   ██║   \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m███████╗\x1b[0m
- \x1b[1;38;5;39m╚═╝  ╚═╝\x1b[1;38;5;63m   ╚═╝   \x1b[1;38;5;129m   ╚═╝   \x1b[1;38;5;161m╚══════╝\x1b[0m
-
-  \x1b[90mAI-Powered Git Workflow Assistant\x1b[0m
-  \x1b[90mv1.1.1 | by Riflo\x1b[0m
+  \x1b[1;38;5;39m██████╗ \x1b[1;38;5;63m██╗   ██╗\x1b[1;38;5;129m████████╗\x1b[1;38;5;161m███████╗\x1b[0m
+  \x1b[1;38;5;39m██╔══██╗\x1b[1;38;5;63m╚██╗ ██╔╝\x1b[1;38;5;129m╚══██╔══╝\x1b[1;38;5;161m██╔════╝\x1b[0m
+  \x1b[1;38;5;39m██████╔╝\x1b[1;38;5;63m ╚████╔╝ \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m█████╗  \x1b[0m
+  \x1b[1;38;5;39m██╔══██╗\x1b[1;38;5;63m  ╚██╔╝  \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m██╔══╝  \x1b[0m
+  \x1b[1;38;5;39m██║  ██║\x1b[1;38;5;63m   ██║   \x1b[1;38;5;129m   ██║   \x1b[1;38;5;161m███████╗\x1b[0m
+  \x1b[1;38;5;39m╚═╝  ╚═╝\x1b[1;38;5;63m   ╚═╝   \x1b[1;38;5;129m   ╚═╝   \x1b[1;38;5;161m╚══════╝\x1b[0m
+  
+  \x1b[1;38;5;46m[ THE AI-POWERED GIT INFRASTRUCTURE ]\x1b[0m
+  \x1b[90mv1.1.3 | by Riflo\x1b[0m
 
   \x1b[33mCOMMANDS:\x1b[0m
   \x1b[32mryte c\x1b[0m     Generate semantic commit from diff

package/src/prompt.js

@@ -15,7 +15,9 @@ RULES:
 6. Scope: If the diff is localized, infer a scope (e.g., "auth", "ui", "config").
 7. Body (Optional): If the change is complex, add a brief body after 1 blank line to explain technical nuances.
 8. Context: If a branch name or ticket is provided, incorporate it into the scope or footer if applicable.
-9. Anti-Plagiarism: If the diff shows documentation changes containing example commit messages, DO NOT copy those examples. Always synthesize a new message describing the actual change.
+9. Anti-Hallucination: Documentation files (like README.md) often contain example commit messages (e.g., "feat(auth): ..."). DO NOT assume these examples are the topic of the current change.
+10. Logical Validation: Your suggested <scope> must be derived from actual modified logic in the diff, not from text inside code blocks, comments, or examples within a documentation file.
+11. If only README.md or docs are changed, the type MUST be "docs" and the scope should relate to the documentation structure (e.g., "readme", "config", "intro"), NOT the example code inside it.
 
 Example:
 feat(ui): add loading state to checkout button