The build_npm_package.py script now accepts '@valknarthing/llmx' as a valid --package argument and normalizes it to 'llmx' internally for processing. This allows the workflow to use the full scoped package name for clarity while maintaining backward compatibility with the 'llmx' identifier.
npm i -g @valknarthing/llmx
or brew install --cask llmx
LLMX CLI is a coding agent powered by LiteLLM that runs locally on your computer.
This project is a community fork with enhanced support for multiple LLM providers via LiteLLM.
Original project: github.com/openai/llmx
Quickstart
Installing and running LLMX CLI
Install globally with your preferred package manager. If you use npm:
npm install -g @valknarthing/llmx
Alternatively, if you use Homebrew:
brew install --cask llmx
Then simply run llmx to get started:
llmx
If you're running into upgrade issues with Homebrew, see the FAQ entry on brew upgrade llmx.
You can also go to the latest GitHub Release and download the appropriate binary for your platform.
Each GitHub Release contains many executables, but in practice, you likely want one of these:
- macOS
- Apple Silicon/arm64:
llmx-aarch64-apple-darwin.tar.gz - x86_64 (older Mac hardware):
llmx-x86_64-apple-darwin.tar.gz
- Apple Silicon/arm64:
- Linux
- x86_64:
llmx-x86_64-unknown-linux-musl.tar.gz - arm64:
llmx-aarch64-unknown-linux-musl.tar.gz
- x86_64:
Each archive contains a single entry with the platform baked into the name (e.g., llmx-x86_64-unknown-linux-musl), so you likely want to rename it to llmx after extracting it.
Using LLMX with LiteLLM
LLMX is powered by LiteLLM, which provides access to 100+ LLM providers including OpenAI, Anthropic, Google, Azure, AWS Bedrock, and more.
Quick Start with LiteLLM:
# Set your LiteLLM server URL (default: http://localhost:4000/v1)
export LITELLM_BASE_URL="http://localhost:4000/v1"
export LITELLM_API_KEY="your-api-key"
# Run LLMX
llmx "hello world"
Configuration: See LITELLM-SETUP.md for detailed setup instructions.
You can also use LLMX with ChatGPT or OpenAI API keys. For authentication options, see the authentication docs.
Model Context Protocol (MCP)
LLMX can access MCP servers. To configure them, refer to the config docs.
Configuration
LLMX CLI supports a rich set of configuration options, with preferences stored in ~/.llmx/config.toml. For full configuration options, see Configuration.
Docs & FAQ
- Getting started
- Configuration
- Sandbox & approvals
- Authentication
- Automating LLMX
- Advanced
- Zero data retention (ZDR)
- Contributing
- Install & build
- FAQ
- Open source fund
License
This repository is licensed under the Apache-2.0 License.
