Quickstart

Installing and running LLMX CLI

Install globally with npm:

npm install -g @valknarthing/llmx

Then simply run llmx to get started:

llmx

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

• Getting started
  • CLI usage
  • Slash Commands
  • Running with a prompt as input
  • Example prompts
  • Custom prompts
  • Memory with AGENTS.md
• Configuration
  • Example config
• Sandbox & approvals
• Authentication
  • Auth methods
  • Login on a "Headless" machine
• Automating LLMX
  • GitHub Action
  • TypeScript SDK
  • Non-interactive mode (llmx exec)
• Advanced
  • Tracing / verbose logging
  • Model Context Protocol (MCP)
• Zero data retention (ZDR)
• Contributing
• Install & build
  • System Requirements
  • DotSlash
  • Build from source
• FAQ

License

This repository is licensed under the Apache-2.0 License.