inkdex docs

Troubleshooting

Fix the usual problems: license, index, proxies, slow runs.

License

MessageFix
no inkdex license on this machineinkdex license activate <key>, or set INKDEX_KEY (workstation) / INKDEX_TOKEN (CI).
mlab.sh does not know this license keyThe key was mistyped or rotated. Get the current one from RedKit › Code › Inkdex.
your inkdex license is suspended / revokedAsk an administrator of your organization.
Your inkdex license does not include …The command needs a capability your license lacks. inkdex license status lists what it includes.
this inkdex is older than your license acceptsUpdate the packages (apt upgrade inkdex inkdex-vuln, dnf upgrade inkdex inkdex-vuln).
mlab.sh cannot be reached and there is no valid licenseinkdex needs to reach mlab.sh at least every 3 days. Check the network and the proxy below.
the system clock is earlier than the last inkdex runSet the clock right (NTP), then run again.

Behind a proxy

inkdex uses the standard proxy variables:

export HTTPS_PROXY=http://proxy.example.com:3128

It must be able to reach https://mlab.sh over HTTPS.

Index

ProblemFix
no inkdex index at …Run inkdex init then inkdex index in the repository, or pass -C <dir> / --index <path>.
waiting for the index lock held by process …Another inkdex (often inkdex watch) is writing the index. It waits, then goes on. Stop the other process if it is stuck.
A file is missing from the indexIt may be ignored (.gitignore, .inkdexignore, default_ignores), too large (max_file_size), or in a language not in langs.
The index looks wrong after an updateinkdex doctor checks it; inkdex index --full reads every file again.

Slow runs

  • The first index reads everything; the next ones only what changed. In CI, cache .inkdex/ between jobs (see CI/CD).
  • Skip what you do not need to scan (docs/, generated code) with .inkdexignore.
  • inkdex index --jobs N sets the number of threads.

Getting help

When you contact mlab.sh, include:

  • inkdex --version;
  • inkdex license status;
  • the command you ran and its output;
  • for a finding: its rule and fingerprint.

RUST_LOG=inkdex=debug adds a debug log on stderr.

On this page