콘텐츠로 이동

CLI 레퍼런스

opencodex CLI는 ocx입니다. 첫 번째 명령 이름으로 분기하며, setup/init, restore/eject, models/model 같은 별칭은 같은 동작으로 이어집니다. 알 수 없는 명령과 잘못된 명령 형태는 오류입니다.

ocx help(ocx --help / ocx -h도 가능)는 최상위 사용법을 보여 줍니다. 도움말 표에 등록된 명령은 ocx help <command>, ocx <command> --help, ocx <command> -h로 볼 수 있습니다. 도움말과 버전 명령은 읽기 전용이며 Codex나 opencodex 상태를 시작, 중지, 설치, 제거하거나 다시 쓰지 않습니다.

  • 라이프사이클 — 설정, 프록시와 서비스 라이프사이클, 상태 확인, 진단, 카탈로그 동기화, 대시보드, 업데이트.
  • 프로바이더, 계정, 모델 — 프로바이더 설정, 인증, 자격 증명 풀, quota, 사용자 지정 모델, 표시 여부, 선택된 모델, 컨텍스트 상한.
  • 에이전트, 라우팅, 통합 — 다중 에이전트 제어, 조합, 관측성, admission key, 클라이언트 통합, 런타임 설정, 검증된 설정.

관리 명령은 기록된 런타임 포트와 신원 검사를 사용해 살아 있는 프록시의 management API와 왕복 통신하며, 두 번째 설정 경로를 따로 두지 않습니다. 멈췄거나 닿을 수 없는 프록시는 HTTP 503으로 표시되며 CLI는 0이 아닌 종료 코드를 반환합니다. 명시적으로 오프라인 설정 작업으로 문서화된 명령은 라이브 프록시 없이 설정 파일을 검증하고 수정할 수 있습니다.

뜻이 분명하면 liststatus가 기본입니다. 구조화된 스냅샷은 --json을, 스트리밍 요청 로그 피드는 ocx observe logs --follow --jsonl을 사용합니다. 테마, 언어, 내비게이션처럼 순수하게 시각적인 브라우저 상태에는 CLI 대응이 없습니다. Cloudflare Tunnel 설정은 이 명령 집합 밖입니다.

성공한 명령은 종료 코드 0을 반환합니다. 잘못된 사용법, 알 수 없는 명령이나 리소스, 실패한 API 작업, 필요한 서비스가 없음은 0이 아닌 종료 코드를 반환합니다. ocx health는 프록시가 건강할 때만 0을, 그렇지 않으면 1을 반환하므로 서비스 probe로 쓸 수 있습니다. 스크립트는 사람이 읽는 출력 대신 종료 코드를 확인해야 합니다.

제거, 가져오기, 크레딧 소모, 업데이트처럼 확인을 알리는 파괴적 작업은 비대화형 사용 시 --yes가 필요합니다. 이 플래그는 명시적인 동의이며, 생략했다고 해서 동작이 조용히 확인되면 안 됩니다.

ocx --version, ocx -v, ocx version은 스크립트가 읽기 좋은 한 줄짜리 버전을 출력하고 종료합니다.

일반 도움말에는 두 개의 디스패치 대상이 의도적으로 빠져 있습니다. __refresh-version [preview]는 분리된 프로세스에서 업데이트 알림 캐시를 새로 고치고, __gui-update-worker <job-id> [latest|preview] [restart]는 대시보드 업데이트 작업을 실행합니다. 이들은 구현 세부 사항일 뿐이며 안정적인 사용자 명령이 아닙니다. 대시보드는 worker PID를 기록하고, worker가 죽은 활성 작업은 복구하며, PID가 없는 오래된 활성 기록은 10분 뒤 오래된 것으로 취급하고, 살아 있는 worker를 동시 업데이트로부터 보호합니다.