클라이언트 옵션 목록
클라이언트는config/copilot.php에서 설정합니다.
같은 옵션을 배열로 Copilot::client(), useStdio() / useTcp(), new Client([...])에 전달할 수도 있습니다.
이 페이지에서는 설정 파일의 옵션과 코드에서만 전달할 수 있는 옵션을 정리합니다.
설정 파일의 옵션
연결
mode: 클라이언트 모드입니다.'copilot-cli'(일반) 또는'empty'를 지정합니다.empty는 CLI의 암묵적인 기능을 비활성화합니다. 이 모드에서는 base directory, SessionFs, TCP URL 중 하나를 명시적으로 설정해야 합니다.url: 기존 Copilot CLI 서버의 URL입니다(예:tcp://127.0.0.1:12345). 설정하면 SDK는 새 CLI 프로세스를 시작하지 않고 이 서버에 연결합니다. 자세한 내용은 TCP 모드를 참조하세요.cli_path: CLI 실행 파일의 경로입니다.null로 설정하면 CLI를 자동으로 찾습니다.cli_args: CLI 시작 시 전달할 추가 인수입니다(예:['--yolo']).cwd: CLI 프로세스의 작업 디렉터리입니다.log_level: CLI 서버의 로그 레벨입니다.none,error,warning,info,debug,all중에서 선택합니다.
기본값
timeout:sendAndWait()의 기본 타임아웃(초)입니다.Copilot::run()도 이 값을 사용합니다.model: 모델을 지정하지 않고 세션을 만들 때의 기본 모델입니다.permission_approve: Facade(Copilot::run()등)를 사용할 때 권한 요청을 자동으로 처리하는 방법입니다.'deny-all'(모두 거부),'approve-safety'(shell과 write를 제외하고 모두 승인),'approve-all'(모두 승인),false(핸들러를 주입하지 않음) 중에서 선택합니다. Client를 직접 사용할 때는 항상onPermissionRequest핸들러가 필요합니다. 자세한 내용은 권한 요청을 참조하세요.
데이터 저장 위치
copilot_home: Copilot 데이터(세션 상태와 설정)의 기본 디렉터리입니다. SDK는 시작하는 CLI 프로세스에COPILOT_HOME환경 변수로 전달합니다. 설정하지 않으면 CLI의 기본값(~/.copilot)이 적용됩니다.base_directory: 공식 SDK의 이름을 사용하는copilot_home의 별칭입니다. 둘 다 설정하면base_directory가 우선됩니다.session_fs: 세션 상태(파일과 SQLite)를 직접 만든 스토리지에 위임하는 SessionFs 프로바이더의 설정입니다.initialCwd,sessionStatePath,conventions는 필수입니다. 설정하면 각 세션에서도createSessionFsProvider를 지정해야 합니다.builtin_plugin_directories: 신뢰할 수 있는 내장 플러그인 디렉터리의 절대 경로 배열입니다. SDK는 클라이언트 시작 시 이를 런타임에 등록합니다. 자세한 내용은 Plugin Directories를 참조하세요.
기타 옵션
telemetry: OpenTelemetry 설정 배열입니다(otlpEndpoint,filePath,exporterType,sourceName,captureContent). SDK는 이를 시작하는 CLI 프로세스의 환경 변수로 변환합니다. 자세한 내용은 Telemetry를 참조하세요.session_idle_timeout_seconds: 서버 전체에 적용되는 세션 유휴 타임아웃(초)입니다.0(기본값)이면 비활성화되어 세션이 무기한 유지됩니다.request_handler: 모델 레이어로 가는 HTTP 요청을 가로채는CopilotRequestHandler또는 클로저입니다(experimental). WebSocket 요청에는 적용되지 않습니다.
설정 파일에 없는 옵션
다음 옵션은 설정 파일에는 없지만useStdio(), Copilot::client(), new Client([...])의 인수로 전달할 수 있습니다.
외부 서버가 자체 인증을 관리하므로 TCP 모드에서는
github_token과 use_logged_in_user를 사용할 수 없습니다.
둘 중 하나를 설정한 상태로 TCP로 연결하면 SDK가 예외를 던집니다.
실행 중 토큰 전환에 대해서는 GitHub 토큰도 참조하세요.
많은 옵션은 snake_case와 camelCase 이름을 모두 받습니다(예: session_fs와 sessionFs, builtin_plugin_directories와 builtinPluginDirectories, request_handler와 requestHandler).