Documentation

Documentation lives in the repository, in English, next to the code.

  • Architecture

    How the daemon keeps its state, how the orchestrator and the nodes work, and how the screens read it.

  • The device protocol

    How a device authenticates to a Mac, how requests travel as sealed envelopes and how the daemon reports direct and relayed connections.

  • Installing

    The install guide in the repository, with the apps and what to do when something fails.

  • Building from source

    The Xcode and Bazel versions you need, and how to build the daemon and the apps with your own developer account.

  • Running the tests

    Tests run only through Bazel. This page lists the commands for each part of the repository.

  • Contributing

    The terms for contributions, where pull requests go and where to report a crash.

The command line

alondra  # set up, or open the terminal appalondra doctor  # check what worksalondra doctor --fix  # repair what it canalondra update  # install the newest releasealondra metrics  # how tasks went, by project or model

The overview on how Alondra works explains the pieces these commands talk to.