OpenAI Codex (GitHub 리포지토리) 사용설명서

GitHub – openai/codex: Lightweight coding agent that runs in your terminal

1. 개요

  • openai/codex는 자체 터미널에서 실행 가능한 경량 코딩 에이전트입니다.
  • 로컬 환경에서 코드를 읽고 수정하며 실행할 수 있어, 개발 효율성을 크게 향상시킵니다.GitHubOpenAI Help Center

2. 설치 방법

npm install -g @openai/codex
# 또는 이미 설치된 경우에는:
codex --upgrade

이 명령 하나로 빠르게 설치 또는 최신 버전으로 업데이트할 수 있습니다.OpenAI Help Center


3. 샌드박스 모드 (autonomy level)

Codex는 다음과 같은 실행 모드를 제공합니다:

모드설명
workspace-write (읽기/쓰기)워크스페이스 내 파일을 수정 가능. 외부 파일 접근 시 사용자 승인 필요.GitHub
read-only (읽기 전용)파일 수정 불가. 네트워크, git 업데이트 등 외부 접근 시 승인 필요.GitHub

기본값은 디폴트 샌드박스로, 워크스페이스 안전성이 보장되어 있습니다.


4. 승인 방식 조정 (–ask-for-approval)

Codex가 어떤 작업을 수행할 때 승인 요청 방식을 제어할 수 있습니다:

  • --ask-for-approval on-request (기본값): 필요한 경우에만 사용자의 승인을 요청.
  • --ask-for-approval never: 비대화식(non-interactive) 모드로, 아무 승인이 없더라도 모든 작업 지속.GitHub

예시:

codex --ask-for-approval never --sandbox read-only

5. 주요 기능

  • 제로 셋업: 설치 즉시 실행 가능.OpenAI Help Center
  • 멀티모달 입력: 텍스트 외에도 스크린샷이나 다이어그램을 입력으로 활용 가능.OpenAI Help Center
  • 터미널 기반 실행: 개발 중 컨텍스트 전환 없이 바로 사용 가능.OpenAI Help Center
  • 권한 기반 승인 워크플로우: 실행 전 사용자 승인을 통한 안전한 코드 실행 보장.OpenAI Help Center

6. 전체 사용 흐름 요약

  1. 설치 npm install -g @openai/codex
  2. 샌드박스와 승인 모드 설정 (필요 시)
    예: 읽기 전용 모드 + 사용자 승인 요청 설정 codex --sandbox read-only --ask-for-approval on-request
  3. Codex 실행
    예: 프로젝트 디렉터리에서 Codex 사용 codex 이 때 Codex는 자동으로 해당 디렉터리가 Git 제어 하에 있는지 확인하고, 적절한 모드로 실행됩니다.GitHub
  4. 작업 수행
    • 멀티모달 입력을 통한 코드 생성, 수정, 설명, 테스트 등 수행 가능.
    • 사용자 설정에 따라 필요한 작업은 승인 요청으로 처리됨.

7. 최신 정보 참고

  • Codex는 ChatGPT 인터페이스 내에서도 새로운 AI 코딩 에이전트로 제공되고 있으며, 베타 단계로 Pro, Team, Enterprise 이용자에게 제공 중입니다.Business InsiderThe VergeWIRED위키백과
  • Terminal에서 실행 가능한 CLI 버전(Codex CLI)은 2025년 4월에 오픈소스로 공개되었습니다.위키백과OpenAI Help Center

설명서 요약

  • 설치: npm install로 손쉽게 실행
  • 샌드박스 설정: read-only / workspace-write 모드 선택 가능
  • 승인 흐름 조정: on-request 또는 never
  • 멀티모달 입력터미널 실행을 통한 편리한 코드 작업
  • ChatGPT 통합 Codex와는 별도로, 로컬 CLI용 Codex만의 특화된 기능 제공

필요하시면 예시 워크플로우, 옵션 설명, 사용 팁 등을 더 자세하게 작성해드릴 수 있어요. 언제든지 말씀 주세요!

나의 말:

https://github.com/openai/codex 사이트방문해보고, 상세설명서 작성해줘

ChatGPT의 말:

아래는 GitHub openai/codex 리포지토리(터미널용 Codex CLI)에 기반한 상세 사용 설명서입니다. 리포지토리 내용을 중점으로 구성했으며, 관련된 추가 정보도 함께 요약했습니다.


OpenAI Codex CLI — 상세 사용 설명서

1. 개요

  • openai/codex터미널 상에서 실행되는 경량형 코딩 에이전트입니다. 사용자의 워크스페이스 내에서 명령 실행, 파일 생성/수정 등이 가능합니다.GitHub
  • 이 도구는 GitHub에 오픈소스로 공개되었으며, Apache 2.0 라이선스 하에 제공됩니다.위키백과

2. 주요 기능 및 동작 방식

  • 샌드박스 기반 실행 환경
    • 기본적으로 디폴트 샌드박스에서 실행되어, 작업 디렉터리(및 /tmp 등 일부 임시 경로) 외부의 파일 쓰기나 네트워크 접근, Git 업데이트 같은 외부 작업은 차단됩니다.GitHub
  • 자율 설정 선택 가능
    Git 제어 여부에 따라 두 가지 실행 모드를 제공합니다:
    • workspace-write (읽기·쓰기 가능): 워크스페이스 내에서 파일 편집 및 명령 실행 가능, 외부 접근은 승인 필요
    • read-only (읽기 전용): 파일 편집이 제한되며, 편집 작업은 승인 필요GitHub
  • 승인 정책(--ask-for-approval) 조절 가능
    • on-request (기본값): 필요 시 사용자 승인 요청
    • never: 모든 작업을 비대화식(인터랙션 없이)으로 실행 가능GitHub
  • 고급 구성 설정
    config.toml 파일로 사전 설정 저장 가능. 예시 구성: [profiles.full_auto] approval_policy = "on-request" sandbox_mode = "workspace-write" [sandbox_workspace_write] network_access = true 자세한 구성을 위해 codex help 명령어 활용 가능GitHub

3. 설치 및 초기 설정 (CLI 기준)

  • GitHub 리포지토리에서 설치 및 사용 방법은 README 또는 codex --help에서 확인 가능 호환 환경에 설치 후 기본 실행: codex
  • API 키 설정은 터미널 세션 내에서만 유효하며, 장기적으로 사용하려면 ~/.zshrc 등 셸 설정에 추가해서 영구 설정 가능GitHub

4. 사용 예시

  • 기본 실행 (버전 관리된 폴더) codex workspace-write + on-request (기본 추천 설정)
  • 비대화식 실행 (자동화 환경) codex --sandbox workspace-write --ask-for-approval never
  • 엄격 읽기 모드 (실험적 환경) codex --sandbox read-only --ask-for-approval on-request
  • 구성 파일 기반 프로필 사용
    config.toml에 정의된 profiles.full_auto를 적용하려면: codex --profile full_auto (정확한 명령어는 codex help 참고)

5. CLI 외의 Codex 에코시스템

  • ChatGPT 통합 Codex
    • OpenAI는 ChatGPT 내에 Codex 에이전트를 연구 미리보기 형태로 통합했습니다. 사용자는 코드 수정, 오류 수정, 테스트 실행, PR 생성 등을 자연어로 입력할 수 있습니다OpenAI위키백과
    • AGENTS.md 파일을 통해 Codex가 저장소 구조를 이해하도록 지시할 수 있습니다OpenAI
  • Wikipedia 등 참고 정보
    • Codex는 GPT-3 기반에 다양한 프로그래밍 언어를 지원하며, Python에 가장 특화되어 있습니다위키백과
    • OpenAI는 2025년 4월 Codex CLI 및 codex-mini-latest 모델을 공개했습니다위키백과
    • 2025년 5월에는 클라우드 기반 Codex 에이전트도 출시되었습니다위키백과

요약된 핵심 정리

항목설명
주요 기능터미널 기반 코드 작업, 파일 생성/수정, 명령 실행
샌드박스 옵션workspace-write / read-only
승인 정책on-request / never
구성 파일 지원config.toml을 통한 프로필 설정 가능
설치 및 실행codex, codex --help로 확인
ChatGPT 연동 버전자연어 기반 코드 작업, PR 생성 등 지원
모델 기반 정보GPT-3 기반, 다양한 언어 지원 (Python 특화), CLI 공개 등