Install and First Run

Sailwright is a command-line tool that sets up, tests, and repairs developer machines on macOS, Windows, and Linux with Ansible.

Start here

1. Follow the Quick Start on GitHub: download the release binary for your OS and run sailwright install.
2. Preview what would change on this machine: sailwright provision local --check.
3. Apply it: sailwright provision local.

Steps for macOS and Windows, and for cloning the repository instead, are in the README’s Getting Started section.

Guides

• Local Provisioning: apply the default playbook to the machine you’re on.
• Testing Workflows: build, create, provision, and destroy disposable VMs on each host OS.
• Running Playbooks: run playbooks/setup.yml directly from the repository, also against remote hosts.
• Ansible Role Sources: put your team’s roles in front of the bundled example roles.
• Example Roles: the roles that ship with Sailwright.
• Windows Ansible Access: reach a Windows machine over Ansible when it has no remote transport yet.
• Managed Application Data: where Sailwright keeps build state, caches, and runtime assets.
• Troubleshooting: rare, host-specific issues.

These guides are synced from the Sailwright repository. To propose a change, open a pull request there.