Codex SDK - sterowanie agentem z kodu
Codex SDK pozwala sterować programowo Codexem używanym przez Codex CLI, rozszerzenie IDE lub Codex cloud. Służy do automatyzowania zadań programistycznych, w tym zadań wykonywanych w CI. Możesz włączyć go do pipeline'u CI/CD, własnego agenta, narzędzi wewnętrznych albo własnej aplikacji.
Do ustawiania konfiguracji strukturalnej służy config, a surowe ciągi TOML przekazuje się przez configOverrides, gdy klucza nie da się wyrazić jako ścieżki kropkowanej. Surowe nadpisania mają pierwszeństwo przed konfiguracją strukturalną. Później ustawienia zarządzane przez SDK, takie jak baseUrl i opcje właściwe dla wątku, mają pierwszeństwo przed oboma rodzajami konfiguracji.
Przykładowa konfiguracja SDK łączy default_permissions z surowym nadpisaniem uprawnień systemu plików. Nadpisania nie zmieniają plików konfiguracyjnych Codex. SDK można wykorzystać do zbudowania własnego agenta, który współpracuje z Codexem przy złożonych zadaniach inżynierskich.
Do budowania własnych klientów obsługujących uwierzytelnianie, historię konwersacji, zatwierdzenia i strumieniowane zdarzenia agenta służy Codex app server. Polecenie codex mcp-server i samodzielny plik binarny codex-mcp-server zostały usunięte; istniejące integracje powinny korzystać z Codex app server. Do skanowania repozytoriów lub zmian z ustrukturyzowanymi wynikami bezpieczeństwa i pokryciem wymagany jest dostęp beta do Codex Security TypeScript SDK.
const codex = new Codex({
config: { default_permissions: "audit" },
configOverrides: [
'permissions.audit.filesystem={":root"="read","/path/to/project/.env"="deny"}',
],
});Zastosowanie w praktyce
Wykorzystaj SDK, gdy chcesz uruchamiać zadania programistyczne w ramach CI. Wybierz je, jeśli własny agent ma współpracować z Codexem przy złożonych zadaniach inżynierskich. Możesz osadzić Codex w wewnętrznych narzędziach i przepływach pracy albo zintegrować go z własną aplikacją.
config, ale ustawienia zarządzane przez SDK, w tym baseUrl i opcje wątku, są stosowane później i mają pierwszeństwo przed obiema konfiguracjami. Nadpisania nie modyfikują plików konfiguracyjnych Codex.