INTELLIJ

Overview

Codaro is a comprehensive developer activity tracking plugin designed for JetBrains IDEs (IntelliJ IDEA, WebStorm, PyCharm, and other JetBrains products). The plugin monitors coding activity, tracks file changes, and provides team collaboration features with intelligent collision detection.

Technology Stack

  • Language: Written in Kotlin for optimal JetBrains ecosystem compatibility

  • Architecture: Service-oriented design with event-driven activity tracking

  • Compatibility: Supports IntelliJ Platform 2024.1+ (build 241-251.*)

  • Dependencies: Uses modern libraries including Kotlin Coroutines, OkHttp, and Gson

Key Features

🚀 Core Functionality

  • Real-time Activity Tracking: Monitors file changes, coding sessions, and project activity

  • Smart Heartbeat System: Sends structured data to backend services with VS Code compatibility

  • Team Collaboration: File collision detection to prevent conflicts when multiple developers work on the same files

  • Privacy-First Design: Automatically skips sensitive files and directories

  • Performance Optimized: Efficient tracking with rate limiting and intelligent debouncing

🔔 Intelligent Notification System

  • Critical Alerts: Immediate red balloon notifications for urgent issues

  • Warnings: Yellow balloon notifications for important but non-critical issues

  • Routine Logging: Background logging to Event Log without popup spam

  • Smart Debouncing: Prevents notification overload through intelligent filtering

  • Customizable Preferences: User-configurable notification settings

🤝 VS Code Parity

The plugin maintains functional parity with the VS Code extension, including:

  • Identical Payload Format: Same data structure for backend compatibility

  • Consistent Timeouts: Matching timeout configurations

  • Retry Logic: Similar error handling and retry mechanisms

  • Rate Limiting: Equivalent rate limiting behavior

Installation

Method 1: JetBrains Marketplace (Recommended)

1

Install from Marketplace

  • Open your JetBrains IDE (IntelliJ IDEA, WebStorm, PyCharm, etc.)

  • Navigate to File → Settings (Windows/Linux) or IntelliJ IDEA → Preferences (macOS)

  • Select Plugins from the left sidebar

  • Click the Marketplace tab

  • Search for "Codaro"

  • Click Install next to the Codaro plugin

  • Restart your IDE when prompted

Method 2: ZIP File Installation

1

Install from ZIP

  • Download the plugin ZIP file from the official source

  • Open your JetBrains IDE

  • Navigate to File → Settings → Plugins

  • Click the gear icon (⚙️) and select Install Plugin from Disk...

  • Browse and select the downloaded ZIP file

  • Click OK and restart your IDE

Configuration

Initial Setup

1

First-time Configuration

  • After installation, navigate to Settings → Tools → Codaro

  • Enter your Codaro User ID in the provided field

  • Click Save Settings

  • The plugin will automatically register your device and begin tracking

Settings Overview

User Configuration

  • Codaro User ID: Your unique identifier (3-50 characters, alphanumeric with underscores and hyphens)

  • Real-time Validation: The interface provides immediate feedback on User ID validity

  • Device Registration: Automatic device registration when User ID is saved

Team Selection

  • Team Dropdown: Select your team from available options

  • Current Team Display: Shows your currently selected team

  • Clear Team: Option to remove team selection

  • Automatic Loading: Teams are loaded asynchronously from the server

Collision Detection

  • Enable Collision Detection: Toggle file collision monitoring

  • Check Interval: Configure how often to check for collisions (15-300 seconds)

  • Collision Notifications: Enable/disable collision alert notifications

Test Connection Feature

The plugin includes a Test Connection functionality that:

  • Verifies connectivity to the Codaro API endpoints

  • Tests authentication with your User ID

  • Validates device registration status

  • Provides immediate feedback on connection issues

  • Bypasses rate limiting for testing purposes

Note: The Test Connection feature is integrated into the heartbeat system and automatically validates connections during normal operation.

Usage

Automatic Tracking

Once configured, the plugin automatically:

  • Monitors File Changes: Tracks when you open, edit, or save files

  • Records Coding Sessions: Logs start and stop times for editing activities

  • Sends Heartbeats: Transmits activity data to backend services

  • Detects Collisions: Alerts when team members edit the same files

Manual Actions

Payload Preview

  • Right-click on any file in the editor

  • Select Codaro → Show Payload Preview

  • View the exact data structure that will be sent to the server

Settings Management

  • Access Settings → Tools → Codaro anytime

  • Modify User ID, team selection, or collision detection settings

  • Changes are applied immediately after saving

Team Collaboration

File Collision Detection

1

How Collision Detection Works

  • Monitors files you're currently editing

2

  • Checks if team members are editing the same files

3

  • Displays notifications when collisions are detected

4

  • Provides file-specific collision information

Team Management

  • Select your team from the dropdown in settings

  • View current team information

  • Clear team selection if needed

  • Teams are synchronized with the server

Data Privacy and Security

Privacy Features

  • Filename Only: Only filenames are transmitted, not full paths

  • No Code Content: Source code is never sent to servers

  • Sensitive File Filtering: Automatically excludes sensitive files and directories

  • Local Processing: Most data processing happens locally

Security Measures

  • Device Registration: Secure device authentication system

  • Rate Limiting: Prevents excessive API calls

  • Error Handling: Robust error handling with user-friendly messages

  • Secure Storage: User credentials stored securely in IDE's credential store

Troubleshooting

Common Issues

Plugin Not Tracking Activity

1

Check User ID & Plugin Status

  • Verify your User ID is correctly entered in settings

  • Check that the plugin is enabled in Settings → Plugins

2

Restart IDE

  • Restart your IDE

3

Inspect Logs

  • Check the Event Log for error messages

Connection Issues

1

Network Check

  • Verify internet connectivity

2

Firewall & Proxy

  • Check firewall settings for the IDE

  • Review proxy settings if applicable

3

Logs

  • Check the Event Log for specific error details

Team Features Not Working

1

Team Selection & Permissions

  • Ensure you have selected a team in settings

  • Verify team permissions with your administrator

2

Collision Detection & Restart

  • Check that collision detection is enabled

  • Restart the IDE after changing team settings

Logging and Diagnostics

The plugin provides comprehensive logging:

  • Event Log: Access via Help → Show Log in Explorer/Finder

  • Notification History: View past notifications in the IDE's notification panel

  • Debug Information: Detailed request/response logging for troubleshooting

Getting Help

1

Self-Help Steps

  • Check the Event Log for specific error messages

  • Verify your configuration in plugin settings

  • Try restarting your IDE

2

Contact Support

  • Contact support with specific error details and your IDE version

Advanced Configuration

Rate Limiting

The plugin includes intelligent rate limiting:

  • Default Limits: Prevents excessive API calls

  • Bypass Options: Test connections bypass rate limits

  • Configurable: Administrators can adjust limits if needed

Notification Customization

Customize notification behavior:

  • Critical Issues: Always shown as red balloons

  • Warnings: Shown as yellow balloons (can be disabled)

  • Info Messages: Logged to Event Log only

  • Debouncing: Prevents notification spam

Performance Optimization

The plugin is optimized for performance:

  • Efficient Tracking: Minimal impact on IDE performance

  • Smart Debouncing: Reduces unnecessary API calls

  • Background Processing: Non-blocking operations

  • Memory Management: Efficient resource usage

Compatibility

Supported IDEs

  • IntelliJ IDEA (Community and Ultimate)

  • WebStorm

  • PyCharm (Community and Professional)

  • PhpStorm

  • RubyMine

  • CLion

  • DataGrip

  • Rider

  • GoLand

  • AppCode (deprecated)

Version Requirements

  • IntelliJ Platform: 2024.1+ (build 241-251.*)

  • Java: JDK 21 LTS or higher

  • Kotlin: Compatible with Kotlin 1.9+

Operating Systems

  • Windows 10/11

  • macOS 10.15+

  • Linux (Ubuntu 18.04+, other distributions)

Updates and Maintenance

Automatic Updates

  • The plugin automatically checks for updates through the JetBrains Marketplace

  • Update notifications appear in the IDE when new versions are available

  • Updates can be installed directly from the notification

Manual Updates

1

Manual Update Steps

  • Navigate to Settings → Plugins

  • Find the Codaro plugin in the Installed tab

  • Click Update if available

  • Restart the IDE when prompted

Version History

Check the plugin's changelog for:

  • New features and improvements

  • Bug fixes and performance enhancements

  • Compatibility updates

  • Breaking changes (if any)

Support and Resources

  • Plugin Version: 3.5.0

  • Website: https://codaro.dev

  • Compatibility: JetBrains IDEs 2024.1+

  • License: Check the LICENSE file in the plugin directory

For technical support or feature requests, please contact the development team through the official channels provided on the Codaro website.

PreviousEMBEDDERNextREPORTS