Skip to main content
Adist is distributed as an npm package and can be installed globally to use across all your projects.

​
Prerequisites

Before installing Adist, ensure you have:
  • Node.js version 16 or higher
  • npm (comes with Node.js)

​
Install Adist

Install Adist globally using npm: 
npm install -g adist
Verify the installation by checking the version: 
adist --version

​
Configure LLM provider

Adist requires an LLM provider for AI-powered features like summarization, queries, and chat. You have three options:
1

Choose your LLM provider

Decide which provider works best for you:
  • Anthropic Claude - Powerful cloud-based models (requires API key)
  • OpenAI - GPT models with excellent performance (requires API key)
  • Ollama - Run models locally with no API costs (requires local installation)
2

Set up your chosen provider

Set your Anthropic API key as an environment variable:
export ANTHROPIC_API_KEY='your-api-key-here'
Add this to your .bashrc, .zshrc, or .bash_profile to make it persistent across terminal sessions.
Get your API key from Anthropic Console.
3

Run LLM configuration command

Configure Adist to use your chosen provider:
adist llm-config
This interactive command will guide you through:
  • Selecting your LLM provider (Anthropic, OpenAI, or Ollama)
  • Choosing your preferred model
  • Customizing settings (like Ollama API URL)

​
Verify installation

Check that Adist is properly installed and accessible: 
adist --version
You should see output showing the version number and available commands.

​
Update Adist

To update Adist to the latest version: 
npm update -g adist
Because Adist is in active development, breaking changes may occur between versions. Check the release notes before updating.

​
Uninstall Adist

If you need to uninstall Adist: 
npm uninstall -g adist
This removes the CLI tool but does not delete your project configurations. To remove all Adist data: 
rm -rf ~/Library/Application\ Support/adist

​
Troubleshooting

If you get a “command not found” error after installing:
  1. Make sure npm’s global bin directory is in your PATH
  2. Try running npm bin -g to see where global packages are installed
  3. Add that directory to your PATH if it’s not already there
For example, add this to your .bashrc or .zshrc:
export PATH="$(npm bin -g):$PATH"
If you encounter permission errors:
  1. Don’t use sudo - this can cause permission issues
  2. Configure npm to use a different directory for global packages
  3. Use a Node version manager like nvm or fnm
See npm documentation for detailed solutions.
If your LLM provider isn’t working:
  1. Verify your API key is set correctly: echo $ANTHROPIC_API_KEY or echo $OPENAI_API_KEY
  2. For Ollama, ensure the service is running: ollama list
  3. Run adist llm-config to reconfigure your provider

​
Next steps

Quick start guide

Learn how to initialize your first project and start using Adist

Build docs developers (and LLMs) love

Get started for freeTalk to us