Skip to content

API Reference

Crona clients communicate with the local daemon through a request/response socket API. This reference is organized by responsibility so you can find the contract for a feature without reading one large method catalogue.

  1. Read Transport and Envelopes to connect and decode messages.
  2. Call kernel.info.get and compare its protocolVersion with the client-supported version.
  3. Subscribe with events.subscribe before rendering live state.
  4. Use the domain references below for request names, payloads, results, and side effects.
Area Covers
Transport and Envelopes Local endpoints, request/response envelopes, errors, and compatibility.
Runtime and Operations Health, daemon lifecycle, updates, alerts, and operations history.
Work Management Repositories, streams, issues, habits, and daily planning.
Focus and Wellbeing Sessions, timers, context, check-ins, momentum, dashboards, and metrics.
Exports and Settings Reports, calendars, settings, and export configuration.
Events Subscription behavior and events emitted as state changes.
  • The current local IPC protocol is 1.6. It is independent of the Crona release version; beta additions may not be available on stable daemons.
  • The canonical method names are defined in shared/protocol/methods.go.
  • Request and response DTOs are defined in shared/dto.
  • Before 1.0.0, generated clients should prefer the shared Go types over assumptions from prose.
  • This is a local API, not a remotely exposed network service.

The domain pages above are the canonical API reference. Use the source repository when you need implementation details beyond the public contract.