Skip to content

README.md

Latest commit

 

History

History
86 lines (57 loc) · 3.53 KB

README.md

File metadata and controls

86 lines (57 loc) · 3.53 KB
Raw
Luna



Quick Start Guide

Tip

Get started in under 60 seconds! Follow these three simple steps:

  1. Install: Download bin/Luna.exe and add to your system PATH
  2. Setup: Run Luna apikey YOUR_OPENROUTER_API_KEY to configure your API key
  3. Setup: Run Luna model MODEL_ID (e.g. openai/gpt-4o-mini) to choose your model
  4. Use: Execute Luna commit inside a repo with changes — pick the files to stage and Luna generates and commits each one!

Note

Luna's interface uses Nerd Font icons. Set your terminal font to a Nerd Font (e.g. FiraCode Nerd Font, JetBrainsMono NF) so they render correctly — otherwise they'll show as blank boxes.

Command Reference

Note

Available Commands - Comprehensive toolset for commit automation:

Command Description Usage
help Display help information help
commit Generate commit messages commit -e (with emojis)
apikey Set OpenRouter API key apikey YOUR_KEY
model Set OpenRouter model model MODEL_ID
config Manage configuration config

Key Features

Important

AI-Powered Intelligence — Luna analyzes your code changes and generates meaningful, descriptive commit messages that actually make sense.

  • Smart Context Analysis: Understands your code changes and generates relevant commits
  • Powered by OpenRouter: bring your own API key and pick any model OpenRouter supports
  • Professional Formatting: Creates conventional commit messages
  • Emoji Support: Optional emoji-enhanced commits for better visual tracking
  • Secure: Your API key is stored locally and securely

Documentation

Note

Multi-language Support - Choose your preferred language for detailed documentation:

Configuration

Important

Easy Setup - Get started in minutes:

  1. Obtain your API key from OpenRouter
  2. Run Luna apikey your_api_key_here to set your credentials
  3. Run Luna model your_chosen_model_id to set which model to use (e.g. openai/gpt-4o-mini, anthropic/claude-3.5-sonnet)
  4. Start generating intelligent commits immediately!

Contributing

Note

Open Source Community - Luna is built with love and welcomes contributions!

We welcome bug reports, feature requests, and pull requests! Please check our documentation for contribution guidelines.

Made by hax — Version 1.3 (Beta)

Streamlining your commit workflow, one AI-generated message at a time!