Merge pull request #2 from Arbitr-ary-ily/dev

feat: Stylistic Changes, Custom Filters, Error Handling

Author: dakshgup

README.md

@@ -1,45 +1,253 @@
-# Chameleon: Changelog Generator CLI
 
-A command-line tool that generates intelligent changelogs from your GitHub repository using [Greptile AI](https://greptile.com).
+# Chameleon: Modern Changelog Generator
 
-## Features
+  
 
-- 🤖 AI-powered changelog generation
-- 📅 Flexible date range selection (24h, 7d, 14d, 30d)
-- 🎯 Multiple changelog formats:
-  - Internal (technical details for developers)
-  - External (user-facing changes)
-  - Mintlify (formatted for Mintlify documentation)
-- 🔍 Auto-detection of current repository
-- ⚡ Real-time progress indicator
+<p  align="center">
 
-## Prerequisites
+<div align="center">
+<img  src="https://image.pitchbook.com/r7i4Be6aH3XjC3Mg9RsbvFE0a7r1717776760562_200x200"  alt="Chameleon Logo"  width="400"/>
+</div>
 
-Before using this tool, you'll need:
+</p>
 
-- Node.js installed
-- GitHub Personal Access Token (https://github.com/settings/token)
-- Greptile API Key (https://app.greptile.com/settings/api)
+  
 
-## Installation
+<p  align="center">
 
-1. Clone the repository
-2. Install dependencies:
+<b>A beautiful, modern CLI for generating intelligent changelogs from Git repositories</b>
+
+</p>
+
+  
+
+<p  align="center">
+
+<img  src="https://img.shields.io/badge/TypeScript-5.x-blue"  alt="TypeScript">
+
+<img  src="https://img.shields.io/badge/Node.js-18.x%2B-green"  alt="Node.js">
+
+<img  src="https://img.shields.io/badge/License-MIT-yellow"  alt="License">
+
+</p>
+
+  
+
+---
+
+  
+
+## ✨ Features
+
+  
+
+- 🎨 **Beautiful UI** - Modern terminal interface with colors, gradients, and stylish boxes
+
+- 📋 **Clipboard Support** - Generated changelogs are automatically copied to your clipboard
+
+- 📅 **Flexible Date Ranges** - Choose from preset ranges or select custom dates with a date picker
+
+- 🖼️ **Image Display** - Show repository logos or any image directly in your terminal
+
+- 💾 **Save to File** - Save generated changelogs to local files and open them afterward
+
+- 🔄 **Multiple Formats** - Generate internal, external, or Mintlify-compatible changelogs
+
+- 🤖 **AI-powered** - Uses Greptile AI to generate intelligent, context-aware changelogs
+
+  
+
+## 📦 Installation
+
+  
+
+```bash
+
+# Clone the repository
+
+git  clone  https://github.com/greptileai/chameleon.git
+
+cd  chameleon
+
+  
+
+# Install dependencies
+
+npm  install
+
+  
+
+# Run setup wizard
+
+npm  run  setup
+
+```
+
+  
+
+## 🔑 Prerequisites
+
+  
+
+You'll need the following API tokens:
+
+  
+
+-  **GitHub Token** - For accessing GitHub repositories ([create one here](https://github.com/settings/tokens))
+
+-  **Greptile API Key** - For AI-powered changelog generation ([get it here](https://app.greptile.com/settings/api))
+
+  
+
+The setup wizard will guide you through obtaining and configuring these tokens.
+
+  
+
+## 🚀 Usage
+
+  
+
+```bash
+
+# Display help
+
+npm  start  --  --help
+
+  
+
+# Generate a changelog
+
+npm  start  --  cl
+
+  
+
+```
+
+  
+
+After building and installing globally:
+
+  
+
+```bash
+
+# Display help
+
+chameleon  --help
+
+  
+
+# Generate a changelog
+
+chameleon  cl
+
+```
+
+  
+
+### Command Options
+
+  
+
+-  `cl, changelog` - Generate a changelog for a repository
+  
+
+## 🌟 Interactive Features
+
+  
+
+Chameleon offers a fully interactive experience:
+
+  
+
+1.  **Repository Selection** - Automatically detects current repo or enter any GitHub repo
+
+2.  **Date Range** - Choose from preset ranges or select custom dates with an interactive calendar
+
+3.  **Format Selection** - Pick from different changelog formats or create a custom one
+
+4.  **Clipboard Integration** - Results are automatically copied to your clipboard
+
+5.  **File Export** - Save to file with your preferred filename
+
+6.  **Terminal Images** - View repository logos or custom images right in your terminal
+
+  
+
+## 🧩 Changelog Formats
+
+  
+
+Choose from multiple formatting options:
+
+  
+
+-  **Internal** - Technical details targeting developers and internal teams
+
+-  **External** - User-friendly changes suitable for customer-facing release notes
+
+-  **Mintlify** - Special format compatible with Mintlify documentation
+
+-  **Custom** - Provide your own custom instructions for tailored results
+
+  
+
+## 🛠️ Development
+
+  
 
 ```bash
-pnpm install
+
+# Run in development mode
+
+npm  run  start
+
+  
+
+# Build the project
+
+npm  run  build
+
+  
+
+# Watch for changes
+
+npm  run  build:watch
+
+  
+
+# Run tests
+
+npm  run  test
+
 ```
 
-3. Create a `.env` file in the root directory:
+  
+
+## 📄 License
+
+  
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+  
+
+## 🙏 Acknowledgements
+
+  
+
+- Built with [cli-typescript-starter](https://github.com/kucherenko/cli-typescript-starter)
+
+- Powered by [Greptile](https://greptile.com) for intelligent changelog generation
+
+  
 
-   ```bash
-   GITHUB_TOKEN=your_github_token
-   GREPTILE_API_KEY=your_greptile_api_key
-   ```
+---
 
-## Usage
+  
 
-Run `pnpm run cl` to start the CLI. Now follow the on-terminal instructions.
+<p  align="center">
 
-*Note: Chameleon uses Greptile to index your repo, please check to ensure your company has approved Greptile before using this tool on private work repos.*
+Made with ❤️ by Greptile
 
+</p>

bin/run.ts

@@ -1,19 +1,51 @@
 import yargs, { CommandModule } from 'yargs'
 import { config } from 'dotenv'
 import { commands } from '../src'
-import { bgBlue, bold, red } from 'picocolors'
+import chalk from 'chalk'
+import boxen from 'boxen'
+import figlet from 'figlet'
 
 config()
 
+// Create a beautiful header
+const appName = figlet.textSync('CHAMELEON', {
+  font: 'Standard',
+  horizontalLayout: 'full'
+})
+
+// Set the title color to green
+const title = chalk.green(appName) 
+
+// Create a box for the welcome message
+const welcomeBox = boxen(
+  `${title}\n\n${chalk.bold('The modern CLI for generating beautiful changelogs!')}\n
+${chalk.dim('Powered by')} ${chalk.greenBright('Greptile')}\n
+${chalk.blue('Visit GitHub Repository:')} ${chalk.underline('https://github.com/greptileai/chameleon')}`,
+  {
+    margin: 1,
+    padding: 1,
+    borderStyle: 'round',
+    borderColor: 'cyan',
+    backgroundColor: '#222',
+  }
+)
+
+// Display the welcome box
+console.log(welcomeBox)
+
 const run = yargs(process.argv.slice(2))
 run.usage(
-  bgBlue(
-    `Welcome to the CLI application powered by ${bold(red('cli-typescript-starter'))}!
-    See more on https://github.com/kucherenko/cli-typescript-starter`,
+  chalk.blueBright(
+    `Welcome to the modern changelog generator CLI!\n
+    See more on https://github.com/greptileai/chameleon`,
   ),
 )
 for (const command of commands) {
   run.command(command as CommandModule)
 }
 
-run.demandCommand(1, 'You need at least one command before moving on').help().argv
+if (process.argv.length <= 2) {
+  run.showHelp()
+} else {
+  run.demandCommand(1, chalk.yellow('You need at least one command before moving on')).help().argv
+}