Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

NimbusCode - Python Implementation

A lightweight, portable AI coding assistant powered by OpenRouter's free models.

Features

  • Minimal Footprint: Uses minimal disk space and memory
  • Portable: Works across platforms with minimal dependencies
  • Code Generation: Create code based on natural language descriptions
  • Code Improvement: Get suggestions to improve existing code
  • Code Explanation: Understand complex code with detailed explanations
  • Cloud Deployment: Generate deployment instructions for AWS, Azure, and GCP
  • Mobile Development: Get guidance for iOS, Android, and cross-platform development
  • Interactive Mode: Have a conversation with the AI about your coding questions

Installation

# Clone the repository
git clone https://github.com/naelmohammad/nimbuscode-python.git
cd nimbuscode-python

# Install dependencies
pip install -r requirements.txt

# Make the script executable
chmod +x nimbuscode.py

# Optional: Create a symlink to make it available system-wide
ln -s $(pwd)/nimbuscode.py /usr/local/bin/nimbuscode

Configuration

Before using NimbusCode, you need to set up your OpenRouter API key:

# Set your API key
./nimbuscode.py config --api-key YOUR_API_KEY

# Alternatively, set it as an environment variable
export OPENROUTER_API_KEY=your_api_key

Usage

Ask a coding question

./nimbuscode.py ask "How do I implement a binary search tree in Python?"

Generate code

./nimbuscode.py generate "A REST API for a todo list application" --language python --save todo_api.py

Improve existing code

./nimbuscode.py improve my_script.py --save improved_script.py

Explain code

./nimbuscode.py explain complex_algorithm.py

Cloud deployment guidance

./nimbuscode.py cloud "Deploy a containerized Flask application with a PostgreSQL database" --provider aws

Mobile development guidance

./nimbuscode.py mobile "A fitness tracking app with social features" --platform cross

Interactive mode

./nimbuscode.py interactive

List available free models

./nimbuscode.py models

Why NimbusCode?

  • Free to Use: Leverages OpenRouter's free models
  • Privacy-Focused: Your code stays on your machine
  • Versatile: Helps with various programming tasks
  • Efficient: Quick responses with minimal resource usage
  • Educational: Explains concepts and provides learning opportunities

License

MIT

Acknowledgements