Skip to content

API reference ​

Look up CLI commands, application methods, or a native manager below. For step-by-step setup, see Getting started.

Native managers ​

Access throughAvailable APIsReference
app.windowsCreate and find windows; title, size, position, visibility, focus, events, file drops and dragsWindows
app.dialogsOpen files and directories, save files, show messages, confirm, ask questions with custom buttonsDialogs
app.menusRegister menu definitions, create menus, find and update items, subscribe to actionsMenus
app.traysCreate status items, set icons and tooltips, attach menus, handle clicks, remove traysSystem trays
app.systemDetect the OS, read screen geometry and accent color, open or reveal paths in the file managerSystem

Native application support is currently macOS. Each reference lists its platform restrictions and calling context.

Application APIs ​

APILook up
CryKit::ApplicationLifecycle, configuration, managers, routes, assets and jobs
CryKit::ViewState, composition and callbacks
CryKit::LayoutDocument layouts
templateBindings, events, conditionals and lists
app.routes, app.handlersRoute and handler methods
app.assets, app.asset_pathAsset methods
app.async, app.broadcast_toApplication work and notifications
CryKit::TestingWindowless application testing

CLI commands ​

CommandPurpose
crykit init <app_name>Generate a new application
crykit devRun an application; add -w to watch source changes
crykit buildBuild an executable with embedded assets
crykit distPackage a macOS .app bundle
crykit --helpShow commands and options
crykit --versionPrint the CLI version

Built with Crystal. Documented with VitePress.