Documentation
¶
Index ¶
- Constants
- Variables
- func NormalizeAddDirs(dirs []string) []string
- func RegisterDispatcherAdapters(adapters DispatcherAdapters)
- func Run(ctx context.Context, cfg Config) error
- type ArchiveConfig
- type ArchiveResult
- type Config
- type DispatcherAdapters
- type FetchResult
- func FetchReviews(ctx context.Context, cfg Config) (*FetchResult, error)
- func FetchReviewsDirect(ctx context.Context, cfg Config) (*FetchResult, error)
- func FetchReviewsWithRegistryDirect(ctx context.Context, cfg Config, registry provider.RegistryReader) (*FetchResult, error)
- func WriteFetchedReviewRoundDirect(pending *FetchedReviewItems) (*FetchResult, error)
- type FetchedReviewItems
- type IDE
- type Job
- type MigrationConfig
- type MigrationResult
- type Mode
- type OutputFormat
- type Preparation
- type SyncConfig
- type SyncResult
- type WorkflowArchiveForceRequiredError
Constants ¶
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 ¶
var ErrNoWork = plan.ErrNoWork
ErrNoWork indicates that no unresolved issues or pending PRD tasks were found.
var ErrWorkflowForceRequired = errors.New("core: workflow force required")
Functions ¶
func NormalizeAddDirs ¶
NormalizeAddDirs trims, de-duplicates, and normalizes repeated add-dir values.
func RegisterDispatcherAdapters ¶ added in v0.1.10
func RegisterDispatcherAdapters(adapters DispatcherAdapters)
RegisterDispatcherAdapters installs dispatcher-backed adapters for the legacy core API entry points.
Types ¶
type ArchiveConfig ¶ added in v0.1.3
type ArchiveConfig = model.ArchiveConfig
type ArchiveResult ¶ added in v0.1.3
type ArchiveResult = model.ArchiveResult
func Archive ¶ added in v0.1.3
func Archive(ctx context.Context, cfg ArchiveConfig) (*ArchiveResult, error)
func ArchiveDirect ¶ added in v0.1.10
func ArchiveDirect(ctx context.Context, cfg ArchiveConfig) (*ArchiveResult, error)
ArchiveDirect preserves access to the pre-dispatch archive implementation for kernel handlers.
type Config ¶
type Config struct {
WorkspaceRoot string
Name string
Round int
Provider string
PR string
Nitpicks bool
ReviewsDir string
TasksDir string
DryRun bool
AutoCommit bool
Concurrent int
BatchSize int
IDE IDE
Model string
AddDirs []string
TailLines int
ReasoningEffort string
AccessMode string
AgentName string
ExplicitRuntime model.ExplicitRuntimeFlags
TaskRuntimeRules []model.TaskRuntimeRule
Mode Mode
OutputFormat OutputFormat
Verbose bool
TUI bool
Persist bool
EnableExecutableExtensions bool
RunID string
PromptText string
PromptFile string
ReadPromptStdin bool
ResolvedPromptText string
IncludeCompleted bool
Recursive bool
IncludeResolved bool
Timeout time.Duration
MaxRetries int
RetryBackoffMultiplier float64
Recovery workspacecfg.AgentRecoveryConfig
SoundEnabled bool
SoundOnCompleted string
SoundOnFailed string
}
Config configures compozy preparation and execution.
Transitional note: during Phase A of the kernel refactor this struct remains exported as the legacy translation shape used by CLI flag parsing and older call sites before they move to typed kernel commands directly.
func (Config) RuntimeConfig ¶ added in v0.1.10
func (cfg Config) RuntimeConfig() *model.RuntimeConfig
RuntimeConfig converts the legacy core.Config shape into the shared runtime configuration.
type DispatcherAdapters ¶ added in v0.1.10
type DispatcherAdapters struct {
Prepare func(context.Context, Config) (*Preparation, error)
Run func(context.Context, Config) error
FetchReviews func(context.Context, Config) (*FetchResult, error)
Migrate func(context.Context, MigrationConfig) (*MigrationResult, error)
Sync func(context.Context, SyncConfig) (*SyncResult, error)
Archive func(context.Context, ArchiveConfig) (*ArchiveResult, error)
}
DispatcherAdapters lets the kernel register dispatcher-backed core adapters without creating an import cycle from core back to kernel.
type FetchResult ¶
type FetchResult = model.FetchResult
func FetchReviews ¶
func FetchReviews(ctx context.Context, cfg Config) (*FetchResult, error)
func FetchReviewsDirect ¶ added in v0.1.10
func FetchReviewsDirect(ctx context.Context, cfg Config) (*FetchResult, error)
FetchReviewsDirect preserves access to the pre-dispatch fetch implementation for kernel handlers.
func FetchReviewsWithRegistryDirect ¶ added in v0.2.0
func FetchReviewsWithRegistryDirect( ctx context.Context, cfg Config, registry provider.RegistryReader, ) (*FetchResult, error)
func WriteFetchedReviewRoundDirect ¶ added in v0.2.0
func WriteFetchedReviewRoundDirect(pending *FetchedReviewItems) (*FetchResult, error)
WriteFetchedReviewRoundDirect writes a previously fetched non-empty review round.
type FetchedReviewItems ¶ added in v0.2.0
type FetchedReviewItems struct {
Name string
Provider string
PR string
Round int
ReviewsDir string
Items []provider.ReviewItem
}
FetchedReviewItems captures normalized provider feedback before round files are written.
func FetchReviewItemsWithRegistryDirect ¶ added in v0.2.0
func FetchReviewItemsWithRegistryDirect( ctx context.Context, cfg Config, registry provider.RegistryReader, ) (*FetchedReviewItems, error)
FetchReviewItemsWithRegistryDirect fetches normalized review items without writing round files.
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 // IDEDevin runs Devin CLI jobs. IDEDevin IDE = model.IDEDevin )
type Job ¶
type Job struct {
CodeFiles []string
SafeName string
IDE string
Model string
ReasoningEffort 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 MigrationConfig = model.MigrationConfig
type MigrationResult ¶
type MigrationResult = model.MigrationResult
func Migrate ¶
func Migrate(ctx context.Context, cfg MigrationConfig) (*MigrationResult, error)
func MigrateDirect ¶ added in v0.1.10
func MigrateDirect(ctx context.Context, cfg MigrationConfig) (*MigrationResult, error)
MigrateDirect preserves access to the pre-dispatch migration implementation for kernel handlers.
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.
func NewPreparation ¶ added in v0.1.10
func NewPreparation(prep *model.SolvePreparation) *Preparation
NewPreparation clones a solve preparation into the public core API shape.
type SyncConfig ¶
type SyncConfig = model.SyncConfig
type SyncResult ¶
type SyncResult = model.SyncResult
func Sync ¶
func Sync(ctx context.Context, cfg SyncConfig) (*SyncResult, error)
func SyncDirect ¶ added in v0.1.10
func SyncDirect(ctx context.Context, cfg SyncConfig) (*SyncResult, error)
SyncDirect preserves access to the pre-dispatch sync implementation for kernel handlers.
func SyncWithDB ¶ added in v0.2.0
func SyncWithDB( ctx context.Context, db *globaldb.GlobalDB, workspace globaldb.Workspace, cfg SyncConfig, ) (*SyncResult, error)
SyncWithDB reconciles workflow artifacts into an already-open global.db.
type WorkflowArchiveForceRequiredError ¶ added in v0.2.2
type WorkflowArchiveForceRequiredError struct {
WorkspaceID string
WorkflowID string
Slug string
Reason string
TaskTotal int
TaskNonTerminal int
ReviewTotal int
ReviewUnresolved int
}
WorkflowArchiveForceRequiredError reports a workflow archive conflict that can be resolved locally by completing tasks and resolving review issues.
func (WorkflowArchiveForceRequiredError) Error ¶ added in v0.2.2
func (e WorkflowArchiveForceRequiredError) Error() string
func (WorkflowArchiveForceRequiredError) Is ¶ added in v0.2.2
func (e WorkflowArchiveForceRequiredError) Is(target error) bool
Directories
¶
| Path | Synopsis |
|---|---|
|
Package extensions provides manifest parsing, discovery, declarative asset extraction, and local enablement state for Compozy extensions.
|
Package extensions provides manifest parsing, discovery, declarative asset extraction, and local enablement state for Compozy extensions. |
|
builtin
Package builtin anchors the embedded extension discovery root.
|
Package builtin anchors the embedded extension discovery root. |
|
Package gitenv centralizes process environment sanitization for internal git commands that explicitly select their repository with -C or Cmd.Dir.
|
Package gitenv centralizes process environment sanitization for internal git commands that explicitly select their repository with -C or Cmd.Dir. |
|
Package kernel provides typed command dispatch for core engine operations.
|
Package kernel provides typed command dispatch for core engine operations. |
|
commands
Package commands defines typed kernel command and result contracts.
|
Package commands defines typed kernel command and result contracts. |
|
recovery
Package recovery defines run recovery contracts and helpers.
|
Package recovery defines run recovery contracts and helpers. |
|
Package sound provides optional audio notifications for run-lifecycle events.
|
Package sound provides optional audio notifications for run-lifecycle events. |
|
Package worktree captures deterministic fingerprints of a workspace's uncommitted state and derives the set of paths produced by a task run.
|
Package worktree captures deterministic fingerprints of a workspace's uncommitted state and derives the set of paths produced by a task run. |