|
|
|
|
@@ -1,736 +0,0 @@
|
|
|
|
|
<h1 align="center">OpenAI LLMX CLI</h1>
|
|
|
|
|
<p align="center">Lightweight coding agent that runs in your terminal</p>
|
|
|
|
|
|
|
|
|
|
<p align="center"><code>npm i -g @llmx/llmx</code></p>
|
|
|
|
|
|
|
|
|
|
> [!IMPORTANT]
|
|
|
|
|
> This is the documentation for the _legacy_ TypeScript implementation of the LLMX CLI. It has been superseded by the _Rust_ implementation. See the [README in the root of the LLMX repository](https://github.com/valknar/llmx/blob/main/README.md) for details.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
|
<summary><strong>Table of contents</strong></summary>
|
|
|
|
|
|
|
|
|
|
<!-- Begin ToC -->
|
|
|
|
|
|
|
|
|
|
- [Experimental technology disclaimer](#experimental-technology-disclaimer)
|
|
|
|
|
- [Quickstart](#quickstart)
|
|
|
|
|
- [Why LLMX?](#why-llmx)
|
|
|
|
|
- [Security model & permissions](#security-model--permissions)
|
|
|
|
|
- [Platform sandboxing details](#platform-sandboxing-details)
|
|
|
|
|
- [System requirements](#system-requirements)
|
|
|
|
|
- [CLI reference](#cli-reference)
|
|
|
|
|
- [Memory & project docs](#memory--project-docs)
|
|
|
|
|
- [Non-interactive / CI mode](#non-interactive--ci-mode)
|
|
|
|
|
- [Tracing / verbose logging](#tracing--verbose-logging)
|
|
|
|
|
- [Recipes](#recipes)
|
|
|
|
|
- [Installation](#installation)
|
|
|
|
|
- [Configuration guide](#configuration-guide)
|
|
|
|
|
- [Basic configuration parameters](#basic-configuration-parameters)
|
|
|
|
|
- [Custom AI provider configuration](#custom-ai-provider-configuration)
|
|
|
|
|
- [History configuration](#history-configuration)
|
|
|
|
|
- [Configuration examples](#configuration-examples)
|
|
|
|
|
- [Full configuration example](#full-configuration-example)
|
|
|
|
|
- [Custom instructions](#custom-instructions)
|
|
|
|
|
- [Environment variables setup](#environment-variables-setup)
|
|
|
|
|
- [FAQ](#faq)
|
|
|
|
|
- [Zero data retention (ZDR) usage](#zero-data-retention-zdr-usage)
|
|
|
|
|
- [LLMX open source fund](#llmx-open-source-fund)
|
|
|
|
|
- [Contributing](#contributing)
|
|
|
|
|
- [Development workflow](#development-workflow)
|
|
|
|
|
- [Git hooks with Husky](#git-hooks-with-husky)
|
|
|
|
|
- [Debugging](#debugging)
|
|
|
|
|
- [Writing high-impact code changes](#writing-high-impact-code-changes)
|
|
|
|
|
- [Opening a pull request](#opening-a-pull-request)
|
|
|
|
|
- [Review process](#review-process)
|
|
|
|
|
- [Community values](#community-values)
|
|
|
|
|
- [Getting help](#getting-help)
|
|
|
|
|
- [Contributor license agreement (CLA)](#contributor-license-agreement-cla)
|
|
|
|
|
- [Quick fixes](#quick-fixes)
|
|
|
|
|
- [Releasing `llmx`](#releasing-llmx)
|
|
|
|
|
- [Alternative build options](#alternative-build-options)
|
|
|
|
|
- [Nix flake development](#nix-flake-development)
|
|
|
|
|
- [Security & responsible AI](#security--responsible-ai)
|
|
|
|
|
- [License](#license)
|
|
|
|
|
|
|
|
|
|
<!-- End ToC -->
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Experimental technology disclaimer
|
|
|
|
|
|
|
|
|
|
LLMX CLI is an experimental project under active development. It is not yet stable, may contain bugs, incomplete features, or undergo breaking changes. We're building it in the open with the community and welcome:
|
|
|
|
|
|
|
|
|
|
- Bug reports
|
|
|
|
|
- Feature requests
|
|
|
|
|
- Pull requests
|
|
|
|
|
- Good vibes
|
|
|
|
|
|
|
|
|
|
Help us improve by filing issues or submitting PRs (see the section below for how to contribute)!
|
|
|
|
|
|
|
|
|
|
## Quickstart
|
|
|
|
|
|
|
|
|
|
Install globally:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
npm install -g @llmx/llmx
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Next, set your OpenAI API key as an environment variable:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
export OPENAI_API_KEY="your-api-key-here"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
> **Note:** This command sets the key only for your current terminal session. You can add the `export` line to your shell's configuration file (e.g., `~/.zshrc`) but we recommend setting for the session. **Tip:** You can also place your API key into a `.env` file at the root of your project:
|
|
|
|
|
>
|
|
|
|
|
> ```env
|
|
|
|
|
> OPENAI_API_KEY=your-api-key-here
|
|
|
|
|
> ```
|
|
|
|
|
>
|
|
|
|
|
> The CLI will automatically load variables from `.env` (via `dotenv/config`).
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
|
<summary><strong>Use <code>--provider</code> to use other models</strong></summary>
|
|
|
|
|
|
|
|
|
|
> LLMX also allows you to use other providers that support the OpenAI Chat Completions API. You can set the provider in the config file or use the `--provider` flag. The possible options for `--provider` are:
|
|
|
|
|
>
|
|
|
|
|
> - openai (default)
|
|
|
|
|
> - openrouter
|
|
|
|
|
> - azure
|
|
|
|
|
> - gemini
|
|
|
|
|
> - ollama
|
|
|
|
|
> - mistral
|
|
|
|
|
> - deepseek
|
|
|
|
|
> - xai
|
|
|
|
|
> - groq
|
|
|
|
|
> - arceeai
|
|
|
|
|
> - any other provider that is compatible with the OpenAI API
|
|
|
|
|
>
|
|
|
|
|
> If you use a provider other than OpenAI, you will need to set the API key for the provider in the config file or in the environment variable as:
|
|
|
|
|
>
|
|
|
|
|
> ```shell
|
|
|
|
|
> export <provider>_API_KEY="your-api-key-here"
|
|
|
|
|
> ```
|
|
|
|
|
>
|
|
|
|
|
> If you use a provider not listed above, you must also set the base URL for the provider:
|
|
|
|
|
>
|
|
|
|
|
> ```shell
|
|
|
|
|
> export <provider>_BASE_URL="https://your-provider-api-base-url"
|
|
|
|
|
> ```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
Run interactively:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
llmx
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Or, run with a prompt as input (and optionally in `Full Auto` mode):
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
llmx "explain this codebase to me"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
llmx --approval-mode full-auto "create the fanciest todo-list app"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
That's it - LLMX will scaffold a file, run it inside a sandbox, install any
|
|
|
|
|
missing dependencies, and show you the live result. Approve the changes and
|
|
|
|
|
they'll be committed to your working directory.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Why LLMX?
|
|
|
|
|
|
|
|
|
|
LLMX CLI is built for developers who already **live in the terminal** and want
|
|
|
|
|
ChatGPT-level reasoning **plus** the power to actually run code, manipulate
|
|
|
|
|
files, and iterate - all under version control. In short, it's _chat-driven
|
|
|
|
|
development_ that understands and executes your repo.
|
|
|
|
|
|
|
|
|
|
- **Zero setup** - bring your OpenAI API key and it just works!
|
|
|
|
|
- **Full auto-approval, while safe + secure** by running network-disabled and directory-sandboxed
|
|
|
|
|
- **Multimodal** - pass in screenshots or diagrams to implement features ✨
|
|
|
|
|
|
|
|
|
|
And it's **fully open-source** so you can see and contribute to how it develops!
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Security model & permissions
|
|
|
|
|
|
|
|
|
|
LLMX lets you decide _how much autonomy_ the agent receives and auto-approval policy via the
|
|
|
|
|
`--approval-mode` flag (or the interactive onboarding prompt):
|
|
|
|
|
|
|
|
|
|
| Mode | What the agent may do without asking | Still requires approval |
|
|
|
|
|
| ------------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
|
|
|
| **Suggest** <br>(default) | <li>Read any file in the repo | <li>**All** file writes/patches<li> **Any** arbitrary shell commands (aside from reading files) |
|
|
|
|
|
| **Auto Edit** | <li>Read **and** apply-patch writes to files | <li>**All** shell commands |
|
|
|
|
|
| **Full Auto** | <li>Read/write files <li> Execute shell commands (network disabled, writes limited to your workdir) | - |
|
|
|
|
|
|
|
|
|
|
In **Full Auto** every command is run **network-disabled** and confined to the
|
|
|
|
|
current working directory (plus temporary files) for defense-in-depth. LLMX
|
|
|
|
|
will also show a warning/confirmation if you start in **auto-edit** or
|
|
|
|
|
**full-auto** while the directory is _not_ tracked by Git, so you always have a
|
|
|
|
|
safety net.
|
|
|
|
|
|
|
|
|
|
Coming soon: you'll be able to whitelist specific commands to auto-execute with
|
|
|
|
|
the network enabled, once we're confident in additional safeguards.
|
|
|
|
|
|
|
|
|
|
### Platform sandboxing details
|
|
|
|
|
|
|
|
|
|
The hardening mechanism LLMX uses depends on your OS:
|
|
|
|
|
|
|
|
|
|
- **macOS 12+** - commands are wrapped with **Apple Seatbelt** (`sandbox-exec`).
|
|
|
|
|
|
|
|
|
|
- Everything is placed in a read-only jail except for a small set of
|
|
|
|
|
writable roots (`$PWD`, `$TMPDIR`, `~/.llmx`, etc.).
|
|
|
|
|
- Outbound network is _fully blocked_ by default - even if a child process
|
|
|
|
|
tries to `curl` somewhere it will fail.
|
|
|
|
|
|
|
|
|
|
- **Linux** - there is no sandboxing by default.
|
|
|
|
|
We recommend using Docker for sandboxing, where LLMX launches itself inside a **minimal
|
|
|
|
|
container image** and mounts your repo _read/write_ at the same path. A
|
|
|
|
|
custom `iptables`/`ipset` firewall script denies all egress except the
|
|
|
|
|
OpenAI API. This gives you deterministic, reproducible runs without needing
|
|
|
|
|
root on the host. You can use the [`run_in_container.sh`](../llmx-cli/scripts/run_in_container.sh) script to set up the sandbox.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## System requirements
|
|
|
|
|
|
|
|
|
|
| Requirement | Details |
|
|
|
|
|
| --------------------------- | --------------------------------------------------------------- |
|
|
|
|
|
| Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 **via WSL2** |
|
|
|
|
|
| Node.js | **16 or newer** (Node 20 LTS recommended) |
|
|
|
|
|
| Git (optional, recommended) | 2.23+ for built-in PR helpers |
|
|
|
|
|
| RAM | 4-GB minimum (8-GB recommended) |
|
|
|
|
|
|
|
|
|
|
> Never run `sudo npm install -g`; fix npm permissions instead.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## CLI reference
|
|
|
|
|
|
|
|
|
|
| Command | Purpose | Example |
|
|
|
|
|
| ------------------------------------ | ----------------------------------- | ------------------------------------ |
|
|
|
|
|
| `llmx` | Interactive REPL | `llmx` |
|
|
|
|
|
| `llmx "..."` | Initial prompt for interactive REPL | `llmx "fix lint errors"` |
|
|
|
|
|
| `llmx -q "..."` | Non-interactive "quiet mode" | `llmx -q --json "explain utils.ts"` |
|
|
|
|
|
| `llmx completion <bash\|zsh\|fish>` | Print shell completion script | `llmx completion bash` |
|
|
|
|
|
|
|
|
|
|
Key flags: `--model/-m`, `--approval-mode/-a`, `--quiet/-q`, and `--notify`.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Memory & project docs
|
|
|
|
|
|
|
|
|
|
You can give LLMX extra instructions and guidance using `AGENTS.md` files. LLMX looks for `AGENTS.md` files in the following places, and merges them top-down:
|
|
|
|
|
|
|
|
|
|
1. `~/.llmx/AGENTS.md` - personal global guidance
|
|
|
|
|
2. `AGENTS.md` at repo root - shared project notes
|
|
|
|
|
3. `AGENTS.md` in the current working directory - sub-folder/feature specifics
|
|
|
|
|
|
|
|
|
|
Disable loading of these files with `--no-project-doc` or the environment variable `LLMX_DISABLE_PROJECT_DOC=1`.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Non-interactive / CI mode
|
|
|
|
|
|
|
|
|
|
Run LLMX head-less in pipelines. Example GitHub Action step:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: Update changelog via LLMX
|
|
|
|
|
run: |
|
|
|
|
|
npm install -g @llmx/llmx
|
|
|
|
|
export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
|
|
|
|
|
llmx -a auto-edit --quiet "update CHANGELOG for next release"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Set `LLMX_QUIET_MODE=1` to silence interactive UI noise.
|
|
|
|
|
|
|
|
|
|
## Tracing / verbose logging
|
|
|
|
|
|
|
|
|
|
Setting the environment variable `DEBUG=true` prints full API request and response details:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
DEBUG=true llmx
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Recipes
|
|
|
|
|
|
|
|
|
|
Below are a few bite-size examples you can copy-paste. Replace the text in quotes with your own task. See the [prompting guide](https://github.com/valknar/llmx/blob/main/llmx-cli/examples/prompting_guide.md) for more tips and usage patterns.
|
|
|
|
|
|
|
|
|
|
| ✨ | What you type | What happens |
|
|
|
|
|
| --- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
|
|
|
| 1 | `llmx "Refactor the Dashboard component to React Hooks"` | LLMX rewrites the class component, runs `npm test`, and shows the diff. |
|
|
|
|
|
| 2 | `llmx "Generate SQL migrations for adding a users table"` | Infers your ORM, creates migration files, and runs them in a sandboxed DB. |
|
|
|
|
|
| 3 | `llmx "Write unit tests for utils/date.ts"` | Generates tests, executes them, and iterates until they pass. |
|
|
|
|
|
| 4 | `llmx "Bulk-rename *.jpeg -> *.jpg with git mv"` | Safely renames files and updates imports/usages. |
|
|
|
|
|
| 5 | `llmx "Explain what this regex does: ^(?=.*[A-Z]).{8,}$"` | Outputs a step-by-step human explanation. |
|
|
|
|
|
| 6 | `llmx "Carefully review this repo, and propose 3 high impact well-scoped PRs"` | Suggests impactful PRs in the current codebase. |
|
|
|
|
|
| 7 | `llmx "Look for vulnerabilities and create a security review report"` | Finds and explains security bugs. |
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
<details open>
|
|
|
|
|
<summary><strong>From npm (Recommended)</strong></summary>
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm install -g @llmx/llmx
|
|
|
|
|
# or
|
|
|
|
|
yarn global add @llmx/llmx
|
|
|
|
|
# or
|
|
|
|
|
bun install -g @llmx/llmx
|
|
|
|
|
# or
|
|
|
|
|
pnpm add -g @llmx/llmx
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
|
<summary><strong>Build from source</strong></summary>
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Clone the repository and navigate to the CLI package
|
|
|
|
|
git clone https://github.com/valknar/llmx.git
|
|
|
|
|
cd llmx/llmx-cli
|
|
|
|
|
|
|
|
|
|
# Enable corepack
|
|
|
|
|
corepack enable
|
|
|
|
|
|
|
|
|
|
# Install dependencies and build
|
|
|
|
|
pnpm install
|
|
|
|
|
pnpm build
|
|
|
|
|
|
|
|
|
|
# Linux-only: download prebuilt sandboxing binaries (requires gh and zstd).
|
|
|
|
|
./scripts/install_native_deps.sh
|
|
|
|
|
|
|
|
|
|
# Get the usage and the options
|
|
|
|
|
node ./dist/cli.js --help
|
|
|
|
|
|
|
|
|
|
# Run the locally-built CLI directly
|
|
|
|
|
node ./dist/cli.js
|
|
|
|
|
|
|
|
|
|
# Or link the command globally for convenience
|
|
|
|
|
pnpm link
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Configuration guide
|
|
|
|
|
|
|
|
|
|
LLMX configuration files can be placed in the `~/.llmx/` directory, supporting both YAML and JSON formats.
|
|
|
|
|
|
|
|
|
|
### Basic configuration parameters
|
|
|
|
|
|
|
|
|
|
| Parameter | Type | Default | Description | Available Options |
|
|
|
|
|
| ------------------- | ------- | ---------- | -------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | string | `o4-mini` | AI model to use | Any model name supporting OpenAI API |
|
|
|
|
|
| `approvalMode` | string | `suggest` | AI assistant's permission mode | `suggest` (suggestions only)<br>`auto-edit` (automatic edits)<br>`full-auto` (fully automatic) |
|
|
|
|
|
| `fullAutoErrorMode` | string | `ask-user` | Error handling in full-auto mode | `ask-user` (prompt for user input)<br>`ignore-and-continue` (ignore and proceed) |
|
|
|
|
|
| `notify` | boolean | `true` | Enable desktop notifications | `true`/`false` |
|
|
|
|
|
|
|
|
|
|
### Custom AI provider configuration
|
|
|
|
|
|
|
|
|
|
In the `providers` object, you can configure multiple AI service providers. Each provider requires the following parameters:
|
|
|
|
|
|
|
|
|
|
| Parameter | Type | Description | Example |
|
|
|
|
|
| --------- | ------ | --------------------------------------- | ----------------------------- |
|
|
|
|
|
| `name` | string | Display name of the provider | `"OpenAI"` |
|
|
|
|
|
| `baseURL` | string | API service URL | `"https://api.openai.com/v1"` |
|
|
|
|
|
| `envKey` | string | Environment variable name (for API key) | `"OPENAI_API_KEY"` |
|
|
|
|
|
|
|
|
|
|
### History configuration
|
|
|
|
|
|
|
|
|
|
In the `history` object, you can configure conversation history settings:
|
|
|
|
|
|
|
|
|
|
| Parameter | Type | Description | Example Value |
|
|
|
|
|
| ------------------- | ------- | ------------------------------------------------------ | ------------- |
|
|
|
|
|
| `maxSize` | number | Maximum number of history entries to save | `1000` |
|
|
|
|
|
| `saveHistory` | boolean | Whether to save history | `true` |
|
|
|
|
|
| `sensitivePatterns` | array | Patterns of sensitive information to filter in history | `[]` |
|
|
|
|
|
|
|
|
|
|
### Configuration examples
|
|
|
|
|
|
|
|
|
|
1. YAML format (save as `~/.llmx/config.yaml`):
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
model: o4-mini
|
|
|
|
|
approvalMode: suggest
|
|
|
|
|
fullAutoErrorMode: ask-user
|
|
|
|
|
notify: true
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. JSON format (save as `~/.llmx/config.json`):
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"model": "o4-mini",
|
|
|
|
|
"approvalMode": "suggest",
|
|
|
|
|
"fullAutoErrorMode": "ask-user",
|
|
|
|
|
"notify": true
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Full configuration example
|
|
|
|
|
|
|
|
|
|
Below is a comprehensive example of `config.json` with multiple custom providers:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"model": "o4-mini",
|
|
|
|
|
"provider": "openai",
|
|
|
|
|
"providers": {
|
|
|
|
|
"openai": {
|
|
|
|
|
"name": "OpenAI",
|
|
|
|
|
"baseURL": "https://api.openai.com/v1",
|
|
|
|
|
"envKey": "OPENAI_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"azure": {
|
|
|
|
|
"name": "AzureOpenAI",
|
|
|
|
|
"baseURL": "https://YOUR_PROJECT_NAME.openai.azure.com/openai",
|
|
|
|
|
"envKey": "AZURE_OPENAI_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"openrouter": {
|
|
|
|
|
"name": "OpenRouter",
|
|
|
|
|
"baseURL": "https://openrouter.ai/api/v1",
|
|
|
|
|
"envKey": "OPENROUTER_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"gemini": {
|
|
|
|
|
"name": "Gemini",
|
|
|
|
|
"baseURL": "https://generativelanguage.googleapis.com/v1beta/openai",
|
|
|
|
|
"envKey": "GEMINI_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"ollama": {
|
|
|
|
|
"name": "Ollama",
|
|
|
|
|
"baseURL": "http://localhost:11434/v1",
|
|
|
|
|
"envKey": "OLLAMA_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"mistral": {
|
|
|
|
|
"name": "Mistral",
|
|
|
|
|
"baseURL": "https://api.mistral.ai/v1",
|
|
|
|
|
"envKey": "MISTRAL_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"deepseek": {
|
|
|
|
|
"name": "DeepSeek",
|
|
|
|
|
"baseURL": "https://api.deepseek.com",
|
|
|
|
|
"envKey": "DEEPSEEK_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"xai": {
|
|
|
|
|
"name": "xAI",
|
|
|
|
|
"baseURL": "https://api.x.ai/v1",
|
|
|
|
|
"envKey": "XAI_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"groq": {
|
|
|
|
|
"name": "Groq",
|
|
|
|
|
"baseURL": "https://api.groq.com/openai/v1",
|
|
|
|
|
"envKey": "GROQ_API_KEY"
|
|
|
|
|
},
|
|
|
|
|
"arceeai": {
|
|
|
|
|
"name": "ArceeAI",
|
|
|
|
|
"baseURL": "https://conductor.arcee.ai/v1",
|
|
|
|
|
"envKey": "ARCEEAI_API_KEY"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"history": {
|
|
|
|
|
"maxSize": 1000,
|
|
|
|
|
"saveHistory": true,
|
|
|
|
|
"sensitivePatterns": []
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Custom instructions
|
|
|
|
|
|
|
|
|
|
You can create a `~/.llmx/AGENTS.md` file to define custom guidance for the agent:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
- Always respond with emojis
|
|
|
|
|
- Only use git commands when explicitly requested
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Environment variables setup
|
|
|
|
|
|
|
|
|
|
For each AI provider, you need to set the corresponding API key in your environment variables. For example:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# OpenAI
|
|
|
|
|
export OPENAI_API_KEY="your-api-key-here"
|
|
|
|
|
|
|
|
|
|
# Azure OpenAI
|
|
|
|
|
export AZURE_OPENAI_API_KEY="your-azure-api-key-here"
|
|
|
|
|
export AZURE_OPENAI_API_VERSION="2025-04-01-preview" (Optional)
|
|
|
|
|
|
|
|
|
|
# OpenRouter
|
|
|
|
|
export OPENROUTER_API_KEY="your-openrouter-key-here"
|
|
|
|
|
|
|
|
|
|
# Similarly for other providers
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## FAQ
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
|
<summary>OpenAI released a model called LLMX in 2021 - is this related?</summary>
|
|
|
|
|
|
|
|
|
|
In 2021, OpenAI released LLMX, an AI system designed to generate code from natural language prompts. That original LLMX model was deprecated as of March 2023 and is separate from the CLI tool.
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
|
<summary>Which models are supported?</summary>
|
|
|
|
|
|
|
|
|
|
Any model available with [Responses API](https://platform.openai.com/docs/api-reference/responses). The default is `o4-mini`, but pass `--model gpt-4.1` or set `model: gpt-4.1` in your config file to override.
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<details>
|
|
|
|
|
<summary>Why does <code>o3</code> or <code>o4-mini</code> not work for me?</summary>
|
|
|
|
|
|
|
|
|
|
It's possible that your [API account needs to be verified](https://help.openai.com/en/articles/10910291-api-organization-verification) in order to start streaming responses and seeing chain of thought summaries from the API. If you're still running into issues, please let us know!
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
|
<summary>How do I stop LLMX from editing my files?</summary>
|
|
|
|
|
|
|
|
|
|
LLMX runs model-generated commands in a sandbox. If a proposed command or file change doesn't look right, you can simply type **n** to deny the command or give the model feedback.
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<details>
|
|
|
|
|
<summary>Does it work on Windows?</summary>
|
|
|
|
|
|
|
|
|
|
Not directly. It requires [Windows Subsystem for Linux (WSL2)](https://learn.microsoft.com/en-us/windows/wsl/install) - LLMX is regularly tested on macOS and Linux with Node 20+, and also supports Node 16.
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Zero data retention (ZDR) usage
|
|
|
|
|
|
|
|
|
|
LLMX CLI **does** support OpenAI organizations with [Zero Data Retention (ZDR)](https://platform.openai.com/docs/guides/your-data#zero-data-retention) enabled. If your OpenAI organization has Zero Data Retention enabled and you still encounter errors such as:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
OpenAI rejected the request. Error details: Status: 400, Code: unsupported_parameter, Type: invalid_request_error, Message: 400 Previous response cannot be used for this organization due to Zero Data Retention.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You may need to upgrade to a more recent version with: `npm i -g @llmx/llmx@latest`
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## LLMX open source fund
|
|
|
|
|
|
|
|
|
|
We're excited to launch a **$1 million initiative** supporting open source projects that use LLMX CLI and other OpenAI models.
|
|
|
|
|
|
|
|
|
|
- Grants are awarded up to **$25,000** API credits.
|
|
|
|
|
- Applications are reviewed **on a rolling basis**.
|
|
|
|
|
|
|
|
|
|
**Interested? [Apply here](https://openai.com/form/llmx-open-source-fund/).**
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
This project is under active development and the code will likely change pretty significantly. We'll update this message once that's complete!
|
|
|
|
|
|
|
|
|
|
More broadly we welcome contributions - whether you are opening your very first pull request or you're a seasoned maintainer. At the same time we care about reliability and long-term maintainability, so the bar for merging code is intentionally **high**. The guidelines below spell out what "high-quality" means in practice and should make the whole process transparent and friendly.
|
|
|
|
|
|
|
|
|
|
### Development workflow
|
|
|
|
|
|
|
|
|
|
- Create a _topic branch_ from `main` - e.g. `feat/interactive-prompt`.
|
|
|
|
|
- Keep your changes focused. Multiple unrelated fixes should be opened as separate PRs.
|
|
|
|
|
- Use `pnpm test:watch` during development for super-fast feedback.
|
|
|
|
|
- We use **Vitest** for unit tests, **ESLint** + **Prettier** for style, and **TypeScript** for type-checking.
|
|
|
|
|
- Before pushing, run the full test/type/lint suite:
|
|
|
|
|
|
|
|
|
|
### Git hooks with Husky
|
|
|
|
|
|
|
|
|
|
This project uses [Husky](https://typicode.github.io/husky/) to enforce code quality checks:
|
|
|
|
|
|
|
|
|
|
- **Pre-commit hook**: Automatically runs lint-staged to format and lint files before committing
|
|
|
|
|
- **Pre-push hook**: Runs tests and type checking before pushing to the remote
|
|
|
|
|
|
|
|
|
|
These hooks help maintain code quality and prevent pushing code with failing tests. For more details, see [HUSKY.md](./HUSKY.md).
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
pnpm test && pnpm run lint && pnpm run typecheck
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- If you have **not** yet signed the Contributor License Agreement (CLA), add a PR comment containing the exact text
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
I have read the CLA Document and I hereby sign the CLA
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The CLA-Assistant bot will turn the PR status green once all authors have signed.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Watch mode (tests rerun on change)
|
|
|
|
|
pnpm test:watch
|
|
|
|
|
|
|
|
|
|
# Type-check without emitting files
|
|
|
|
|
pnpm typecheck
|
|
|
|
|
|
|
|
|
|
# Automatically fix lint + prettier issues
|
|
|
|
|
pnpm lint:fix
|
|
|
|
|
pnpm format:fix
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Debugging
|
|
|
|
|
|
|
|
|
|
To debug the CLI with a visual debugger, do the following in the `llmx-cli` folder:
|
|
|
|
|
|
|
|
|
|
- Run `pnpm run build` to build the CLI, which will generate `cli.js.map` alongside `cli.js` in the `dist` folder.
|
|
|
|
|
- Run the CLI with `node --inspect-brk ./dist/cli.js` The program then waits until a debugger is attached before proceeding. Options:
|
|
|
|
|
- In VS Code, choose **Debug: Attach to Node Process** from the command palette and choose the option in the dropdown with debug port `9229` (likely the first option)
|
|
|
|
|
- Go to <chrome://inspect> in Chrome and find **localhost:9229** and click **trace**
|
|
|
|
|
|
|
|
|
|
### Writing high-impact code changes
|
|
|
|
|
|
|
|
|
|
1. **Start with an issue.** Open a new one or comment on an existing discussion so we can agree on the solution before code is written.
|
|
|
|
|
2. **Add or update tests.** Every new feature or bug-fix should come with test coverage that fails before your change and passes afterwards. 100% coverage is not required, but aim for meaningful assertions.
|
|
|
|
|
3. **Document behaviour.** If your change affects user-facing behaviour, update the README, inline help (`llmx --help`), or relevant example projects.
|
|
|
|
|
4. **Keep commits atomic.** Each commit should compile and the tests should pass. This makes reviews and potential rollbacks easier.
|
|
|
|
|
|
|
|
|
|
### Opening a pull request
|
|
|
|
|
|
|
|
|
|
- Fill in the PR template (or include similar information) - **What? Why? How?**
|
|
|
|
|
- Run **all** checks locally (`npm test && npm run lint && npm run typecheck`). CI failures that could have been caught locally slow down the process.
|
|
|
|
|
- Make sure your branch is up-to-date with `main` and that you have resolved merge conflicts.
|
|
|
|
|
- Mark the PR as **Ready for review** only when you believe it is in a merge-able state.
|
|
|
|
|
|
|
|
|
|
### Review process
|
|
|
|
|
|
|
|
|
|
1. One maintainer will be assigned as a primary reviewer.
|
|
|
|
|
2. We may ask for changes - please do not take this personally. We value the work, we just also value consistency and long-term maintainability.
|
|
|
|
|
3. When there is consensus that the PR meets the bar, a maintainer will squash-and-merge.
|
|
|
|
|
|
|
|
|
|
### Community values
|
|
|
|
|
|
|
|
|
|
- **Be kind and inclusive.** Treat others with respect; we follow the [Contributor Covenant](https://www.contributor-covenant.org/).
|
|
|
|
|
- **Assume good intent.** Written communication is hard - err on the side of generosity.
|
|
|
|
|
- **Teach & learn.** If you spot something confusing, open an issue or PR with improvements.
|
|
|
|
|
|
|
|
|
|
### Getting help
|
|
|
|
|
|
|
|
|
|
If you run into problems setting up the project, would like feedback on an idea, or just want to say _hi_ - please open a Discussion or jump into the relevant issue. We are happy to help.
|
|
|
|
|
|
|
|
|
|
Together we can make LLMX CLI an incredible tool. **Happy hacking!** :rocket:
|
|
|
|
|
|
|
|
|
|
### Contributor license agreement (CLA)
|
|
|
|
|
|
|
|
|
|
All contributors **must** accept the CLA. The process is lightweight:
|
|
|
|
|
|
|
|
|
|
1. Open your pull request.
|
|
|
|
|
2. Paste the following comment (or reply `recheck` if you've signed before):
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
I have read the CLA Document and I hereby sign the CLA
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3. The CLA-Assistant bot records your signature in the repo and marks the status check as passed.
|
|
|
|
|
|
|
|
|
|
No special Git commands, email attachments, or commit footers required.
|
|
|
|
|
|
|
|
|
|
#### Quick fixes
|
|
|
|
|
|
|
|
|
|
| Scenario | Command |
|
|
|
|
|
| ----------------- | ------------------------------------------------ |
|
|
|
|
|
| Amend last commit | `git commit --amend -s --no-edit && git push -f` |
|
|
|
|
|
|
|
|
|
|
The **DCO check** blocks merges until every commit in the PR carries the footer (with squash this is just the one).
|
|
|
|
|
|
|
|
|
|
### Releasing `llmx`
|
|
|
|
|
|
|
|
|
|
To publish a new version of the CLI you first need to stage the npm package. A
|
|
|
|
|
helper script in `llmx-cli/scripts/` does all the heavy lifting. Inside the
|
|
|
|
|
`llmx-cli` folder run:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Classic, JS implementation that includes small, native binaries for Linux sandboxing.
|
|
|
|
|
pnpm stage-release
|
|
|
|
|
|
|
|
|
|
# Optionally specify the temp directory to reuse between runs.
|
|
|
|
|
RELEASE_DIR=$(mktemp -d)
|
|
|
|
|
pnpm stage-release --tmp "$RELEASE_DIR"
|
|
|
|
|
|
|
|
|
|
# "Fat" package that additionally bundles the native Rust CLI binaries for
|
|
|
|
|
# Linux. End-users can then opt-in at runtime by setting LLMX_RUST=1.
|
|
|
|
|
pnpm stage-release --native
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Go to the folder where the release is staged and verify that it works as intended. If so, run the following from the temp folder:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
cd "$RELEASE_DIR"
|
|
|
|
|
npm publish
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Alternative build options
|
|
|
|
|
|
|
|
|
|
#### Nix flake development
|
|
|
|
|
|
|
|
|
|
Prerequisite: Nix >= 2.4 with flakes enabled (`experimental-features = nix-command flakes` in `~/.config/nix/nix.conf`).
|
|
|
|
|
|
|
|
|
|
Enter a Nix development shell:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Use either one of the commands according to which implementation you want to work with
|
|
|
|
|
nix develop .#llmx-cli # For entering llmx-cli specific shell
|
|
|
|
|
nix develop .#llmx-rs # For entering llmx-rs specific shell
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This shell includes Node.js, installs dependencies, builds the CLI, and provides a `llmx` command alias.
|
|
|
|
|
|
|
|
|
|
Build and run the CLI directly:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Use either one of the commands according to which implementation you want to work with
|
|
|
|
|
nix build .#llmx-cli # For building llmx-cli
|
|
|
|
|
nix build .#llmx-rs # For building llmx-rs
|
|
|
|
|
./result/bin/llmx --help
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Run the CLI via the flake app:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Use either one of the commands according to which implementation you want to work with
|
|
|
|
|
nix run .#llmx-cli # For running llmx-cli
|
|
|
|
|
nix run .#llmx-rs # For running llmx-rs
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Use direnv with flakes
|
|
|
|
|
|
|
|
|
|
If you have direnv installed, you can use the following `.envrc` to automatically enter the Nix shell when you `cd` into the project directory:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd llmx-rs
|
|
|
|
|
echo "use flake ../flake.nix#llmx-cli" >> .envrc && direnv allow
|
|
|
|
|
cd llmx-cli
|
|
|
|
|
echo "use flake ../flake.nix#llmx-rs" >> .envrc && direnv allow
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Security & responsible AI
|
|
|
|
|
|
|
|
|
|
Have you discovered a vulnerability or have concerns about model output? Please e-mail **security@openai.com** and we will respond promptly.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
This repository is licensed under the [Apache-2.0 License](LICENSE).
|
Sebastian Krüger