KetraTerm
API · v0.3.0All versions

Package-level declarations

Types

Link copied to clipboard
data class TerminalProfile(val id: String, val displayName: String, val command: List<String>, val environment: Map<String, String> = emptyMap(), val workingDirectory: Path? = null, val kind: TerminalProfileKind = TerminalProfileKind.classify(id, displayName, command), val shellEnvironment: TerminalShellEnvironment = TerminalShellEnvironment.Empty, val startupCommand: TerminalStartupCommand? = null)

Host-neutral terminal launch profile.

Link copied to clipboard

Stable presentation category for a terminal launch profile.

Link copied to clipboard
class TerminalProfileRegistry(osName: String = System.getProperty("os.name"), environment: Map<String, String> = System.getenv(), pathSeparator: String = File.pathSeparator, executableExists: (Path) -> Boolean = Files::isRegularFile)

Discovers built-in local terminal launch profiles.

Link copied to clipboard
data class TerminalShellEnvironment(val variables: Map<String, String> = emptyMap(), val pathPrefix: String? = null)

Host-selected environment applied at process launch and again after supported interactive shells finish their startup files. This lets a product select a project toolchain even when shell startup files select a different default.

Link copied to clipboard

Host-neutral workspace that owns local terminal tabs and sessions.

Link copied to clipboard

Host-neutral workspace events.

Link copied to clipboard
data class TerminalWorkspaceOpenOptions(val columns: Int, val rows: Int, val treatAmbiguousAsWide: Boolean, val maxHistory: Int, val pasteSanitizationPolicy: PasteSanitizationPolicy = PasteSanitizationPolicy.RAW, val shellIntegrationEnabled: Boolean = true, val hostPolicy: HostPolicy = HostPolicy(), val showForegroundProcessName: Boolean = true)

Initial terminal options for a workspace tab.

Link copied to clipboard

Open workspace tab and its running session.