Documentation
¶
Overview ¶
Package plan is the planning screen: a chat with Claude beside the plan Claude is writing, rendered as markdown. The developer can comment on any part of the plan; comments go to Claude with their next message. When the developer approves the plan it is handed to the factory to build.
The screen is a component: its host passes it messages and draws what Content returns, and it reports that it is done with a ClosedMsg. Screen hosts it as a program of its own.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClosedMsg ¶
type ClosedMsg struct {
RunID string
}
ClosedMsg is the screen asking its host to close it: the plan was sent to the factory as run RunID, or, when RunID is "", the developer left.
type Model ¶
type Model struct {
// RunID is the factory run the plan was sent to, once it has been.
RunID string
// contains filtered or unexported fields
}
Model is the planning screen.
func New ¶
New returns the planning screen. A non-empty first message is sent as soon as the screen opens.
func (Model) Content ¶
Content is the screen as its host draws it: the panes and the footer, filling the size it was last sent.
func (Model) WithBack ¶
WithBack returns a copy of m for a host that keeps the screen when it is closed and can open it again as it was: esc, when there is nothing for it to stop or cancel, and ctrl+c close it without asking or stopping Claude.
func (Model) WithBranch ¶
WithBranch returns a copy of m that names the branch the plan is for in its header.
func (Model) WithTerminal ¶
WithTerminal returns a copy of m for a terminal with a dark background or not, that tells shift+enter from enter or not. The screen learns of a change to either from the messages its host passes on.
type Screen ¶
type Screen struct {
Model Model
}
Screen runs the planning screen as a program's whole screen, which ends when the screen closes.
Source Files