Skip to content

Developer documentation

  • Architecture: packages and how they fit together.
  • SSH: the Go-native SSH client, sign-in and the shared connection.
  • TUI: the terminal interface and its Charm libraries.
  • Desktop app (GUI): the Wails app, its build and self-test.
  • Voice: the planned "Hey Labmill" design.
  • Testing: how tests are organized and run.
  • Security: the protections that exist in the code.
  • Site profiles: the Site.yaml and Cluster.yaml schema.
  • Where knowledge lives: skills against site profiles.
  • CI: the GitHub Actions workflows.

The design rules are in CLAUDE.md at the repository root.

Building and checking

make check   # gofmt, go vet, go test, cross-compile for Windows and macOS
make build   # bin/labmill
make docs    # zensical build --strict

Go 1.26 or newer is required. With GOTOOLCHAIN=auto (the default), an older go command downloads the right toolchain automatically.