Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Generated Files

Activation writes the operational helper files into ~/.local/state/hb.

Important files include:

  • bootstrap-keys.sh
  • bootstrap-machine.sh
  • builder-image/Containerfile when imageContainerfile is set
  • proxy.sh
  • start-container.sh
  • stop-container.sh
  • reset-container.sh
  • ssh-wrapper.sh
  • ssh_config
  • ssh_config_root
  • known_hosts
  • machine-generation
  • hexbox-readiness.log
  • hb

These files are the practical runtime interface to the builder. They are generated from the active Nix configuration and should not be edited manually.

By default, the builder image is pulled from GHCR. When services.container-builder.imageContainerfile is set, activation copies that Containerfile here and hb builder repair / start-container.sh build the custom image locally when its tag is missing. If imageBuildContext is set, it must be an absolute host path string and is passed directly to Apple container build.

machine-generation records the image contract used to create the current Apple container machine. If it differs from the active Nix configuration, start-container.sh recreates the machine, deleting the guest-local /nix store.

The repository copy of assets/hb.sh is also generated. Edit scripts/hb.sh and regenerate assets/hb.sh instead of changing the built helper directly.

The checked-in shell completion assets under assets/completions/ are part of the hb distribution path. The module installs them through Nix’s installShellCompletion hook into the standard shell completion directories instead of mutating user shell dotfiles.