valknar/llmx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

use "Title case" in README.md (#798)

Browse Source
This commit is contained in:
Andrey Mishchenko
2025-05-03 13:17:44 -04:00
committed by GitHub
parent 0442458309
commit 4b61fb8bab
1 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
README.md
View File

@@ -12,44 +12,44 @@
<!-- Begin ToC --> <!-- Begin ToC -->
- [Experimental Technology Disclaimer](#experimental-technology-disclaimer) - [Experimental technology disclaimer](#experimental-technology-disclaimer)
- [Quickstart](#quickstart) - [Quickstart](#quickstart)
- [Why Codex?](#why-codex) - [Why Codex?](#why-codex)
- [Security Model & Permissions](#security-model--permissions) - [Security model & permissions](#security-model--permissions)
- [Platform sandboxing details](#platform-sandboxing-details) - [Platform sandboxing details](#platform-sandboxing-details)
- [System Requirements](#system-requirements) - [System requirements](#system-requirements)
- [CLI Reference](#cli-reference) - [CLI reference](#cli-reference)
- [Memory & Project Docs](#memory--project-docs) - [Memory & project docs](#memory--project-docs)
- [Non-interactive / CI mode](#non-interactive--ci-mode) - [Non-interactive / CI mode](#non-interactive--ci-mode)
- [Tracing / Verbose Logging](#tracing--verbose-logging) - [Tracing / verbose logging](#tracing--verbose-logging)
- [Recipes](#recipes) - [Recipes](#recipes)
- [Installation](#installation) - [Installation](#installation)
- [Configuration Guide](#configuration-guide) - [Configuration guide](#configuration-guide)
- [Basic Configuration Parameters](#basic-configuration-parameters) - [Basic configuration parameters](#basic-configuration-parameters)
- [Custom AI Provider Configuration](#custom-ai-provider-configuration) - [Custom AI provider configuration](#custom-ai-provider-configuration)
- [History Configuration](#history-configuration) - [History configuration](#history-configuration)
- [Configuration Examples](#configuration-examples) - [Configuration examples](#configuration-examples)
- [Full Configuration Example](#full-configuration-example) - [Full configuration example](#full-configuration-example)
- [Custom Instructions](#custom-instructions) - [Custom instructions](#custom-instructions)
- [Environment Variables Setup](#environment-variables-setup) - [Environment variables setup](#environment-variables-setup)
- [FAQ](#faq) - [FAQ](#faq)
- [Zero Data Retention (ZDR) Usage](#zero-data-retention-zdr-usage) - [Zero data retention (ZDR) usage](#zero-data-retention-zdr-usage)
- [Codex Open Source Fund](#codex-open-source-fund) - [Codex open source fund](#codex-open-source-fund)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Development workflow](#development-workflow) - [Development workflow](#development-workflow)
- [Git Hooks with Husky](#git-hooks-with-husky) - [Git hooks with Husky](#git-hooks-with-husky)
- [Debugging](#debugging) - [Debugging](#debugging)
- [Writing high-impact code changes](#writing-high-impact-code-changes) - [Writing high-impact code changes](#writing-high-impact-code-changes)
- [Opening a pull request](#opening-a-pull-request) - [Opening a pull request](#opening-a-pull-request)
- [Review process](#review-process) - [Review process](#review-process)
- [Community values](#community-values) - [Community values](#community-values)
- [Getting help](#getting-help) - [Getting help](#getting-help)
- [Contributor License Agreement (CLA)](#contributor-license-agreement-cla) - [Contributor license agreement (CLA)](#contributor-license-agreement-cla)
- [Quick fixes](#quick-fixes) - [Quick fixes](#quick-fixes)
- [Releasing `codex`](#releasing-codex) - [Releasing `codex`](#releasing-codex)
- [Alternative Build Options](#alternative-build-options) - [Alternative build options](#alternative-build-options)
- [Nix Flake Development](#nix-flake-development) - [Nix flake development](#nix-flake-development)
- [Security & Responsible AI](#security--responsible-ai) - [Security & responsible AI](#security--responsible-ai)
- [License](#license) - [License](#license)
<!-- End ToC --> <!-- End ToC -->
@@ -58,7 +58,7 @@
--- ---
## Experimental Technology Disclaimer ## Experimental technology disclaimer
Codex 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: Codex 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:
@@ -158,7 +158,7 @@ And it's **fully open-source** so you can see and contribute to how it develops!
--- ---
## Security Model & Permissions ## Security model & permissions
Codex lets you decide _how much autonomy_ the agent receives and auto-approval policy via the Codex lets you decide _how much autonomy_ the agent receives and auto-approval policy via the
`--approval-mode` flag (or the interactive onboarding prompt): `--approval-mode` flag (or the interactive onboarding prompt):
@@ -198,7 +198,7 @@ The hardening mechanism Codex uses depends on your OS:
--- ---
## System Requirements ## System requirements
| Requirement | Details | | Requirement | Details |
| --------------------------- | --------------------------------------------------------------- | | --------------------------- | --------------------------------------------------------------- |
@@ -211,7 +211,7 @@ The hardening mechanism Codex uses depends on your OS:
--- ---
## CLI Reference ## CLI reference
| Command | Purpose | Example | | Command | Purpose | Example |
| ------------------------------------ | ----------------------------------- | ------------------------------------ | | ------------------------------------ | ----------------------------------- | ------------------------------------ |
@@ -224,7 +224,7 @@ Key flags: `--model/-m`, `--approval-mode/-a`, `--quiet/-q`, and `--notify`.
--- ---
## Memory & Project Docs ## Memory & project docs
Codex merges Markdown instructions in this order: Codex merges Markdown instructions in this order:
@@ -250,7 +250,7 @@ Run Codex head-less in pipelines. Example GitHub Action step:
Set `CODEX_QUIET_MODE=1` to silence interactive UI noise. Set `CODEX_QUIET_MODE=1` to silence interactive UI noise.
## Tracing / Verbose Logging ## Tracing / verbose logging
Setting the environment variable `DEBUG=true` prints full API request and response details: Setting the environment variable `DEBUG=true` prints full API request and response details:
@@ -325,11 +325,11 @@ pnpm link
--- ---
## Configuration Guide ## Configuration guide
Codex configuration files can be placed in the `~/.codex/` directory, supporting both YAML and JSON formats. Codex configuration files can be placed in the `~/.codex/` directory, supporting both YAML and JSON formats.
### Basic Configuration Parameters ### Basic configuration parameters
| Parameter | Type | Default | Description | Available Options | | Parameter | Type | Default | Description | Available Options |
| ------------------- | ------- | ---------- | -------------------------------- | ---------------------------------------------------------------------------------------------- | | ------------------- | ------- | ---------- | -------------------------------- | ---------------------------------------------------------------------------------------------- |
@@ -338,7 +338,7 @@ Codex configuration files can be placed in the `~/.codex/` directory, supporting
| `fullAutoErrorMode` | string | `ask-user` | Error handling in full-auto mode | `ask-user` (prompt for user input)<br>`ignore-and-continue` (ignore and proceed) | | `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` | | `notify` | boolean | `true` | Enable desktop notifications | `true`/`false` |
### Custom AI Provider Configuration ### Custom AI provider configuration
In the `providers` object, you can configure multiple AI service providers. Each provider requires the following parameters: In the `providers` object, you can configure multiple AI service providers. Each provider requires the following parameters:
@@ -348,7 +348,7 @@ In the `providers` object, you can configure multiple AI service providers. Each
| `baseURL` | string | API service URL | `"https://api.openai.com/v1"` | | `baseURL` | string | API service URL | `"https://api.openai.com/v1"` |
| `envKey` | string | Environment variable name (for API key) | `"OPENAI_API_KEY"` | | `envKey` | string | Environment variable name (for API key) | `"OPENAI_API_KEY"` |
### History Configuration ### History configuration
In the `history` object, you can configure conversation history settings: In the `history` object, you can configure conversation history settings:
@@ -358,7 +358,7 @@ In the `history` object, you can configure conversation history settings:
| `saveHistory` | boolean | Whether to save history | `true` | | `saveHistory` | boolean | Whether to save history | `true` |
| `sensitivePatterns` | array | Patterns of sensitive information to filter in history | `[]` | | `sensitivePatterns` | array | Patterns of sensitive information to filter in history | `[]` |
### Configuration Examples ### Configuration examples
1. YAML format (save as `~/.codex/config.yaml`): 1. YAML format (save as `~/.codex/config.yaml`):
@@ -380,7 +380,7 @@ notify: true
} }
``` ```
### Full Configuration Example ### Full configuration example
Below is a comprehensive example of `config.json` with multiple custom providers: Below is a comprehensive example of `config.json` with multiple custom providers:
@@ -438,7 +438,7 @@ Below is a comprehensive example of `config.json` with multiple custom providers
} }
``` ```
### Custom Instructions ### Custom instructions
You can create a `~/.codex/instructions.md` file to define custom instructions: You can create a `~/.codex/instructions.md` file to define custom instructions:
@@ -447,7 +447,7 @@ You can create a `~/.codex/instructions.md` file to define custom instructions:
- Only use git commands when explicitly requested - Only use git commands when explicitly requested
``` ```
### Environment Variables Setup ### Environment variables setup
For each AI provider, you need to set the corresponding API key in your environment variables. For example: For each AI provider, you need to set the corresponding API key in your environment variables. For example:
@@ -500,7 +500,7 @@ Not directly. It requires [Windows Subsystem for Linux (WSL2)](https://learn.mic
--- ---
## Zero Data Retention (ZDR) Usage ## Zero data retention (ZDR) usage
Codex 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: Codex 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:
@@ -512,7 +512,7 @@ You may need to upgrade to a more recent version with: `npm i -g @openai/codex@l
--- ---
## Codex Open Source Fund ## Codex open source fund
We're excited to launch a **$1 million initiative** supporting open source projects that use Codex CLI and other OpenAI models. We're excited to launch a **$1 million initiative** supporting open source projects that use Codex CLI and other OpenAI models.
@@ -537,7 +537,7 @@ More broadly we welcome contributions - whether you are opening your very first
- We use **Vitest** for unit tests, **ESLint** + **Prettier** for style, and **TypeScript** for type-checking. - We use **Vitest** for unit tests, **ESLint** + **Prettier** for style, and **TypeScript** for type-checking.
- Before pushing, run the full test/type/lint suite: - Before pushing, run the full test/type/lint suite:
### Git Hooks with Husky ### Git hooks with Husky
This project uses [Husky](https://typicode.github.io/husky/) to enforce code quality checks: This project uses [Husky](https://typicode.github.io/husky/) to enforce code quality checks:
@@ -611,7 +611,7 @@ If you run into problems setting up the project, would like feedback on an idea,
Together we can make Codex CLI an incredible tool. **Happy hacking!** :rocket: Together we can make Codex CLI an incredible tool. **Happy hacking!** :rocket:
### Contributor License Agreement (CLA) ### Contributor license agreement (CLA)
All contributors **must** accept the CLA. The process is lightweight: All contributors **must** accept the CLA. The process is lightweight:
@@ -656,9 +656,9 @@ cd "$RELEASE_DIR"
npm publish npm publish
``` ```
### Alternative Build Options ### Alternative build options
#### Nix Flake Development #### Nix flake development
Prerequisite: Nix >= 2.4 with flakes enabled (`experimental-features = nix-command flakes` in `~/.config/nix/nix.conf`). Prerequisite: Nix >= 2.4 with flakes enabled (`experimental-features = nix-command flakes` in `~/.config/nix/nix.conf`).
@@ -685,7 +685,7 @@ nix run .#codex
--- ---
## Security & Responsible AI ## 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. Have you discovered a vulnerability or have concerns about model output? Please e-mail **security@openai.com** and we will respond promptly.