OpenAI 코덱스 CLI: OpenAI에서 출시한 터미널 명령줄 AI 코딩 도우미

일반 소개

OpenAI Codex CLI는 터미널에 익숙한 개발자를 위해 OpenAI에서 개발한 오픈 소스 터미널 코딩 도구입니다. 자연어 명령을 통해 코드를 생성하고, 파일을 편집하고, 명령을 실행하며, Git 버전 관리 기능이 통합되어 있습니다.Codex CLI는 OpenAI의 최신 모델(예: o3 및 o4-mini)을 사용하고 다국어 프로그래밍을 지원하며 보안을 위해 네트워크 액세스 및 디렉토리 조작을 제한하는 보안 샌드박스 환경을 제공합니다. 이 프로젝트는 완전한 오픈 소스이며 커뮤니티 기여를 장려하며 빠른 개발, 작업 자동화, 프로그래밍 학습에 적합합니다.

기능 목록

• 코드 생성: 자연어를 기반으로 Python, JavaScript 및 기타 다국어 코드를 생성합니다.
• 파일 작업: 파일 생성 및 편집, Git 커밋 및 버전 관리 지원.
• 명령 실행: 샌드박스에서 코드 또는 명령을 실행하고 결과를 실시간으로 표시합니다.
• 다중 모드 입력: 스크린샷 및 차트 입력을 지원하여 해당 코드를 생성합니다.
• 보안 샌드박스: 기본적으로 네트워크를 비활성화하고 보안을 위해 현재 디렉터리만 작동합니다.
• 자동 승인: 수동, 자동 편집, 완전 자동의 세 가지 모드를 제공합니다.
• 오픈 소스 개발: 사용자가 코드를 보고, PR 기여 기능을 제출할 수 있습니다.
• 프로젝트 문서: 전역 및 프로젝트 수준 마크다운 명령, 사용자 지정 동작을 지원합니다.

도움말 사용

설치 프로세스

Codex CLI를 사용하려면 다음 설치 단계를 완료하세요:

1. 시스템 요구 사항::
   • OS: macOS 12+, Ubuntu 20.04+/Debian 10+ 또는 Windows 11(WSL2를 통해).
   • Node.js: 버전 >= 22(LTS 버전 권장).
   • Git: 버전 >= 2.23(버전 관리를 위해 권장).
   • RAM: 최소 4GB, 8GB 권장.
   • OpenAI API 키: 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를 권장합니다:

     ./run_in_container.sh
     

   • Docker가 설치되어 있는지 확인하면 스크립트가 자동으로 현재 디렉터리를 마운트하고 방화벽이 OpenAI API 액세스만 허용하도록 구성합니다.
4. 주의::
   • 사용하지 마십시오. sudo npm install -g는 npm 권한을 수정해야 합니다:

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

   • API 키가 유효한지 확인하여 다음을 방지합니다. 401 어쩌면 429 오류.

사용법

코덱스 CLI는 터미널 명령어 조작을 통해 자연어와 샌드박스 환경을 결합하여 효율적인 코딩 환경을 제공합니다. 아래는 주요 기능의 사용 방법 흐름입니다:

1. 코드 생성

• 워크플로::
  • 상호작용 패턴:

    codex
    

    "피보나치 급수를 계산하는 파이썬 함수 만들기"와 같은 프롬프트를 입력합니다.

  • 단일 명령 모드:

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

  • Codex CLI는 코드를 생성하고 미리 보기를 표시합니다.
  • 가져오기 y 수락 및 저장, 입력 n 거부.
• 고급 옵션::
  • 모델을 지정합니다:

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

  • 비대화형 모드:

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

• 주요 기능::
  • 파이썬, 자바스크립트, 타입스크립트, 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"
    

  • 코덱스 CLI는 샌드박스에서 실행되고 결과를 표시합니다.
  • 종속성이 누락된 경우 설치하라는 메시지를 표시합니다:

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

• 주요 기능::
  • macOS는 Apple 안전벨트 샌드박스를 사용하고 Linux는 Docker를 사용합니다.
  • 네트워크는 우발적인 액세스를 방지하기 위해 기본적으로 비활성화되어 있습니다.
  • 오류 세부 정보를 표시하는 디버깅 출력을 지원합니다.

4. 멀티모달 입력

• 워크플로::
  • 이미지 경로를 입력합니다:

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

  • Codex CLI는 이미지를 분석하여 HTML/CSS 또는 프런트엔드 코드를 생성합니다.
• 주요 기능::
  • UI 디자인을 코드로 변환하는 기능을 지원합니다.
  • 다이어그램이나 순서도를 처리하여 로직 코드를 생성할 수 있습니다.

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 액션에서 실행하세요:

    - 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 모드가 아닌 디렉터리에서 경고를 표시합니다.
• API 키 할당량을 확인하세요. 빈번한 호출로 인해 제한이 발생할 수 있습니다.
• 이 프로젝트는 실험 중이며 기능이 불안정할 수 있으므로 GitHub를 팔로우하여 업데이트를 확인하는 것이 좋습니다.

애플리케이션 시나리오

1. 신속한 프로토타이핑
   개발자는 자연어로 코드 프레임워크를 빠르게 생성할 수 있습니다. 예를 들어 "데이터베이스가 있는 Express 애플리케이션 만들기"라고 입력하면 Codex CLI가 아이디어를 검증하는 데 적합한 경로, 모델 및 구성 파일을 생성합니다.
2. 자동화된 작업
   Codex CLI는 "모든 파일의 저작권 고지 업데이트 및 제출"과 같은 반복적인 작업을 간소화합니다. 자동으로 파일을 편집하고, 스크립트를 실행하고, 일괄 작업을 위해 Git으로 푸시합니다.
3. 프로그래밍 학습
   초보자는 "빠른 정렬을 파이썬으로"라고 입력하면 코덱스 CLI가 코드를 생성하고 로직을 설명해주므로 자습이나 강의실 교육에 적합합니다.
4. 오픈 소스 협업
   개발자는 GitHub를 통해 Codex CLI 개발에 참여하고 버그 수정 또는 새로운 기능을 제출할 수 있으며, 투명한 코드베이스를 통해 협업을 촉진할 수 있습니다.
5. CI/CD 파이프라인
   CI 환경에서 Codex CLI는 문서를 자동으로 업데이트하고, 테스트 케이스를 생성하거나, 린트 버그를 수정하여 개발 효율성을 향상시킵니다.

QA

1. 코덱스 CLI는 2021 코덱스 모델과 어떻게 다른가요?
   코덱스 CLI는 2021년에 단종될 코덱스 모델과는 별개로 최신 OpenAI 모델(o3, o4-mini)을 기반으로 하는 더욱 강력한 오픈 소스 엔드포인트 도구입니다.
2. 안전한 작동을 보장하려면 어떻게 해야 하나요?
   코덱스 CLI는 기본적으로 샌드박스에서 실행되며, macOS의 경우 Apple 안전벨트, Linux의 경우 Docker를 사용하고, 시스템 위험을 방지하기 위해 네트워킹을 비활성화하고 디렉토리 액세스를 제한합니다.
3. 어떤 프로그래밍 언어가 지원되나요?
   사용되는 OpenAI 모델에 따라 Python, JavaScript, TypeScript, Go, SQL 등이 지원되며, 명령어를 통해 언어를 지정할 수 있습니다.
4. 코덱스 CLI는 무료인가요?
   코덱스 CLI 자체는 무료이지만 OpenAI API 키가 필요하며 API 호출에 대한 비용이 발생할 수 있습니다(자세한 내용은 OpenAI 가격 책정 참조).
5. Codex CLI가 파일을 수정하지 못하도록 하려면 어떻게 하나요?
   활용 suggest 모드에서는 모든 변경 사항을 수동으로 확인해야 합니다:

   codex --approval-mode suggest