Installation

Homebrew

brew install periphery-pro/tap/periphery-cli

The formula installs the periphery executable.

Caution

The periphery-cli formula conflicts with the periphery formula in homebrew-core, as both install an executable named periphery. The homebrew-core formula installs the legacy open-source version. If you have it installed, remove it first with brew uninstall periphery.

Once installed, run periphery auth login for an interactive scan, provide an access token for an automated scan, or use the free public OSS workflow. See Authentication.

Bazel

Add rules_periphery to your MODULE.bazel and configure the Periphery binary to scan with:

bazel_dep(name = "rules_periphery", version = "0.1.0", dev_dependency = True)

periphery = use_extension("@rules_periphery//:extensions.bzl", "periphery", dev_dependency = True)
periphery.binary_archive(
    url = "https://github.com/periphery-pro/cli-releases/releases/download/<version>/periphery-cli_<version>_<os>_<arch>.zip",
    sha256 = "...",
)
use_repo(periphery, "periphery_generated")

Replace <os> with macos or linux, and <arch> with arm64 or x86_64, to select the archive for the machine that runs Bazel.

Alternatively, use a binary from your local machine with periphery.local_binary(path = "...").

See Build Systems for usage instructions.