llmx/README.md at main

Files

Sebastian Krüger c9f903a83e fix: Correct environment variables and documentation links in README

- Fixed environment variable names from LITELLM_* to LLMX_*
  - LITELLM_BASE_URL → LLMX_BASE_URL
  - LITELLM_API_KEY → LLMX_API_KEY
- Updated all documentation links to use absolute GitHub URLs instead of relative paths
  - Fixes 404 errors when viewing README on npm registry
  - All ./docs/ and ./LITELLM-SETUP.md links now point to github.com/valknarthing/llmx

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

2025-11-13 12:18:31 +01:00

5.1 KiB

Raw Permalink Blame History

npm i -g @valknarthing/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/codex

Quickstart

Installing and running LLMX CLI

Install globally with npm:

npm install -g @valknarthing/llmx

Then simply run llmx to get started:

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
Linux
- x86_64: llmx-x86_64-unknown-linux-musl.tar.gz
- arm64: llmx-aarch64-unknown-linux-musl.tar.gz

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 LLMX_BASE_URL="http://localhost:4000/v1"
export LLMX_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

License

This repository is licensed under the Apache-2.0 License.

5.1 KiB Raw Permalink Blame History