Documentation
¶
Overview ¶
Package initcmd implements the agent-factory init command behavior.
Index ¶
Constants ¶
View Source
const ( StarterExecutorCodex starterExecutor = "codex" StarterExecutorClaude starterExecutor = "claude" // DefaultStarterExecutor is the executor/provider scaffolded when --executor is omitted. DefaultStarterExecutor = string(StarterExecutorCodex) )
View Source
const ( // DefaultScaffoldType is the existing single-step task-processing scaffold. DefaultScaffoldType ScaffoldType = "default" // RalphScaffoldType is the minimal PRD-to-execution scaffold. RalphScaffoldType ScaffoldType = "ralph" // DefaultFactoryInputType is the work type created by the default scaffold. DefaultFactoryInputType = "task" // RalphFactoryInputType is the request intake work type for the Ralph scaffold. RalphFactoryInputType = "request" )
Variables ¶
This section is empty.
Functions ¶
func DefaultFactoryJSON ¶ added in v0.0.5
func DefaultFactoryJSON() string
DefaultFactoryJSON returns the canonical default init factory.json document shared by CLI init and server-side init scaffold writers.
func Init ¶
func Init(cfg InitConfig) error
Init creates the factory directory structure.
Created files and directories:
<dir>/factory.json — scaffold-specific workflow definition <dir>/workers/ — worker configuration files <dir>/workstations/ — workstation configuration files <dir>/inputs/ — multi-channel input directory <dir>/inputs/<work-type>/default/ — scaffold-specific preseed directory
After running init, start the factory with:
agent-factory run --dir <dir>
Submit work via the API (POST /work) or by placing files in the scaffold's default inputs/<work-type>/default/ directory.
func SupportedStarterExecutors ¶
func SupportedStarterExecutors() []string
Types ¶
type InitConfig ¶
type InitConfig struct {
Dir string
Type string
Executor string
JSON bool
Output io.Writer
Verbose bool
Debug bool
Diagnostics io.Writer
}
InitConfig holds parameters for the init command.
type InitResult ¶ added in v0.0.5
type InitResult struct {
ScaffoldType string `json:"scaffoldType"`
TargetDir string `json:"targetDir"`
}
InitResult reports a successful init scaffold write.
Source Files
Click to show internal directories.
Click to hide internal directories.