inkdex docs

Install

Install inkdex and inkdex-vuln from mlab's package repositories: apt.mlab.sh for Debian and Ubuntu, pkg.mlab.sh for Fedora, RHEL and openSUSE.

inkdex ships as two packages, inkdex and inkdex-vuln, each one self-contained binary: no runtime, no database server, no container. They are published in mlab's signed package repositories, the same ones as the other mlab tools:

  • apt.mlab.sh for Debian and Ubuntu (apt);
  • pkg.mlab.sh for Fedora, RHEL, Rocky, Alma and openSUSE (dnf / zypper).

Both are available for amd64 (x86_64) and arm64.

Debian, Ubuntu (apt)

Add the mlab repository

sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://apt.mlab.sh/mlab.asc -o /etc/apt/keyrings/mlab.asc
sudo tee /etc/apt/sources.list.d/mlab.sources >/dev/null <<'SOURCES'
Types: deb
URIs: https://apt.mlab.sh
Suites: stable
Components: main
Architectures: amd64 arm64
Signed-By: /etc/apt/keyrings/mlab.asc
SOURCES

Check the signing key

gpg --show-keys --with-fingerprint /etc/apt/keyrings/mlab.asc

The fingerprint must be 717894BC C0E057E4 F9BBF3CA C0E287DD 9609A065.

Install

sudo apt update
sudo apt install inkdex inkdex-vuln
inkdex --version

Fedora, RHEL, Rocky, Alma (dnf)

sudo curl -fsSL https://pkg.mlab.sh/rpm/mlab.repo -o /etc/yum.repos.d/mlab.repo
sudo dnf install inkdex inkdex-vuln

On the first install dnf asks you to confirm the signing key: its fingerprint must be 717894BC C0E057E4 F9BBF3CA C0E287DD 9609A065, the same key as apt.

openSUSE (zypper)

sudo zypper addrepo https://pkg.mlab.sh/rpm/mlab.repo
sudo zypper install inkdex inkdex-vuln

Both binaries

Install both packages: inkdex explores and indexes, inkdex-vuln adds scan. Installed side by side, inkdex vuln … runs inkdex-vuln …, so you can type everything with inkdex.

Shell completion

inkdex completions bash | sudo tee /etc/bash_completion.d/inkdex >/dev/null    # bash
inkdex completions zsh > "${fpath[1]}/_inkdex"                                 # zsh
inkdex completions fish > ~/.config/fish/completions/inkdex.fish

Updating

sudo apt update && sudo apt upgrade inkdex inkdex-vuln     # apt
sudo dnf upgrade inkdex inkdex-vuln                         # dnf

Your indexes are kept: the next inkdex index re-reads only what the new version reads differently. Your organization may require a minimum version; an older binary then says so and asks you to update.

Next

Activate your license.

On this page