This repository hosts the public release binaries, installation script, and Homebrew formula for Purplemet CLI, a command-line tool for running web application security analyses via the Purplemet platform.
The source code is maintained on a separate GitLab repository and will be made public soon.
🛡️ New to Purplemet? It's an Attack Surface Management platform — discover your web assets, scan them for vulnerabilities, and track your security posture over time. Dive into the official documentation to learn more, or explore the API reference.
Installation
Binary (Linux / macOS / Windows)
curl -sSL https://github.com/Purplemet/cli/releases/latest/download/install.sh | sh
Or download the binary directly from Releases.
Homebrew (macOS / Linux)
brew tap Purplemet/cli https://github.com/Purplemet/cli.git
brew install purplemet-cli
Docker
docker run --rm -e PURPLEMET_API_TOKEN=<token> ppmsupport/purplemet-cli analyze https://your-app.com
CI/CD Integrations
Purplemet CLI ships ready-to-use integrations for the major CI/CD platforms:
| Platform | Type | Guide |
|---|---|---|
| GitHub Actions | Composite Action | Documentation |
| GitLab CI/CD | Include Template | Documentation |
| Bitbucket Pipelines | Docker Pipe | Documentation |
| Jenkins | Shared Library | Documentation |
| Azure DevOps | Marketplace Extension | Documentation |
Only the Jenkins shared library is hosted in this repository (under
integrations/jenkins, as required by the Jenkins Global Pipeline Library). The other integrations are published to their own marketplaces and registries — follow each guide above.
Documentation
- CLI documentation: Wiki — full guides, configuration, exit codes, CI/CD integrations
- Platform documentation: cloud.purplemet.com/docs
- API reference: api.purplemet.com
- Run
purplemet-cli --helpfor command usage.