Documentation
¶
Index ¶
- type Codex
- type CodexOption
- type InvokeOption
- func WithApprovalPolicy(approvalPolicy string) InvokeOption
- func WithBaseInstructions(baseInstructions string) InvokeOption
- func WithConfig(config map[string]any) InvokeOption
- func WithCwd(cwd string) InvokeOption
- func WithIncludePlanTool(includePlanTool bool) InvokeOption
- func WithModel(model string) InvokeOption
- func WithProfile(profile string) InvokeOption
- func WithSandbox(sandbox string) InvokeOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Codex ¶
type Codex struct {
// contains filtered or unexported fields
}
Codex は codex コマンドをラップするクライアント構造体です。 内部で実行コマンドのパスやログ設定、認証用のロックを保持します。
func New ¶
func New(options ...CodexOption) *Codex
New は Codex のインスタンスを作成します。 WithExecutablePath で codex コマンドの実行パスを指定します。 WithLogger で codex コマンドのログ出力を設定します。
func (*Codex) Invoke ¶
func (codex *Codex) Invoke(ctx context.Context, prompt string, options ...InvokeOption) (string, error)
Invoke は Codex を実行して結果を返します。 指定可能なオプションの詳細は以下を参照してください。 https://github.com/openai/codex/blob/main/docs/advanced.md#codex-mcp-server-quickstart
func (*Codex) SetExecutablePath ¶
SetExecutablePath は Codex インスタンスの実行ファイルパスを設定します。 テストやカスタムビルドを使う場合に利用します。
type CodexOption ¶
type CodexOption func(*Codex)
CodexOption は Codex の設定を変更するためのオプション関数です。 これを使って `New` 呼び出し時に実装固有の設定を注入できます。
func WithExecutablePath ¶
func WithExecutablePath(path string) CodexOption
WithExecutablePath は Codex が使用する実行ファイルのパスを設定する オプションを返します。デフォルトは `codex` です。
func WithLogger ¶
func WithLogger(w io.Writer, level string) CodexOption
WithLogger は Codex のログ出力先とログレベルを設定するオプションを返します。 `w` にログが書き出され、`level` でログの詳細度を制御します。
type InvokeOption ¶
type InvokeOption func(*invokeOptions) error
InvokeOption は Invoke 呼び出しに渡すオプション関数の型です。 各オプションは内部の `invokeOptions` を変更し、エラーを返すことができます。
func WithApprovalPolicy ¶
func WithApprovalPolicy(approvalPolicy string) InvokeOption
WithApprovalPolicy は承認ポリシー("untrusted", "on-failure", "never") を設定するオプションを返します。無効な値が与えられるとエラーになります。
func WithBaseInstructions ¶
func WithBaseInstructions(baseInstructions string) InvokeOption
WithBaseInstructions はツールに渡すベース命令(base instructions)を設定する オプションを返します。プロンプトに常に付加したい命令を指定します。
func WithConfig ¶
func WithConfig(config map[string]any) InvokeOption
WithConfig はツール呼び出し時に渡す追加の設定マップを指定するオプションを返します。
func WithIncludePlanTool ¶
func WithIncludePlanTool(includePlanTool bool) InvokeOption
WithIncludePlanTool は実行時にプランツールを含めるかどうかを設定するオプションを返します。
func WithProfile ¶
func WithProfile(profile string) InvokeOption
WithProfile は実行時に使用するプロファイル名を設定するオプションを返します。
func WithSandbox ¶
func WithSandbox(sandbox string) InvokeOption
WithSandbox はサンドボックス設定("read-only", "workspace-write", "danger-full-access") を指定するオプションを返します。無効な値が与えられるとエラーになります。