Skip to content

keshavgarg24/genie-assist

Repository files navigation

🎩 Genie CLI ✨

Your magical command-line assistant that combines developer utilities with AI superpowers!

npm version License: MIT

πŸš€ Features

πŸ› οΈ Developer Utilities

  • πŸ“ File Operations - List, search, and manage files
  • 🌳 Directory Tree - Visualize project structure
  • πŸ• System Info - Time, user, and system information
  • 🧹 Cleanup Tools - Remove clutter files automatically
  • πŸš€ Project Init - Bootstrap new projects

πŸ€– AI-Powered Features

  • πŸ’¬ Interactive Chat - Terminal-based AI conversations
  • ✍️ Text Summarization - Summarize any text or file
  • 🌍 Translation - Translate text to any language
  • πŸ’» Code Generation - Generate code from descriptions
  • πŸ› Code Debugging - Find and fix bugs automatically
  • πŸ“ Git Commit Messages - Generate perfect commit messages
  • πŸ“š Documentation - Auto-generate code documentation
  • πŸ’‘ Idea Generation - Creative ideas for any project
  • 🎨 Creative Writing - Poems, emails, and more

πŸ“¦ Installation

# Install globally
npm install -g genie-assist

# Or use without installing
npx genie-assist

πŸ”§ Setup

On first run, Genie will ask for your Google Gemini API key:

  1. Get your free API key at Google AI Studio
  2. Run genie and paste your API key when prompted
  3. Start using AI features immediately!

🎯 Usage

Interactive Mode

genie

Launch the interactive menu to explore all features.

Direct Commands

πŸ› οΈ Basic Utilities

genie --ls                    # List files
genie --tree                  # Show directory tree
genie --time                  # Current time
genie --whoami               # System info
genie --find "*.js"          # Find files
genie --clean                # Remove clutter
genie --init                 # Create README

πŸ€– AI Features

genie --chat                               # Start AI chat
genie --summarize "Your text here"        # Summarize text
genie --explain "quantum computing"       # Explain concepts
genie --translate "Hello" --lang es       # Translate text
genie --codegen "React login form"        # Generate code
genie --debug "your code here"            # Debug code
genie --commitmsg                         # Generate commit message
genie --docs "function code"              # Generate docs
genie --summarize-file README.md          # Summarize file
genie --idea --type startup               # Generate ideas
genie --poem "ocean sunset"               # Write poetry
genie --email "meeting request"           # Generate emails

🎨 Examples

Generate Code

genie --codegen "Express.js API with authentication"

Debug Code

genie --debug "
function factorial(n) {
  if (n = 1) return 1;
  return n * factorial(n - 1);
}
"

Smart Commit Messages

git add .
genie --commitmsg
# Output: "feat: add user authentication with JWT tokens"

File Summarization

genie --summarize-file package.json
# Get AI insights about your project dependencies

πŸ”§ Configuration

Genie stores its configuration in:

  • macOS/Linux: ~/.config/genie-assist/config.json
  • Windows: %APPDATA%/genie-assist/config.json

Reset Configuration

rm ~/.config/genie-assist/config.json  # Unix
# Or delete the config file on Windows

🌟 AI Models

Genie uses Google Gemini 1.5 Flash for all AI features:

  • ⚑ Ultra-fast responses
  • πŸ†“ Free tier available
  • 🧠 Advanced reasoning capabilities
  • 🌐 Multilingual support

🀝 Contributing

We welcome contributions! Here's how to get started:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit changes: git commit -m 'feat: add amazing feature'
  4. Push to branch: git push origin feature/amazing-feature
  5. Open a Pull Request

Development Setup

git clone https://github.com/your-username/genie-assist.git
cd genie-assist
npm install
npm run dev

πŸ“ License

MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

  • Google Gemini for powering our AI features
  • Chalk for beautiful terminal colors
  • Inquirer for interactive prompts
  • Figlet for ASCII art magic

πŸ”— Links


Made to ease out daily tasks - It is an open sourced project and your contributions are highly appreciated

Star ⭐ this repo if you find it helpful!

About

Your magical command-line assistant that combines developer utilities with AI superpowers!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published