🤖 CodIn - AI Code Explainer v1.2.3

Get instant AI-powered explanations for any code snippet in 15+ languages with secure API key management!

🌟 Features

🎯 Smart Code Explanation

• Multiple Access Methods: CodeLens buttons, Quick Actions, Context Menu, Command Palette
• Real-time Explanations: Instant AI responses with progress indicators
• Cross-Language Support: Works with Python, JavaScript, TypeScript, Java, C++, and 50+ languages

🌍 Multi-Language Support (15 Languages)

• English • Bengali (বাংলা) • Arabic (العربية) • Spanish • French
• German • Hindi • Chinese • Japanese • Korean
• Portuguese • Russian • Italian • Dutch • Malay
• Native AI Prompts: Culturally appropriate explanations with local technical terms

� Secure API Key Management

• VS Code Secret Storage: Encrypted, cross-platform security
• Command Palette Setup: No manual file editing required
• Password-Masked Input: Keys never visible on screen
• Auto-Migration: Seamless upgrade from .env files

🎨 Professional UI

• Floating CodeLens Buttons: 🤖 Explain Code appears above selected code
• Quick Actions: Press Cmd+. for lightbulb menu integration
• Clean Popups: VS Code theme-compatible explanation panels
• Language Indicators: Shows current language in UI elements

🎯 How to Use

Method 1: CodeLens (Floating Button)

• Select code → See 🤖 Explain Code (Language) button above
• Click to get explanation in side panel

Method 2: Quick Actions

• Select code → Press Cmd+. → Choose 💡 Explain Code
• Or click the lightbulb icon

Method 3: Context Menu

• Select code → Right-click → CodIn: Explain Code

Method 4: Command Palette

• Select code → Cmd+Shift+P → CodIn: Explain Code

💡 Multi-Language Example

Select this Python code:

def factorial(n):
    if n < 0:
        raise ValueError("Factorial not defined for negative numbers")
    return 1 if n <= 1 else n * factorial(n - 1)

CodIn explains in your chosen language:

🇺🇸 English: "This function calculates the factorial of a number using recursion..."

🇧🇩 Bengali: "এই ফাংশনটি রিকার্শন ব্যবহার করে একটি সংখ্যার ফ্যাক্টোরিয়াল গণনা করে..."

🇸🇦 Arabic: "تحسب هذه الدالة العاملية لرقم باستخدام العودية..."

🇪🇸 Spanish: "Esta función calcula el factorial de un número usando recursión..."

🛠️ Supported Languages

• Python (.py)
• JavaScript (.js)
• TypeScript (.ts)
• C++ (.cpp, .cc, .cxx)
• Java (.java)
• C# (.cs)
• Go (.go)
• Ruby (.rb)
• PHP (.php)
• Swift (.swift)
• And many more!

🔐 API Key Management

Secure Setup Commands:

• CodIn: Set OpenAI API Key - Password-masked secure setup
• CodIn: Check API Key Status - View connection status
• CodIn: Remove OpenAI API Key - Safe removal with confirmation

Security Features:

• ✅ VS Code Secret Storage (encrypted)
• ✅ Password-masked input
• ✅ No plain text storage
• ✅ Auto-migration from .env files

📦 Installation

From VS Code Marketplace (Recommended)

1. Open VS Code
2. Go to Extensions view (Cmd+Shift+X)
3. Search for "CodIn"
4. Click "Install" on "CodIn - AI Code Explainer" by SemicolonAILabs

From VSIX File

1. Download the latest codin-1.2.3.vsix from GitHub Releases
2. In VS Code: Cmd+Shift+P → "Extensions: Install from VSIX..."
3. Select the downloaded file

Requirements

• VS Code 1.70.0 or higher
• OpenAI API key (get one from OpenAI Platform)
• Internet connection for AI explanations

⚙️ Configuration

Available Settings:

{
  "codin.explanationLanguage": "English",
  "codin.showLanguageInPopup": true,
  "codin.enableCodeLens": true,
  "codin.enableCodeActions": true
}

Access Settings: Cmd+, → Search "codin"

�️ Privacy & Security

Enterprise-Grade Security:

• Encrypted Storage: API keys stored using VS Code Secret Storage (encrypted at rest)
• No Plain Text: Keys never stored in files or visible on screen
• Secure Transmission: HTTPS-only communication with OpenAI
• Privacy First: Code snippets only sent to OpenAI for explanation
• No Logging: CodIn doesn't store or log any user data
• Cross-Platform: Secure on macOS, Windows, and Linux

What We Don't Store:

• ❌ API keys in plain text
• ❌ User code snippets
• ❌ Explanation history
• ❌ Personal information
• ❌ Usage analytics

🛠️ Development

Setup for Development

# Clone the repository
git clone https://github.com/semicolonailabs/CodIn.git
cd CodIn

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Watch for changes
npm run watch

# Package extension
npm run package

# Run linting
npm run lint

Testing

# Install locally for testing
code --install-extension codin-1.2.3.vsix

# Or press F5 in VS Code to launch Extension Development Host

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for detailed guidelines.

Quick links:

• 🐛 Report Bugs
• 💡 Request Features
• 🔧 Pull Requests
• 📚 Documentation

Enjoy coding with CodIn! 🎉

Built with ❤️ and ☕ by Saky !# CodIn