API Reference

Overview of all Klyx extension APIs

Klyx exposes its extension APIs through the klyx-api module. All APIs live in the com.klyx.api package tree, with supporting core APIs in com.klyx.core.

Package structure

Package	Description
com.klyx.api.plugin	Core plugin interfaces, lifecycle, descriptors, context receivers
com.klyx.api.service	Plugin services: Logger, Settings, Fonts, Tabs
com.klyx.api.ui	Screen and toolbar registration, toast notifications
com.klyx.api.ui.theme	Colors, typography, fonts
com.klyx.api.data.editor	File openers, workspace tabs, editor actions
com.klyx.api.data.runner	File runners: run files from the editor toolbar
com.klyx.api.data.file	KxFile — cross-abstraction file model
com.klyx.api.data.fs	FileSystem service, capabilities, paths
com.klyx.api.data.terminal	Terminal sessions, session management
com.klyx.api.data.preferences	App settings models
com.klyx.api.data.diagnostics	Device and editor capabilities
com.klyx.api.data.log	Log entry and log level models
com.klyx.api.system	Process execution, command builder, pipelines
com.klyx.api.terminal	Terminal environment utilities
com.klyx.api.event	Event bus and event types
com.klyx.api.lsp	Language server protocol integration
com.klyx.api.language	Tree-sitter grammar registration
com.klyx.api.platform	Architecture detection
com.klyx.api.util	General utility functions
com.klyx.api	Navigator, NavDestination, InternalKlyxApi, DiscouragedInSuspend
com.klyx.core	App, Global, LocalApp
com.klyx.core.event	EventBus, Priority, EventSubscription, config

Service access patterns

Klyx provides two service delegate patterns:

// Global PluginService — shared across all plugins
private val screens: ScreenRegistry by plugin()
private val settings: Settings by plugin()

// Per-plugin PluginRuntimeService — scoped to this plugin instance
private val info: PluginInfo by runtime()
private val context: PluginContext by runtime()
private val lifecycleOwner: PluginLifecycleOwner by runtime()

Within suspend functions and coroutines, use context-aware functions instead of delegates:

val ctx = currentPluginContext()
val owner = currentLifecycleOwner()

Registration with context receivers

Methods that register resources use Kotlin context receivers. The KlyxPlugin instance is provided as a context parameter, eliminating the need to pass this explicitly:

screens.register(Screen(ScreenId("myext.main")) { MainScreen() })
toolbar.register(ToolbarAction(id = "myext.action", label = "Action", onClick = {}) {})
openers.register(MyFileOpener() {})
languageServers.register("py") { client -> MyLspServer(client) }

Dependency

Add the API as a compileOnly dependency:

dependencies {
    compileOnly("io.github.klyx-dev:klyx-api:4.2.0-SNAPSHOT")
}

Related pages

Services & DI

How to access Klyx services via delegates and context functions

Screens & Navigation

Register composable screens and navigate between destinations

Toolbar

Add custom toolbar actions to the app UI

File System

Read, write, and manage files across SAF and local storage

Editor & Tabs

File openers, workspace tabs, and editor actions

Terminal

Create and manage terminal sessions

File Runners

Run files from the editor toolbar

Process Execution

Run shell commands, spawn processes, and stream output

Events

Subscribe to app events and publish custom events

Settings

Read and update application settings

Plugin Settings

Typed per-plugin settings and optional settings screens

Language Server

Register LSP providers for custom languages

Language Grammars

Register tree-sitter syntax highlighting grammars

Utilities

Helper functions for context, formatting, and more