cline/proto/host/env.proto

syntax = "proto3";

package host;
option java_package = "bot.cline.host.proto";
option java_multiple_files = true;

import "cline/common.proto";

// Provides methods for working with the user's environment.
service EnvService {
  // Writes text to the system clipboard.
  rpc clipboardWriteText(cline.StringRequest) returns (cline.Empty);

  // Reads text from the system clipboard.
  rpc clipboardReadText(cline.EmptyRequest) returns (cline.String);

  // Returns a stable machine identifier for telemetry distinctId purposes.
  rpc getMachineId(cline.EmptyRequest) returns (cline.String);

  // Returns the name and version of the host IDE or environment.
  rpc getHostVersion(cline.EmptyRequest) returns (GetHostVersionResponse);

  // Returns the URI scheme for URIs that will redirect to the host environment.
  // e.g. vscode, idea, pycharm, etc. If the host does not support URIs it should
  // return an empty uriScheme.
  rpc getUriScheme(cline.EmptyRequest) returns (GetUriSchemeResponse);

  // Returns the telemetry settings of the host environment. This may return UNSUPPORTED
  // if the host does not specify telemetry settings for the plugin.
  rpc getTelemetrySettings(cline.EmptyRequest) returns (GetTelemetrySettingsResponse);

  // Returns events when the telemetry settings change.
  rpc subscribeToTelemetrySettings(cline.EmptyRequest) returns (stream TelemetrySettingsEvent);
}

message GetHostVersionResponse {
  // The name of the host platform, e.g VSCode
  optional string platform = 1; 
  // The version of the host platform, e.g. 1.103.0
  optional string version = 2;
}

enum Setting {
  UNSUPPORTED = 0; // This host does not support this setting.
  ENABLED = 1;
  DISABLED = 2;
}
message GetTelemetrySettingsResponse {
  Setting is_enabled = 1;
}

message TelemetrySettingsEvent {
  Setting is_enabled = 1; 
}

message GetUriSchemeResponse {
  string uri_scheme = 1;
}