8000 GitHub - greptileai/chameleon: Changelog generator
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

greptileai/chameleon

Repository files navigation

Chameleon: Modern Changelog Generator

Chameleon Logo

A beautiful, modern CLI for generating intelligent changelogs from Git repositories

TypeScript Node.js License


✨ 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

# 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)

  • Greptile API Key - For AI-powered changelog generation (get it here)

The setup wizard will guide you through obtaining and configuring these tokens.

🚀 Usage

# Display help

npm  start  --  --help

  

# Generate a changelog

npm  start  --  cl

  

After building and installing globally:

# 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

# 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

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements


Made with ❤️ by Greptile

About

Changelog generator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0