Installation

The Aperture CLI provides a convenient way to interact with Aperture. It can be used to generate a policy, apply a policy, list policies, and perform other operations such as listing connected agents, listing flow control points and preview samples of flow labels or HTTP requests on control points. Its use cases extend beyond the aforementioned operations. Detailed documentation is available on the aperturectl reference page.

The Aperture CLI, compatible with all major platforms, is accessible as an executable program. Binaries for the CLI can be obtained from the GitHub Release Page.

Alternatively, it can also be downloaded using the following script:

dpkg

VERSION="main"
ARCH="amd64"
PACKAGER="deb"
url="https://github.com/fluxninja/aperture/releases/download/v${VERSION}/aperturectl_${VERSION}_${ARCH}.${PACKAGER}"
echo "Will download ${PACKAGER} package version ${VERSION} compiled for ${ARCH} machine"
curl --fail --location --remote-name "${url}"

rpm

VERSION="main"
ARCH="x86_64"
PACKAGER="rpm"
url="https://github.com/fluxninja/aperture/releases/download/v${VERSION}/aperturectl-${VERSION}.${ARCH}.${PACKAGER}"
echo "Will download ${PACKAGER} package version ${VERSION} compiled for ${ARCH} machine"
curl --fail --location --remote-name "${url}"

binary

# Substitute BIN for your bin directory.
VERSION="main"
BIN="/usr/local/bin"
OS="$(uname | tr '[:upper:]' '[:lower:]')"
ARCH="$(uname -m)"
case "$ARCH" in
  x86_64) ARCH="amd64";;
  aarch64) ARCH="arm64";;
  *) echo "Unsupported architecture: $ARCH"; exit 1;;
esac
echo "Will download $OS package version $VERSION compiled for $ARCH machine"
url="https://github.com/fluxninja/aperture/releases/download/v${VERSION}/aperturectl-${VERSION}-${OS}-${ARCH}"
curl --fail --location --remote-name "${url}"
mv aperturectl* "${BIN}/aperturectl"
chmod +x "${BIN}/aperturectl"

Installation

info

Skip the following steps if you have obtained the binary file directly using the steps mentioned above.

macOS

With Homebrew:

brew install fluxninja/aperture/aperturectl

Linux

With Homebrew:

brew install fluxninja/aperture/aperturectl

With dpkg:

sudo dpkg -i aperturectl_main*.deb

With rpm:

sudo rpm -i aperturectl-main*.rpm

Enable shell autocompletion

To configure your shell to load aperturectl bash completions, add to your profile:

bash

source <(aperturectl completion bash)

zsh

source <(aperturectl completion zsh); compdef _aperturectl aperturectl

fish

aperturectl completion fish | source

powershell

aperturectl completion powershell | Out-String | Invoke-Expression

Uninstall

macOS

With Homebrew:

brew uninstall aperturectl
brew untap fluxninja/aperture

Linux

With Homebrew:

brew uninstall aperturectl
brew untap fluxninja/aperture

With dpkg:

sudo dpkg -r aperturectl

With rpm:

sudo rpm -e aperturectl

---

aperturectl