User guide

This section contains in-depth guides organized by mode, plus shared scripting fundamentals and CLI tools.

• Embedding mode: Use Mechanical directly in your Python process with the App class.

• Remote session mode: Launch Mechanical as a server and communicate with gRPC.

• Scripting fundamentals (both modes): Explore Mechanical API concepts, recording, and threading, which are all topics applying to both modes.

• Command Line Interface (CLI): Discover command-line utilities for launching, discovering, and configuring Mechanical.

If you are not sure which mode to use, see Choose your mode.