Connectors¶

Connectors enable pyinfra to integrate with other tools out of the box. Connectors can do one of three things:

• Implement how commands are executed (@ssh, @local)
• Generate inventory hosts and data (@terraform and @vagrant)
• Both of the above (@docker, @podman, and other container connectors)

All built-in connector pages are listed below. Each page contains examples and the data used to configure the connector.

Want a new connector? Check out the writing connectors guide.

Available connectors¶

• @chroot: Execute operations within another root.
• @docker: Create or modify Docker containers.
• @dockerssh: Run commands in Docker containers on a remote machine.
• @fake: Simulate command execution and file transfers locally.
• @local: Connect to the local machine running pyinfra.
• @podman: Create or modify Podman containers.
• @podmanssh: Run commands in Podman containers on a remote machine over SSH.
• @ssh: Connect to any SSH server.
• @terraform: Get SSH targets from Terraform output.
• @vagrant: Generate inventory from running Vagrant VMs.