API Reference

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

Package structure

Package	Description
`com.klyx.api.plugin`	Core plugin interfaces, lifecycle, descriptors
`com.klyx.api.ui`	Screen registration, toolbar, toasts
`com.klyx.api.ui.theme`	Colors, typography, fonts
`com.klyx.api.service`	Plugin services: settings, fonts, tabs
`com.klyx.api.data.editor`	Editor actions, file openers, workspace tabs
`com.klyx.api.data.file`	`KxFile` — cross-abstraction file wrapper
`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/editor capabilities
`com.klyx.api.system`	Process execution, command builder
`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.platform`	Architecture detection
`com.klyx.api.util`	General utility functions

Add the API as a compileOnly dependency:

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

How to access Klyx services

Read, write, and manage files

Run shell commands and programs