Skip to main content

Telegram orchestrator for running Codex single/plan-agent workflows

Project description

codex-orchestrator

Telegram Bot에서 Codex 워크플로우(single/plan)를 실행하기 위한 Python 오케스트레이터입니다.

주요 기능

  • Telegram long polling 기반 요청 처리
  • /mode, /profile, /cancel 등 운영 명령 라우팅
  • single 모드: 단일 developer agent 즉시 실행
  • plan 모드: selector -> planner -> developer -> reviewer 조합 실행 (selector가 요청을 분석하여 single/plan 자동 라우팅, 리뷰 최대 3회)
  • 사용자 허용 목록(telegram.allowed_users) 기반 접근 제어
  • Codex MCP warmup 및 상태 확인
  • 세션/트레이스 파일 저장
  • 표준출력 로그 타임스탬프 자동 prefix

프로젝트 구조

  • src/core: 라우팅, 오케스트레이션, 세션, 프로파일, 트레이스
  • src/workflows: single/plan 워크플로우
  • src/integrations: Codex executor, MCP 상태 연동
  • src/bot: Telegram update 파싱, 메시지 분할
  • scripts/telegram_polling_runner.py: 운영 진입점
  • tests: unittest 테스트

요구 사항

  • Python 3.10+
  • npx + codex mcp-server를 실행할 수 있는 환경
  • Telegram Bot 토큰

설치

기본 설치:

python3 -m pip install codex_orchestrator

특정 버전 설치:

python3 -m pip install "codex_orchestrator==<원하는_버전>"
# 예: python3 -m pip install "codex_orchestrator==0.1.4"

버전 변경(업그레이드/다운그레이드):

python3 -m pip install --upgrade "codex_orchestrator==<원하는_버전>"

Ubuntu/Debian 계열에서 아래 오류가 발생할 수 있습니다. error: externally-managed-environment

오류 발생 시 설치 방법 1 (사용자 계정 설치):

python3 -m pip install --user --break-system-packages codex_orchestrator

--user로 설치하면 실행 파일이 ~/.local/bin에 설치됩니다. PATH 설정:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
hash -r

오류 발생 시 설치 방법 2 (가상환경 설치):

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -U pip
python3 -m pip install codex_orchestrator

개발 환경에서 로컬 소스를 직접 실행할 때:

python3 -m pip install mcp python-dotenv

사용자 설정 파일

  1. 환경변수 템플릿 준비
cp .env.example .env
  1. 사용자 conf 준비
mkdir -p ~/.codex-orchestrator
cp conf.toml.example ~/.codex-orchestrator/conf.toml
  1. 최소 필수 설정
  • .envTELEGRAM_BOT_TOKEN 값을 실제 토큰으로 변경
  • ~/.codex-orchestrator/conf.tomltelegram.allowed_users를 실제 사용자 ID로 변경
  • 필요 시 conf.tomlcodex.*, telegram.polling.*로 런타임 옵션 조정

참고:

  • CODEX_CONF_PATH를 설정하면 기본 경로(~/.codex-orchestrator/conf.toml) 대신 해당 파일을 사용합니다.
  • 상대 경로 working_directorysystem_prompt_file은 conf 파일 위치 기준으로 해석됩니다.

실행

PyPI 설치 기준:

codex-orchestrator

command not found가 나오면:

~/.local/bin/codex-orchestrator

로컬 소스 실행 기준:

PYTHONPATH=src python3 scripts/telegram_polling_runner.py

테스트

전체:

PYTHONPATH=src python3 -m unittest discover -s tests -p 'test_*.py' -q

특정 모듈:

PYTHONPATH=src python3 -m unittest -q tests.test_telegram_polling_runner

Telegram 명령

  • /start: 명령 안내
  • /mode single|plan: 모드 전환 (기본: plan)
  • /new: 현재 세션 초기화
  • /status: 실행 상태 확인
  • /cancel: 실행 중 요청 취소
  • /profile list|<name>: 프로파일 목록/전환

운영 파일

  • 세션: ~/.codex-orchestrator/sessions/{chatId}-{userId}.json
  • 트레이스: ~/.codex-orchestrator/traces/{yyyy-mm-dd}.jsonl

추가 문서

  • docs/telegram-integration-runbook.md: Telegram 연동/운영 절차
  • docs/usage-single-mode.md: single 모드 중심 사용 가이드

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex_orchestrator-0.2.1.tar.gz (56.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codex_orchestrator-0.2.1-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

Details for the file codex_orchestrator-0.2.1.tar.gz.

File metadata

  • Download URL: codex_orchestrator-0.2.1.tar.gz
  • Upload date:
  • Size: 56.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for codex_orchestrator-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2505c7307ba927af80111ee931dd00bc87b025a1e3071a87aff4209e912a6a83
MD5 e93863a9de526b0d385eea2a5b2df391
BLAKE2b-256 de6a939d1f79409d80c35f394d3d95686d4ebb87bc9abf8c550c79f9d4f021c4

See more details on using hashes here.

File details

Details for the file codex_orchestrator-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_orchestrator-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6dc060e2fba26b5d9e86e4fd97068b2e065326cd17006f6f62bd6f5acf16d2c3
MD5 e023d3a6f09fa8471354429637f73592
BLAKE2b-256 9808bab6a751c72c52ada0f213248df11b74de761d21ea522685593ddc89144b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page