Skip to main content

JetBrains IDEs Integration

Integrate InitRepo with JetBrains IDEs (IntelliJ IDEA, PyCharm, WebStorm, etc.) for comprehensive documentation and AI assistance in your development workflow.

Supported IDEs

  • IntelliJ IDEA (Ultimate/Community)
  • PyCharm (Professional/Community)
  • WebStorm
  • GoLand
  • CLion
  • PhpStorm
  • RubyMine
  • And other JetBrains IDEs

Features

  • Intelligent Documentation: Context-aware documentation generation
  • Code Analysis: Advanced code quality and structure analysis
  • AI Assistance: Enhanced AI suggestions based on project context
  • Multi-language Support: Works across all supported programming languages

Setup

1

Install Plugin

  1. Open your JetBrains IDE
  2. Go to Settings/Preferences → Plugins
  3. Search for “InitRepo”
  4. Click Install and restart IDE
2

Configure API Access

Add your InitRepo credentials:
<!-- In IDE settings or .idea/config/initrepo.xml -->
<initrepo>
  <api-key>your_api_key_here</api-key>
  <project-id>your_project_id</project-id>
  <auto-analysis>true</auto-analysis>
</initrepo>
3

Connect Project

Link your project to InitRepo:
  • Open InitRepo tool window
  • Click “Connect Project”
  • Select or create project in InitRepo

Plugin Features

Smart Documentation

Generate documentation from code:
// Right-click on class/method → InitRepo → Generate Documentation
public class UserService {
    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    // AI-generated documentation appears here
    public User createUser(CreateUserRequest request) {
        // Implementation with AI suggestions
    }
}

Code Analysis

Real-time code analysis and improvements:
# PyCharm example
class DataProcessor:
    def __init__(self, config: Dict[str, Any]):
        self.config = config

    def process_data(self, data: List[Dict]) -> List[Dict]:
        # InitRepo suggests optimizations and documentation
        return [self._transform_item(item) for item in data]

AI-Powered Refactoring

Get intelligent refactoring suggestions:
// WebStorm example
function processUserData(users) {
    // InitRepo suggests: Extract method, add type hints, improve error handling
    return users.map(user => ({
        id: user.id,
        name: user.name,
        email: user.email
    }));
}

Configuration

Project-Level Settings

Create .initrepo/config.json in your project root:
{
  "project": {
    "id": "your_project_id",
    "name": "My Project"
  },
  "analysis": {
    "enabled": true,
    "languages": ["java", "kotlin", "python"],
    "excludePatterns": ["**/test/**", "**/generated/**"]
  },
  "documentation": {
    "format": "markdown",
    "autoGenerate": true,
    "includeExamples": true
  }
}

IDE-Specific Settings

Configure per-IDE preferences:
<!-- .idea/initrepo-settings.xml -->
<settings>
  <analysis enabled="true" realTime="true" />
  <documentation autoGenerate="true" format="md" />
  <ai enabled="true" model="gpt-4" />
</settings>

Commands and Shortcuts

ActionShortcutDescription
Analyze FileCtrl+Alt+ARun code analysis on current file
Generate DocsCtrl+Alt+DGenerate documentation for selection
Show ContextCtrl+Alt+CDisplay project context
Quick FixCtrl+Alt+FApply AI-suggested fixes

Integration with JetBrains Features

Version Control Integration

  • Automatic documentation updates on commits
  • PR description generation
  • Code review assistance

Run/Debug Integration

  • Test documentation generation
  • Performance analysis integration
  • Debug session context sharing

Database Integration

  • Schema documentation generation
  • Query optimization suggestions
  • Data model analysis

Troubleshooting

  • Restart IDE after installation
  • Check IDE version compatibility
  • Verify plugin is enabled in settings
  • Verify API key and project ID
  • Check network connectivity
  • Ensure InitRepo service is accessible
  • Confirm supported language
  • Check file is not excluded
  • Verify project is properly connected