Skip to content

CLAUDE.md

Latest commit

 

History

History
49 lines (30 loc) · 2.23 KB

CLAUDE.md

File metadata and controls

49 lines (30 loc) · 2.23 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

JetBrains Toolbox plugin that enables local IntelliJ IDEs to connect to Red Hat OpenShift Dev Spaces (Eclipse Che) workspaces via SSH.

Build & Install Commands

# Build the plugin JAR
./gradlew build

# Build and install to JetBrains Toolbox
./gradlew installPlugin

# Clean build artifacts
./gradlew clean

After installing, restart the Toolbox App to load the plugin.

Architecture

DataSource → EnvironmentConfig → Repository → RemoteEnvironment → Provider → Toolbox UI

Key components in plugin/src/main/kotlin/com/redhat/devtools/toolbox/:

  • DevSpacesRemoteDevExtension (DevSpacesPlugin.kt): Entry point implementing RemoteDevExtension. Creates the provider and repository, wires up the data source.

  • DevSpacesRemoteProvider (DevSpacesRemoteProvider.kt): RemoteProvider implementation. Handles URI callbacks (jetbrains://gateway/com.redhat.devtools.toolbox?...) from Dev Spaces Dashboard, triggering environment refresh and connection requests.

  • EnvironmentRepository (EnvironmentRepository.kt): Manages environment lifecycle - fetches configs from data source, caches RemoteEnvironment instances, exposes reactive state via MutableStateFlow.

  • EnvironmentDataSource (datasource/): Interface for fetching environment configs. DevWorkspacesDataSource is the real implementation.

  • DevSpacesRemoteEnvironment (environment/): Wraps EnvironmentConfig with Toolbox API reactive properties (state, description, connection requests).

  • SshEnvironmentContentsViewFactory (environment/): Creates SSH connection views. Current limitation: hardcoded local port 2022, supports only one active connection.

Technical Notes

  • The group value in plugin/build.gradle.kts (com.redhat.devtools.toolbox) is the provider ID used in URI handling.
  • Plugin requires Java 21 (configured via jvmToolchain(21)).
  • Uses JetBrains Toolbox Plugin API version defined in gradle/libs.versions.toml.
  • Periodic environment polling is currently disabled to preserve environments received via external URLs (see TODO in EnvironmentRepository.kt:61-67).