README
¶
Codex through ACP
Use an installed Codex CLI from an ACP-compatible editor or client:
wingman acp codex
Configure the client to launch wingman with arguments ["acp", "codex"].
The default backend uses Codex's existing login, configuration, and session
storage. Install Codex and sign in through its CLI first.
To use a Wingman gateway:
wingman acp codex --backend wingman
Set WINGMAN_URL and WINGMAN_TOKEN if the gateway requires them. The default
gateway is http://localhost:4242.
Models, plans, and history
Use the model and effort controls offered by your ACP client, or pass
--model ID and --effort LEVEL at startup.
A completed plan appears as conversation text. Clients with plan-implementation support can offer to implement it; approval starts a separate backend turn. Intermediate task lists are not shown as ACP plan notifications.
Loading a saved session replays its conversation and attachments. Command output is shown when the command completes and retains at most the last 1 MiB per command, with a marker when earlier output is omitted.
Troubleshooting
If authentication fails, sign in through the CLI and check inherited API credentials. If Codex reports an active writer, close the other process using that thread before resuming it. Restore a missing workspace directory or open a session whose workspace is still available.
A stalled backend start or cancellation can close the connection. Reconnect before sending another prompt. See the ACP setup guide for client configuration and compatibility.
Documentation
¶
Index ¶
- func Run(ctx context.Context, opts Options, in io.Reader, out io.Writer, ...) error
- type Agent
- func (a *Agent) Authenticate(context.Context, acpsdk.AuthenticateRequest) (acpsdk.AuthenticateResponse, error)
- func (a *Agent) Cancel(ctx context.Context, params acpsdk.CancelNotification) error
- func (a *Agent) Close() error
- func (a *Agent) CloseSession(ctx context.Context, params acpsdk.CloseSessionRequest) (acpsdk.CloseSessionResponse, error)
- func (a *Agent) Done() <-chan struct{}
- func (a *Agent) Initialize(ctx context.Context, req acpsdk.InitializeRequest) (acpsdk.InitializeResponse, error)
- func (a *Agent) ListSessions(ctx context.Context, params acpsdk.ListSessionsRequest) (acpsdk.ListSessionsResponse, error)
- func (a *Agent) LoadSession(ctx context.Context, params acpsdk.LoadSessionRequest) (acpsdk.LoadSessionResponse, error)
- func (a *Agent) Logout(context.Context, acpsdk.LogoutRequest) (acpsdk.LogoutResponse, error)
- func (a *Agent) NewSession(ctx context.Context, params acpsdk.NewSessionRequest) (acpsdk.NewSessionResponse, error)
- func (a *Agent) Prompt(ctx context.Context, params acpsdk.PromptRequest) (acpsdk.PromptResponse, error)
- func (a *Agent) ResumeSession(ctx context.Context, params acpsdk.ResumeSessionRequest) (acpsdk.ResumeSessionResponse, error)
- func (a *Agent) SetAgentConnection(conn *acpsdk.AgentSideConnection)
- func (a *Agent) SetSessionConfigOption(ctx context.Context, params acpsdk.SetSessionConfigOptionRequest) (acpsdk.SetSessionConfigOptionResponse, error)
- func (a *Agent) SetSessionMode(_ context.Context, params acpsdk.SetSessionModeRequest) (acpsdk.SetSessionModeResponse, error)
- func (a *Agent) Steer(ctx context.Context, sessionID acpsdk.SessionId, prompt []acpsdk.ContentBlock, ...) error
- func (a *Agent) UnstableDeleteSession(ctx context.Context, params acpsdk.UnstableDeleteSessionRequest) (acpsdk.UnstableDeleteSessionResponse, error)
- func (a *Agent) UnstableForkSession(ctx context.Context, params acpsdk.UnstableForkSessionRequest) (acpsdk.UnstableForkSessionResponse, error)
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Agent ¶
type Agent struct {
// contains filtered or unexported fields
}
func (*Agent) Authenticate ¶
func (a *Agent) Authenticate(context.Context, acpsdk.AuthenticateRequest) (acpsdk.AuthenticateResponse, error)
func (*Agent) CloseSession ¶
func (a *Agent) CloseSession(ctx context.Context, params acpsdk.CloseSessionRequest) (acpsdk.CloseSessionResponse, error)
func (*Agent) Initialize ¶
func (a *Agent) Initialize(ctx context.Context, req acpsdk.InitializeRequest) (acpsdk.InitializeResponse, error)
func (*Agent) ListSessions ¶
func (a *Agent) ListSessions(ctx context.Context, params acpsdk.ListSessionsRequest) (acpsdk.ListSessionsResponse, error)
func (*Agent) LoadSession ¶
func (a *Agent) LoadSession(ctx context.Context, params acpsdk.LoadSessionRequest) (acpsdk.LoadSessionResponse, error)
func (*Agent) Logout ¶ added in v0.8.5
func (a *Agent) Logout(context.Context, acpsdk.LogoutRequest) (acpsdk.LogoutResponse, error)
func (*Agent) NewSession ¶
func (a *Agent) NewSession(ctx context.Context, params acpsdk.NewSessionRequest) (acpsdk.NewSessionResponse, error)
func (*Agent) Prompt ¶
func (a *Agent) Prompt(ctx context.Context, params acpsdk.PromptRequest) (acpsdk.PromptResponse, error)
func (*Agent) ResumeSession ¶
func (a *Agent) ResumeSession(ctx context.Context, params acpsdk.ResumeSessionRequest) (acpsdk.ResumeSessionResponse, error)
func (*Agent) SetAgentConnection ¶
func (a *Agent) SetAgentConnection(conn *acpsdk.AgentSideConnection)
func (*Agent) SetSessionConfigOption ¶
func (a *Agent) SetSessionConfigOption(ctx context.Context, params acpsdk.SetSessionConfigOptionRequest) (acpsdk.SetSessionConfigOptionResponse, error)
func (*Agent) SetSessionMode ¶
func (a *Agent) SetSessionMode(_ context.Context, params acpsdk.SetSessionModeRequest) (acpsdk.SetSessionModeResponse, error)
func (*Agent) UnstableDeleteSession ¶ added in v0.8.5
func (a *Agent) UnstableDeleteSession(ctx context.Context, params acpsdk.UnstableDeleteSessionRequest) (acpsdk.UnstableDeleteSessionResponse, error)
func (*Agent) UnstableForkSession ¶ added in v0.15.8
func (a *Agent) UnstableForkSession(ctx context.Context, params acpsdk.UnstableForkSessionRequest) (acpsdk.UnstableForkSessionResponse, error)
Source Files