Codex AI 编程工具

Codex 是一个类似于 Claude Code、Codex 和 Droid 的基于 CLI 的 AI 编程工具，旨在提供高效的编程辅助和知识管理功能。

项目概述

Codex 是一个基于 Rust 开发的 CLI 工具，提供以下核心功能：

AI 编程辅助：支持多种 AI 平台，包括 OpenAI、Anthropic、Google Gemini 等
本地代码知识库：使用 Tantivy 全文搜索索引本地代码，支持快速查询
网页抓取：支持远程知识抓取和索引
交互式 UI：使用 Ratatui 提供终端交互式界面
工具系统：基于 YAML 的工具系统，支持内置工具和外部工具扩展
提示词管理：支持自定义提示词模板和变量替换

技术栈

主语言: Rust
CLI 框架: Clap
UI 框架: Ratatui + Crossterm
知识库: Tantivy (全文搜索) + Sled (元数据存储)
AI 集成: Reqwest + Serde
网页抓取: Scraper
代码解析: Tree-sitter
异步运行时: Tokio
配置管理: Serde + TOML/YAML
工具系统: YAML 格式调用 + 内置工具集

安装

使用安装脚本（推荐）

Codex 提供了跨平台的安装脚本，支持 Unix/Linux、macOS 和 Windows 系统：

# Unix/Linux/macOS
curl -sSL https://raw.githubusercontent.com/lyxamour/codex/main/scripts/install/install.sh | bash

# Windows
# 下载并运行 codex_installer.exe

使用 Homebrew（macOS）

brew tap lyxamour/codex
brew install codex

使用 APT（Debian/Ubuntu）

sudo apt-get update
sudo apt-get install -y codex

从源码构建

# 克隆仓库
git clone https://github.com/lyxamour/codex.git
cd codex

# 构建项目
cargo build --release

# 将二进制文件添加到 PATH
sudo cp target/release/codex /usr/local/bin/

安装依赖

Codex 需要以下依赖：

Rust 1.70 或更高版本（仅从源码构建需要）
Git（仅从源码构建需要）
OpenAI API 密钥（可选，用于 AI 功能）

自动更新

Codex 支持自动更新功能，当有新版本可用时，会自动提示更新：

# 手动检查更新
codex update

快速开始

设置环境变量

如果要使用 AI 功能，需要设置 API 密钥：

# OpenAI API 密钥
export OPENAI_API_KEY="your-openai-api-key"

基本用法

启动交互式界面

codex

直接提问

codex ask "如何使用 Rust 编写一个 HTTP 服务器？"

解释代码

codex explain main.rs

生成代码

codex generate "创建一个简单的 Rust 函数，计算斐波那契数列"

索引代码库

codex index .

命令行选项

全局选项

codex [OPTIONS]

选项	描述	默认值
`-h, --help`	显示帮助信息	-
`-V, --version`	显示版本信息	-
`--config <CONFIG>`	指定配置文件路径	`~/.codex/config.yaml`
`--log-level <LOG_LEVEL>`	设置日志级别	`info`
`--no-color`	禁用彩色输出	-

主要命令

交互式界面

codex

启动 Codex 的交互式终端界面，支持代码编辑、文件浏览和 AI 对话功能。

直接提问

codex ask [OPTIONS] <QUESTION>

选项	描述	默认值
`-m, --model <MODEL>`	指定 AI 模型	配置文件中的默认模型
`-p, --platform <PLATFORM>`	指定 AI 平台	配置文件中的默认平台
`-c, --context <CONTEXT>`	添加上下文文件或目录	-

代码解释

codex explain <FILE>

解释指定文件的代码，提供功能说明和设计思路。

代码生成

codex generate [OPTIONS] <REQUIREMENT>

选项	描述	默认值
`-l, --language <LANGUAGE>`	指定生成代码的语言	自动检测
`-o, --output <OUTPUT>`	输出文件路径	标准输出

代码索引

codex index [OPTIONS] <PATH>

选项	描述	默认值
`-r, --recursive`	递归索引目录	-
`-e, --exclude <EXCLUDE>`	排除匹配的文件或目录	配置文件中的排除列表

工具调用

codex tool <TOOL_CALL>

执行 YAML 格式的工具调用，例如：

codex tool "{\n  tool: \"read_file\",\n  parameters:\n    path: \"/tmp\"\n}"

更新检查

codex update

检查并安装最新版本的 Codex。

插件管理

codex plugin [SUBCOMMAND]

子命令	描述
`list`	列出所有可用插件
`install <URL>`	安装插件
`uninstall <NAME>`	卸载插件
`enable <NAME>`	启用插件
`disable <NAME>`	禁用插件
`info <NAME>`	显示插件信息

配置

Codex 使用 YAML 配置文件，默认路径为 ~/.codex/config.yaml。

配置示例

app:
  name: codex
  version: "1.0.0"
  data_dir: ~/.codex
  log_level: info
  enable_auto_update: true
  update_check_interval: 86400 # 24小时

ai:
  default_platform: openai
  platforms:
    openai:
      api_key: "your-openai-api-key"
      default_model: gpt-4o
      base_url: "https://api.openai.com/v1"
      timeout: 30
      retry_times: 3
    anthropic:
      api_key: "your-anthropic-api-key"
      default_model: claude-3-opus-20240229
      base_url: "https://api.anthropic.com/v1"
    ollama:
      base_url: "http://localhost:11434"
      default_model: llama3

knowledge:
  index_dir: ~/.codex/index
  metadata_dir: ~/.codex/metadata
  exclude_patterns: ["target", ".git", "node_modules", "venv"]
  supported_extensions:
    [
      "rs",
      "py",
      "js",
      "ts",
      "json",
      "yaml",
      "toml",
      "md",
      "cpp",
      "c",
      "h",
      "java",
      "go",
    ]
  max_file_size: 1048576 # 1MB

ui:
  theme: "dark"
  enable_animations: true
  status_bar: true
  tab_size: 4

tools:
  timeout: 60
  enable_shell: true
  enable_mcp: true

架构

Codex 采用模块化设计，主要组件包括：

CLI 层: 处理命令行参数和输入输出
Core 层: 应用核心逻辑和生命周期管理
AI 层: AI 平台适配器和提示词管理
Knowledge 层: 代码索引和搜索
Tools 层: 工具系统和内置工具集
UI 层: 终端交互式界面
Config 层: 配置管理

开发

项目结构

codex/
├── src/
│   ├── cli/           # 命令行处理
│   ├── config/        # 配置管理
│   ├── core/          # 核心功能
│   ├── tools/         # 工具系统
│   ├── knowledge/     # 知识库
│   ├── ai/            # AI 集成
│   └── ui/            # 用户界面
├── templates/         # 提示词和工具模板
├── tests/             # 测试目录
├── Cargo.toml         # 项目配置
└── README.md          # 项目文档

构建命令

# 构建调试版本
cargo build

# 构建发布版本
cargo build --release

# 运行测试
cargo test

# 运行 clippy
cargo clippy

# 运行格式化
cargo fmt

贡献

欢迎提交 Issue 和 Pull Request！

贡献指南

Fork 仓库
创建特性分支 (git checkout -b feature/fooBar)
提交更改 (git commit -am 'Add some fooBar')
推送到分支 (git push origin feature/fooBar)
创建 Pull Request

许可证

MIT

联系方式

如有问题或建议，欢迎通过以下方式联系：

GitHub Issues: https://github.com/your-username/codex/issues
Email: your-email@example.com

Name		Name	Last commit message	Last commit date
Latest commit History 24 Commits
.github/workflows		.github/workflows
docs		docs
scripts		scripts
src		src
templates		templates
tests		tests
.gitignore		.gitignore
Cargo.toml		Cargo.toml
Makefile		Makefile
README.md		README.md
build.rs		build.rs
index_cache.json		index_cache.json
开发计划.md		开发计划.md

Folders and files

Latest commit

History

Repository files navigation

Codex AI 编程工具

项目概述

技术栈

安装

使用安装脚本（推荐）

使用 Homebrew（macOS）

使用 APT（Debian/Ubuntu）

从源码构建

安装依赖

自动更新

快速开始

设置环境变量

基本用法

启动交互式界面

直接提问

解释代码

生成代码

索引代码库

命令行选项

全局选项

主要命令

交互式界面

直接提问

代码解释

代码生成

代码索引

工具调用

更新检查

插件管理

配置

配置示例

架构

开发

项目结构

构建命令

贡献

贡献指南

许可证

联系方式

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages