Skip to content
adhere

Install

Add adhere to your repo’s dev dependencies, and run it with npx adhere or bunx adhere:

Terminal window
npm install -D @drkmttr/adhere

Or install the standalone executable, which needs no Node or Bun:

Terminal window
curl -fsSL https://github.com/darkmatter/adhere/raw/main/scripts/install.sh | sh
  • The npm package includes the TypeScript compiler that type awareness needs. The standalone executable does not, so it runs every audit except type-aware ones. It suits a global install that your agent config can always call.
  • The install script puts this machine’s executable from the latest release in ~/.local/bin. Run it again to update. The executable is built for macOS and Linux, on arm64 and x64, and for Windows x64: download adhere-Windows-x86_64.exe from the release.
  • adhere sends each file it judges to Jev at api.typesafe.ai, with what it reads beside it, authenticated with a TypeSafe AI API key.

Login

Section titled “Login”
Terminal window
adhere login             # prompts for the key, masking what you type
adhere login < key.txt   # reads it from stdin instead
adhere logout            # deletes the saved key
adhere login --openai    # saves an OpenAI API key, for the openai provider
adhere logout --openai   # deletes it, and only it
  • The key is saved to ~/.config/adhere/credentials.json, or under $XDG_CONFIG_HOME when that is set, readable only by you. An OpenAI key is saved beside the TypeSafe AI one, for a config whose provider is openai(); see Providers.
  • TYPESAFE_API_KEY, when set, takes precedence over the saved key, so CI can pass a key without a login. OPENAI_API_KEY does the same for the saved OpenAI key.
  • The key is read only when a request is about to be sent. A run that the cache answers in full needs no key and no network.