Documentation
¶
Index ¶
- Constants
- Variables
- func NormalizeAddDirs(dirs []string) []string
- func Run(ctx context.Context, cfg Config) error
- type ArchiveConfig
- type ArchiveResult
- type Config
- type FetchResult
- type IDE
- type Job
- type MigrationConfig
- type MigrationResult
- type Mode
- type OutputFormat
- type Preparation
- type SyncConfig
- type SyncResult
Constants ¶
View Source
const ( // AccessModeDefault leaves runtime permissions at the agent's native defaults. AccessModeDefault = model.AccessModeDefault // AccessModeFull requests the most permissive execution mode Compozy knows how to configure. AccessModeFull = model.AccessModeFull )
Variables ¶
View Source
var ErrNoWork = plan.ErrNoWork
ErrNoWork indicates that no unresolved issues or pending PRD tasks were found.
Functions ¶
func NormalizeAddDirs ¶
NormalizeAddDirs trims, de-duplicates, and normalizes repeated add-dir values.
Types ¶
type ArchiveConfig ¶ added in v0.1.3
type ArchiveResult ¶ added in v0.1.3
type ArchiveResult struct {
Target string
ArchiveRoot string
WorkflowsScanned int
Archived int
Skipped int
ArchivedPaths []string
SkippedReasons map[string]string
}
func Archive ¶ added in v0.1.3
func Archive(ctx context.Context, cfg ArchiveConfig) (*ArchiveResult, error)
type Config ¶
type Config struct {
WorkspaceRoot string
Name string
Round int
Provider string
PR string
ReviewsDir string
TasksDir string
DryRun bool
AutoCommit bool
Concurrent int
BatchSize int
IDE IDE
Model string
AddDirs []string
TailLines int
ReasoningEffort string
AccessMode string
Mode Mode
OutputFormat OutputFormat
Verbose bool
TUI bool
Persist bool
RunID string
PromptText string
PromptFile string
ReadPromptStdin bool
ResolvedPromptText string
IncludeCompleted bool
IncludeResolved bool
Timeout time.Duration
MaxRetries int
RetryBackoffMultiplier float64
}
Config configures compozy preparation and execution.
type FetchResult ¶
type FetchResult struct {
Name string
Provider string
PR string
Round int
ReviewsDir string
Total int
}
func FetchReviews ¶
func FetchReviews(ctx context.Context, cfg Config) (*FetchResult, error)
type IDE ¶
type IDE string
IDE identifies the downstream coding tool that compozy should invoke.
const ( // IDECodex runs Codex jobs. IDECodex IDE = model.IDECodex // IDEClaude runs Claude Code jobs. IDEClaude IDE = model.IDEClaude // IDEDroid runs Droid jobs. IDEDroid IDE = model.IDEDroid // IDECursor runs Cursor Agent jobs. IDECursor IDE = model.IDECursor // IDEOpenCode runs OpenCode jobs. IDEOpenCode IDE = model.IDEOpenCode // IDEPi runs Pi jobs. IDEPi IDE = model.IDEPi // IDEGemini runs Gemini jobs. IDEGemini IDE = model.IDEGemini // IDECopilot runs GitHub Copilot CLI jobs. IDECopilot IDE = model.IDECopilot )
type Job ¶
type Job struct {
CodeFiles []string
SafeName string
Prompt []byte
PromptPath string
StdoutLogPath string
StderrLogPath string
IssueCount int
// contains filtered or unexported fields
}
Job is a prepared execution unit with its generated artifacts.
type MigrationConfig ¶
type MigrationResult ¶
type MigrationResult struct {
Target string
DryRun bool
FilesScanned int
FilesMigrated int
V1ToV2Migrated int
FilesAlreadyFrontmatter int
FilesSkipped int
FilesInvalid int
MigratedPaths []string
UnmappedTypeFiles []string
InvalidPaths []string
}
func Migrate ¶
func Migrate(ctx context.Context, cfg MigrationConfig) (*MigrationResult, error)
type Mode ¶
type Mode string
Mode identifies the execution flow used by compozy.
const ( // ModePRReview processes PR review issue markdown files. ModePRReview Mode = model.ModeCodeReview // ModePRDTasks processes PRD task markdown files. ModePRDTasks Mode = model.ModePRDTasks // ModeExec processes one ad hoc prompt through the shared runtime. ModeExec Mode = model.ModeExec )
type OutputFormat ¶ added in v0.1.9
type OutputFormat string
OutputFormat identifies the user-facing result contract for a run.
const ( // OutputFormatText keeps the standard human-oriented presentation. OutputFormatText OutputFormat = OutputFormat(model.OutputFormatText) // OutputFormatJSON emits the lean machine-readable result contract. OutputFormatJSON OutputFormat = OutputFormat(model.OutputFormatJSON) // OutputFormatRawJSON emits the full machine-readable event stream. OutputFormatRawJSON OutputFormat = OutputFormat(model.OutputFormatRawJSON) )
type Preparation ¶
type Preparation struct {
Jobs []Job
InputDir string
ResolvedPR string
ResolvedName string
ResolvedProvider string
ResolvedRound int
InputDirPath string
}
Preparation contains the resolved execution plan for a compozy run.
type SyncConfig ¶
type SyncResult ¶
type SyncResult struct {
Target string
WorkflowsScanned int
MetaCreated int
MetaUpdated int
SyncedPaths []string
}
func Sync ¶
func Sync(ctx context.Context, cfg SyncConfig) (*SyncResult, error)
Click to show internal directories.
Click to hide internal directories.