OpenAI Codex CLI: помощник по кодированию ИИ в командной строке терминала выпущен OpenAI

Общее введение

OpenAI Codex CLI - это инструмент терминального кодирования с открытым исходным кодом, разработанный компанией OpenAI для разработчиков, привыкших к терминалам. Он генерирует код, редактирует файлы и выполняет команды с помощью команд на естественном языке, а также интегрирует контроль версий Git. Codex CLI использует последние модели OpenAI (такие как o3 и o4-mini), поддерживает многоязычное программирование и обеспечивает безопасную среду песочницы, которая ограничивает доступ к сети и работу с каталогами для обеспечения безопасности. Проект имеет полностью открытый исходный код, поощряет вклад сообщества и подходит для быстрой разработки, автоматизации задач и обучения программированию.

Список функций

• Генерация кода: генерируйте код на Python, JavaScript и других языках на основе естественного языка.
• Файловые операции: создание и редактирование файлов, поддержка коммитов и версионности Git.
• Выполнение команд: запуск кода или команд в "песочнице" и отображение результатов в реальном времени.
• Мультимодальный ввод: поддержка скриншотов и графиков для генерации соответствующего кода.
• Песочница безопасности: отключите сеть по умолчанию и работайте только с текущим каталогом для обеспечения безопасности.
• Автоматизированное утверждение: Предусмотрено три режима: ручной, автоматическое редактирование и полностью автоматизированный.
• Разработка с открытым исходным кодом: позволяет пользователям просматривать код, вносить PR-вклады.
• Проектная документация: поддержка глобальных и проектных команд Markdown, пользовательское поведение.

Использование помощи

Процесс установки

Чтобы использовать Codex CLI, выполните следующие шаги по установке:

1. системные требования::
   • ОС: macOS 12+, Ubuntu 20.04+/Debian 10+ или Windows 11 (через WSL2).
   • Node.js: версия >= 22 (рекомендуется версия LTS).
   • Git: версия >= 2.23 (рекомендуется для контроля версий).
   • Оперативная память: не менее 4 ГБ, рекомендуется 8 ГБ.
   • Ключ API OpenAI: получите его на сайте OpenAI.
2. Этапы установки::
   • Установите глобально через npm (рекомендуется):

     npm install -g @openai/codex
     

   • или собрать из исходного кода:

     git clone https://github.com/openai/codex.git
     cd codex/codex-cli
     npm install
     npm run build
     

   • Установите ключ API:

     export OPENAI_API_KEY="your-api-key-here"
     

     Для постоянной настройки добавьте ее в файл конфигурации оболочки (например. ~/.zshrc возможно ~/.bashrc):

     echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.zshrc
     source ~/.zshrc
     

   • Проверьте установку:

     codex --help
     

     Если отображается сообщение о помощи, значит, установка прошла успешно.

3. Конфигурация Linux Docker::
   • Для повышения безопасности рекомендуется использовать Docker:

     ./run_in_container.sh
     

   • Убедитесь, что Docker установлен, скрипт автоматически смонтирует текущую директорию и настроит брандмауэр так, чтобы разрешить доступ только к OpenAI API.
4. предостережение::
   • Не используйте sudo npm install -gдолжно исправить разрешения npm:

     sudo chown -R $(whoami) ~/.npm
     

   • Убедитесь, что ключ API действителен, чтобы избежать 401 возможно 429 Ошибка.

Использование

Codex CLI обеспечивает эффективную работу с кодом, сочетая естественный язык и среду песочницы с помощью командных операций в терминале. Ниже описано, как использовать основные функции:

1. генерация кода

• рабочий процесс::
  • Модели взаимодействия:

    codex
    

    Введите запрос, например "Создать функцию Python для вычисления ряда Фибоначчи".

  • Однокомандный режим:

    codex "生成 JavaScript 过滤数组函数"
    

  • Codex CLI генерирует код и отображает предварительный просмотр.
  • импорт y Примите и сохраните, введите n Отказ.
• Дополнительные параметры::
  • Укажите модель:

    codex --model o4-mini "生成 Go HTTP 服务器"
    

  • Неинтерактивный режим:

    codex -q "生成 SQL 查询" > output.sql
    

• Основные функции::
  • Поддержка Python, JavaScript, TypeScript, Go, SQL и других языков.
  • Может решать сложные задачи, такие как "Создать приложение Flask с аутентификацией пользователя".

2. Работа с файлами и интеграция с Git

• рабочий процесс::
  • Редактировать файл:

    codex "在 src/app.js 中添加登录功能"
    

  • Codex CLI отображает различия в коде, подтверждает их и сохраняет.
  • Зафиксируйте в Git:

    codex "提交更改，消息为 '添加登录功能'"
    

• Основные функции::
  • Автоматически обрабатывайте команды Git (add, иcommit).
  • Поддерживает пакетные операции, такие как:

    codex "重命名所有 *.jpeg 为 *.jpg 并更新引用"
    

  • Предусмотрено три режима утверждения:
    • suggest: По умолчанию, все изменения должны быть подтверждены вручную.
    • auto-edit: Изменения в файле применяются автоматически, и команду необходимо подтвердить.
    • full-auto: Полностью автоматический и должен использоваться с осторожностью:

      codex --approval-mode full-auto "更新 README"
      

3. Выполнение кода

• рабочий процесс::
  • Выполните код:

    codex "运行 src/main.py"
    

  • Codex CLI запускается в "песочнице" и отображает результаты.
  • Если зависимость отсутствует, попросите установить ее:

    codex "安装 numpy 并运行 script.py"
    

• Основные функции::
  • В macOS используется песочница Apple Seatbelt, а в Linux - Docker.
  • По умолчанию сети отключены, чтобы предотвратить случайный доступ.
  • Поддерживает отладочный вывод для отображения подробностей ошибок.

4. Мультимодальные входы

• рабочий процесс::
  • Введите путь к изображению:

    codex "根据 ui.png 实现界面代码"
    

  • Codex CLI анализирует изображения для генерации HTML/CSS или внешнего кода.
• Основные функции::
  • Поддержка преобразования дизайна пользовательского интерфейса в код.
  • Диаграммы или блок-схемы могут быть обработаны для создания логического кода.

5. конфигурация и настройка

• файл конфигурации::
  • Глобальная конфигурация:~/.codex/config.yaml::

    model: o4-mini
    fullAutoErrorMode: ask-user
    

  • Файл с инструкцией:~/.codex/instructions.md::

    - 使用 Python 3.9
    - 禁止自动提交 Git
    

  • Конфигурация на уровне проекта: конфигурация codex.md::

    - 优先使用 TypeScript
    - 运行测试前执行 npm run lint
    

• Отключить документацию по проекту::

  codex --no-project-doc

• Переключение режимов утверждения::

  codex --approval-mode auto-edit
  

6. интеграция CI/CD

• рабочий процесс::
  • Запустите его в программе GitHub Actions:

    - name: 更新文档
    run: |
    npm install -g @openai/codex
    export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
    codex -a auto-edit -q "更新 CHANGELOG"
    

  • Установите бесшумный режим:

    export CODEX_QUIET_MODE=1
    

• Основные функции::
  • Поддерживает неинтерактивный режим, подходит для автоматизированных процессов.
  • Выводит данные в формате JSON для удобства работы со сценариями:

    codex -q --json "生成配置"
    

предостережение

• Убедитесь, что каталог отслеживается Git'ом.full-auto режим будет выдавать предупреждение в не-Git каталогах.
• Проверьте квоту ключа API, частые обращения могут привести к ограничению.
• Проект является экспериментальным и может содержать нестабильные функции, поэтому мы рекомендуем следить за обновлениями на GitHub.

сценарий применения

1. Быстрое прототипирование
   Разработчики могут быстро генерировать кодовые фреймворки на естественном языке. Например, введите "Создать приложение Express с базой данных", и Codex CLI сгенерирует маршруты, модели и конфигурационные файлы, подходящие для проверки идей.
2. Автоматизированные задания
   Codex CLI упрощает выполнение повторяющихся задач, таких как "обновить уведомления об авторских правах во всех файлах и отправить". Он автоматически редактирует файлы, запускает скрипты и отправляет в Git для пакетных операций.
3. Обучение программированию
   Новички могут набрать "Быстрая сортировка на Python", Codex CLI сгенерирует код и объяснит логику, что подходит для самостоятельного изучения или преподавания в классе.
4. Сотрудничество с открытым исходным кодом
   Разработчики могут участвовать в разработке Codex CLI через GitHub, предоставлять исправления ошибок или новые функции, а прозрачная кодовая база облегчает сотрудничество.
5. Конвейер CI/CD
   В средах CI Codex CLI автоматически обновляет документацию, генерирует тестовые примеры или исправляет ошибки, повышая эффективность разработки.

QA

1. Чем Codex CLI отличается от модели Codex 2021?
   Codex CLI - это более мощный инструмент с открытым исходным кодом, основанный на последних моделях OpenAI (o3, o4-mini) и не зависящий от моделей Codex, которые будут сняты с производства в 2021 году.
2. Как обеспечить безопасность эксплуатации?
   Codex CLI по умолчанию работает в "песочнице", использует Apple Seatbelt для macOS и Docker для Linux, отключает сетевое взаимодействие и ограничивает доступ к каталогам, чтобы избежать системного риска.
3. Какие языки программирования поддерживаются?
   Поддерживаются Python, JavaScript, TypeScript, Go, SQL и т. д., в зависимости от используемой модели OpenAI, а язык можно указать с помощью команды.
4. Является ли Codex CLI бесплатным?
   Сам Codex CLI бесплатен, но требует ключа OpenAI API и может повлечь за собой расходы на вызовы API, подробности см. в разделе "Ценообразование OpenAI".
5. Как запретить Codex CLI изменять файлы?
   пользоваться suggest все изменения необходимо подтвердить вручную:

   codex --approval-mode suggest