Command Reference¶
find-people¶
Lists all team members across all sites you have access to.
Usage:
Output:
- Creates ~/site_list_people.csv with site, email, and role information
CSV Columns: - Site: The Pantheon site name - Email: Team member's email address - Role: Their role on the site
find-upstreams¶
Discovers all upstreams used by sites in an organization.
Usage:
Arguments:
- organization - Your Pantheon organization name
Output: - Lists all upstreams with their IDs, names, frameworks, and site counts
add-org¶
Add a supporting organization to sites in your Pantheon organization.
Usage:
Arguments:
- organization - Your Pantheon organization name
- supporting-org - The supporting organization to add
Options:
| Option | Description |
|---|---|
-u, --upstream ID |
Filter by upstream ID (optional, processes all sites if not specified) |
-d, --dry-run |
Perform a dry run without making changes |
-c, --csv FILE |
Export results to a CSV file |
-v, --verbose |
Enable verbose output for debugging |
Examples:
Process all sites:
Filter by upstream:
Dry run with CSV export:
Logging:
- Creates pantheon_org_update_YYYYMMDD_HHMMSS.log in current directory
site-inventory¶
Generate a detailed inventory report of all sites in your organization.
Usage:
Arguments:
- organization - Your Pantheon organization name
Options:
| Option | Description |
|---|---|
-c, --csv FILE |
Export results to CSV file (default: stdout) |
-v, --verbose |
Enable verbose output for debugging |
Examples:
Output to stdout:
Export to CSV:
With verbose logging:
CSV Columns: - Site Name: The Pantheon site name - Upstream: Upstream name or UUID - WordPress Version: Core version (WordPress sites only) - PHP Version: PHP version on live environment - Public URL: Custom domain or platform domain - Pantheon Dashboard URL: Direct link to dashboard - Plan: Site plan name - Status: Active or Frozen - Created date: Site creation timestamp - Owner: Owner email address
Logging:
- Creates pantheon_site_inventory_YYYYMMDD_HHMMSS.log in current directory