API reference
Look up CLI commands, application methods, or a native manager below. For step-by-step setup, see Getting started.
Native managers
| Access through | Available APIs | Reference |
|---|---|---|
app.windows | Create and find windows; title, size, position, visibility, focus, events, file drops and drags | Windows |
app.dialogs | Open files and directories, save files, show messages, confirm, ask questions with custom buttons | Dialogs |
app.menus | Register menu definitions, create menus, find and update items, subscribe to actions | Menus |
app.trays | Create status items, set icons and tooltips, attach menus, handle clicks, remove trays | System trays |
app.system | Detect the OS, read screen geometry and accent color, open or reveal paths in the file manager | System |
Native application support is currently macOS. Each reference lists its platform restrictions and calling context.
Application APIs
| API | Look up |
|---|---|
CryKit::Application | Lifecycle, configuration, managers, routes, assets and jobs |
CryKit::View | State, composition and callbacks |
CryKit::Layout | Document layouts |
template | Bindings, events, conditionals and lists |
app.routes, app.handlers | Route and handler methods |
app.assets, app.asset_path | Asset methods |
app.async, app.broadcast_to | Application work and notifications |
CryKit::Testing | Windowless application testing |
CLI commands
| Command | Purpose |
|---|---|
crykit init <app_name> | Generate a new application |
crykit dev | Run an application; add -w to watch source changes |
crykit build | Build an executable with embedded assets |
crykit dist | Package a macOS .app bundle |
crykit --help | Show commands and options |
crykit --version | Print the CLI version |