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

API Reference

The generated API reference is grouped by public interface:

  • Core API covers test declarations, plugins, and plain-flake usage.
  • Terminal and Machine API covers the shared terminal interface, workspaces, and machine-only configuration and command assertions.
  • Fixture API covers semantic fixtures, locators, and actions.
  • Assertion API lists matcher signatures and accepted targets.

API pages are generated from documentation beside the Nix implementation. See Contributing to the Docs before editing the reference.