provision.sh to run the full workstation setup, scaffold.sh to generate a new module skeleton, and test.sh to verify the current state of your machine. Everything else runs automatically inside those scripts.
provision.sh
provision.sh is the main entry point for Orchard. Running it executes every install module in sequence, then runs the full test suite to confirm everything completed successfully. You run this once to set up a new machine, and can safely re-run it at any time — modules that are already installed are skipped.
Usage
- macOS
- An active internet connection (needed to download Homebrew, packages, and applications)
provision.sh runs the following modules in order:
After all modules run,
provision.sh automatically calls test.sh to validate the result.
What success looks like
Each module prints its progress to the terminal. After all modules complete, you will see Bats test output confirming each module’s tests passed. The script exits with code 0 and returns you to the shell prompt with no error output.
scaffold.sh
scaffold.sh creates a new module directory with a ready-to-edit install.sh script and a test.bats test file. Use it whenever you want to add a new provisioning module to Orchard.
Usage
string
required
The name of the new module. This becomes the directory name. Use lowercase kebab-case to match the existing module naming convention (for example,
git-config or ssh-keys).install.sh contains a single shebang line with set -euo pipefail already set. The generated test.bats contains one placeholder test that fails by design — a reminder to write a real test before running provision.sh.
What success looks like
The command exits silently with no output. You will see the new directory appear in the Orchard root. Open <resource-name>/install.sh to write your installation logic, and <resource-name>/test.bats to write the corresponding test.
After scaffolding a new module, you must manually add it to the
install_scripts array in provision.sh for it to run during provisioning.test.sh
test.sh runs the Bats test suite across all modules. provision.sh calls it automatically at the end of a full provisioning run, but you can also run it independently at any time to check the current state of your machine.
Usage
test.sh first ensures bats is installed by running bats/install.sh, then discovers and runs every test.bats file found in the module directories.
What success looks like
Bats prints one line per test. Passing tests are prefixed with ✓ and failing tests with ✗. A fully provisioned machine should show all tests passing with exit code 0.