llmx/README.md at ca37c07257872040ea76e4fc0a10e6a4c6930df1

Files

Sebastian Krüger ca37c07257 chore: Remove OpenAI branding and references

Update project branding to reflect community fork status:

- Changed welcome message from "OpenAI's command-line coding agent"
  to "your command-line coding agent"
- Updated system prompt from "led by OpenAI" to "community project"
- Removed broken developers.openai.com/llmx documentation URLs
- Updated Windows setup instructions with correct npm package name
- Removed OpenAI CLA (not applicable to community fork)
- Removed OpenAI open source fund documentation
- Updated config docs to remove managed configuration references
- Changed npm package reference from @openai/llmx to @valknarthing/llmx

These changes complete the rebranding from OpenAI's project to an
independent community fork while maintaining proper attribution to
the original project in README.md.

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

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

2025-11-13 10:52:57 +01:00

3.8 KiB

Raw 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 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

License

This repository is licensed under the Apache-2.0 License.

3.8 KiB Raw Blame History