프로젝트 로컬 환경의 Codex 설정을 위한 다중 레포지토리 작업 공간용 도구입니다.
현재 릴리스: 0.1.9 · 라이선스: MIT · 리포지토리: github.com/manhvann/codexkit
Release
Skills
Rules
Output styles
Agents
Node.js
License
Codex Kit은 스킬, 에이전트(agent), 훅(hook), 워크플로우 규칙(workflow rules), 헬퍼 스크립트(helper scripts), 플랜 템플릿(plan templates), 출력 스타일(output styles) 및 프로젝트 문서를 포함하는 선별된 Codex 작업 공간 레이어를 설치합니다. 이는 많은 자식 레포지토리(child repos)를 포함하는 우산형 리포지토리(umbrella repositories)를 위해 설계되었습니다: 운영 지식을 부모 작업 공간에 유지하면서도, Codex가 여전히 자식 프로젝트 전반에 걸쳐 깨끗하게 추론하고 작업할 수 있도록 합니다.
Codex Kit을 사용해야 하는 이유?
대부분의 AI 코딩 설정은 모노레포(monorepos)나 워크스페이스 폴더에서 지저분해지기 쉽습니다. 왜냐하면 각 자식 레포지토리가 자체적인 플랜, 문서, 스크립트 및 에이전트 설정을 축적하기 시작하기 때문입니다. Codex Kit은 우산형 폴더가 조정 계층(coordination layer) 역할을 하도록 함으로써 이를 해결합니다.
plans, .codex/docs, .codex/scripts, 규칙(rules), 훅(hooks), 및 템플릿(templates)은 여러 자식 저장소에 분산시키지 않고 선택된 최상위 대상(top-level target)에 유지하세요.
- 부모 작업 공간(parent workspace)에서 자식 저장소를 감싸서 Codex가 모든 시스템 전반에 걸쳐 작동할 수 있도록 하되, 모든 프로젝트를 오염시키지는 않도록 하세요.
- 설정 시점에 정확한 대상을 선택하세요: 우산 폴더(umbrella folder)에 설치하거나, 의도적으로 특정 자식 프로젝트에 설치하고 싶을 때 그렇게 하세요.
- 인터랙티브 터미널 UI에서 스킬(skills), 에이전트(agents), 훅(hooks), 그리고 Python 런타임(runtime)을 선택하세요.
- 프로젝트 신호(project signals)를 자동 감지하고 관련 스킬과 에이전트를 추천합니다.
~/.venv/shared/bin/python와 같은 공유 Python 환경을 고정하여 Codex 스크립트가 실수로 시스템 Python을 사용하지 않도록 합니다.
- 개인 정보 보호 확인(privacy checks), 스카우트 차단(scout blocking), 개발 규칙 알림(development-rule reminders), 계획/실행 워크플로우 알림(plan/cook workflow reminders), 그리고 편집 후 단순화(post-edit simplification)를 위한 가드레일(guardrails)을 설치합니다.
- 사용자 소유 콘텐츠를 대체하는 대신 관리된 섹션(managed sections)을 작성하여 기존 프로젝트 관례(conventions)를 보존합니다.
설치 (Install)
npm install -g @manhnv319/codexkit
CLI가 사용 가능한지 확인하세요:
빠른 시작 (Quick Start)
저장소들이 포함된 우산 폴더(umbrella folder)에서:
cd ~/Documents/projects/my-workspace
ckit
인수 없이 ckit을 실행하는 것은 다음과 동일합니다:
기본적으로, 이것은 인터랙티브 선택기(interactive selector)를 엽니다. 화살표 키로 이동하고, Space로 선택/토글하며, Enter로 적용하세요.
인터랙티브 설정 (Interactive Setup)
선택기에는 다음 탭들이 포함되어 있습니다:
Target: 우산 폴더 또는 감지된 자식 프로젝트를 선택합니다.
Python: auto 또는 감지된 Python 인터프리터를 선택합니다.
Skills: 설치된 Codex 스킬을 선택합니다.
Agents: Codex 에이전트 역할을 선택합니다.
Hooks: 런타임 훅과 가드레일을 선택합니다.
Review: 적용하기 전에 최종 설정을 확인합니다.
Python 탭은 macOS, Linux/Ubuntu, Windows의 일반적인 위치를 스캔합니다. 여기에는 프로젝트 .venv, ~/.venv, ~/.venv/shared, ~/.virtualenvs, ~/.pyenv/versions, Conda 환경, Windows Python 설치본, 시스템 폴백(system fallbacks) 등이 포함됩니다. 선택된 값은 .codex/.ck.json에 python.runner로 저장됩니다.
권장 우산 설정 (Recommended Umbrella Setup)
하나의 폴더가 여러 리포지토리를 포함하고 있으며, Codex 작업 공간 파일이 부모 폴더에만 존재하도록 하고 싶을 때 사용합니다:
cd ~/Documents/projects/my-workspace
ckit
Target 탭에서는 .를 선택한 상태로 유지하세요. 이렇게 하면 Codex Kit이 현재 작업 공간 폴더에 설치됩니다. 계획(Plans), 문서(docs), 스크립트, 규칙(rules), 후크(hooks), 및 템플릿은 해당 선택된 타겟 폴더에 남아 있습니다.
각 애플리케이션/서비스 리포지토리 내부에 추가적인 kit 파일 없이 깔끔한 자식 리포 구조를 원할 때 이 모드를 사용합니다.
변경 사항 미리보기 (Preview Changes)
ckit --target . --dry-run --details
이 명령어는 아무것도 쓰지 않고 감지된 프로젝트 신호(project signals), 권장 사항, 선택된 스킬/에이전트(skills/agents), 선택된 후크, Python 러너, 그리고 계획된 파일 작업들을 출력합니다.
선택자 없이 적용하기 (Apply Without the Selector)
공유 Python 인터프리터를 지정(pin)합니다:
ckit --target . --python ~/.venv/shared/bin/python --yes
자동 감지 기능을 명시적으로 사용합니다:
ckit --target . --python auto --yes
자식 프로젝트 설치 (Child-Project Installs)
의도적으로 Codex Kit을 자식 리포지토리에 설치하고 싶다면, Target 탭에서 해당 자식 프로젝트를 선택하거나 직접 전달하세요:
ckit --target ./backend-service
이것은 자식 리포지토리가 독립적으로 작업되며 자체적인 .codex, .agents, plans, 및 AGENTS.md 설정을 소유해야 할 때 유용합니다.
배치 모드 (Batch Mode)
감지된 자식 리포지토리 미리보기:
ckit --all-projects --dry-run --details
감지된 자식 리포지토리에 적용하기:
ckit --all-projects --yes
배치 모드(Batch mode)는 권장되는 통합 설정(umbrella setup)과 의도적으로 다릅니다. 이 모드는 감지된 각 자식 프로젝트에 .codex 및 .agents 설정을 설치합니다. 자식 리포지토리가 자체 키트 파일(kit files)을 받을 것을 실제로 원할 때만 사용하십시오.
프로필 (Profiles)
ckit --target . --profile default
ckit --target . --profile minimal --yes
ckit --target . --profile all --yes
default: 핵심 키트(core kit)와 프로젝트별 권장 사항이 포함됩니다.
minimal: 필수 워크플로우 스킬과 가드레일(guardrails)을 갖춘 더 작은 설정입니다.
all: 사용 가능한 모든 마이그레이션된 스킬, 에이전트(agent), 후크(hook)를 설치합니다.
custom: CLI 플래그를 통해 전달되는 명시적 선택 사항부터 시작합니다.
사용자 지정 설정 예시:
ckit --target . \
--profile custom \
--with-recommended \
...
유용한 명령어 (Useful Commands)
ckit --list
ckit --target . --suggest-only
ckit --target . --dry-run --details
...
검증 (Validation)
다음 명령어로 핵심 리포지토리 테스트 스위트(test suites)를 실행합니다:
핵심 스위트는 Node.js만 필요로 합니다. 대시보드 스위트는 선택적 의존성인 plans-kanban이 설치될 때 자동으로 실행됩니다. 그렇지 않으면 테스트 명령어가 완전한 녹색(green) 실행을 보여주는 대신 건너뛴 것으로 보고합니다:
npm install --prefix .agents/skills/plans-kanban
모든 스위트를 요구하고 선택적 의존성이 누락되면 실패하게 하려면 다음 명령어를 사용합니다:
민감 파일 승인 (Sensitive file approvals)
개인 정보 보호 가드(privacy guard)는 로컬 환경 파일, 자격 증명(credentials), 비밀(secrets), 및 개인 키를 보호합니다. 차단된 작업을 명시적으로 승인한 후에는 정확한 도구와 경로에 대해 일회성 승인을 부여하고 원래 작업을 다시 시도하십시오:
node .codex/hooks/privacy-approval.cjs approve \
--tool Write \
--path .env.local
승인은 리포지토리 외부, 현재 작업 공간에 범위가 지정되며, 5분 후에 만료되고 사용 후 소모됩니다. 이후의 Write, Edit, MultiEdit, 또는 Read 호출에서 원래 경로는 변경되지 않아야 합니다.
설치되는 항목 (What It Installs)
.agents/skills
common/ 등과 같은 지원 파일, install.sh, 그리고 INSTALLATION.md
.codex/agents
.codex/hooks
.codex/rules
.codex/scripts
.codex/output-styles
.codex/docs
.codex/.ck.json
.codex/config.toml
.codex/hooks.json
plans/templates
AGENTS.md에 관리되는 Codex Kit 블록
구성 하이라이트 (Configuration Highlights)
Codex Kit은 다음을 포함하여 프로젝트 환경 설정을 .codex/.ck.json에 저장합니다:
paths.plans: 계획 디렉터리 및 보고서가 생성되어야 하는 위치.
paths.docs: 문서(docs)가 유지되어야 하는 위치.
python.runner: 선택된 Python 인터프리터 또는 auto.
hooks: 활성화/비활성화되는 훅(hook) 환경 설정.
plan: 명명 규칙, 보고서 및 유효성 검사 동작.
참고 사항 (Notes)
깨끗한 통합 레포지토리 워크플로우를 위해 ckit --target .을 사용하십시오. 감지된 자식 레포지토리에 의도적으로 키트(kit)를 적용하려는 경우에만 ckit --all-projects를 사용하십시오.
Codex Kit을 적용한 후에는 새로운 스킬, 에이전트, 훅 및 규칙이 로드되도록 대상 작업 공간에서 Codex를 재시작해야 합니다.
라이선스 (License)
MIT License. 자세한 내용은 LICENSE를 참조하십시오.
기여 및 지원 (Contributing and Support)