Getting started
1. Install
The recommended install path is pipx, which isolates placemy and its
dependencies in a dedicated virtual environment without touching your
system Python.
pipx install placemy
placemy version
Prefer a single-file binary? Grab the latest from the download page. Linux, macOS, and Windows builds are published on every release.
2. Activate your licence
You'll have received a licence key by email after checkout. It
looks like PM-ABCDE-FGHJK-MNPQR-STVWX-YZ234. Activate it once per
machine:
placemy auth login
The command prompts for the key, validates it against
placemy.cloud, and caches the result in ~/.placemy/licence.json.
Subsequent runs re-validate in the background once a week, so you can
work offline for up to 30 days between validations.
Check at any time:
placemy auth status
3. Point it at a cloud
placemy uses the credential chain your existing tools already respect.
If aws sts get-caller-identity, az account show, or
gcloud auth list work, placemy will work.
4. Run your first scan
placemy scan --output report.html
The scan has three passes, in order:
- Untangle — reads every resource in the account
- Optimise — scores each resource against the engine rules
- Place — writes the drafted recommendations to
report.html
Open report.html in any browser. Hand it to a colleague. The JSON
sibling at report.json is there for pipelines.
Next
- Bootstrap your cloud — provision the one bucket placemy needs to keep scan state across runs.
- Sync & state bucket — share scan state with a team.