Documentation
¶
Overview ¶
Package shortcuts provides AI-powered git workflow shortcut definitions and an execution engine. Shortcuts are concise aliases for multi-step git operations that execute through the AI git client middleware.
Index ¶
- Constants
- Variables
- type Arg
- type Engine
- func (e *Engine) Execute(ctx context.Context, name string, args map[string]string) (*ExecutionResult, error)
- func (e *Engine) List() []Shortcut
- func (e *Engine) Plan(name string, args map[string]string) ([]Step, error)
- func (e *Engine) RegisterCustom(s Shortcut)
- func (e *Engine) Resolve(name string) (Shortcut, bool)
- type ExecutionResult
- type Shortcut
- type Step
- type StepResult
Constants ¶
const ( OnFailStop = "stop" OnFailContinue = "continue" OnFailAsk = "ask" )
OnFail policy constants.
const ( OpStage = "stage" OpUnstage = "unstage" OpCommit = "commit" OpPush = "push" OpPull = "pull" OpFetch = "fetch" OpRebase = "rebase" OpMerge = "merge" OpCheckout = "checkout" OpBranch = "branch" OpReset = "reset" OpDelete = "delete_branch" OpStash = "stash" OpStashPop = "stash_pop" OpBranchRename = "branch_rename" )
Operation name constants used in Step.Op.
Variables ¶
var ( ErrUnknownShortcut = errors.New("unknown shortcut") ErrUnknownOperation = errors.New("unknown operation") ErrUnsupportedResetMode = errors.New("unsupported reset mode") )
Sentinel errors for testable error checking via errors.Is().
Functions ¶
This section is empty.
Types ¶
type Engine ¶
type Engine struct {
// contains filtered or unexported fields
}
Engine resolves and executes shortcut workflows.
func (*Engine) Execute ¶
func (e *Engine) Execute(ctx context.Context, name string, args map[string]string) (*ExecutionResult, error)
Execute runs the shortcut with the given arguments. Steps are executed sequentially through the git client.
func (*Engine) List ¶
List returns all available shortcuts (custom overrides merged with built-ins).
func (*Engine) Plan ¶
Plan returns the execution steps for a shortcut after resolving argument placeholders. This is useful for --dry-run previews.
func (*Engine) RegisterCustom ¶
RegisterCustom adds a custom shortcut, overriding any built-in with the same name.
type ExecutionResult ¶
type ExecutionResult struct {
Err error
StepResults []StepResult
Shortcut Shortcut
}
ExecutionResult captures the outcome of a full shortcut execution.
type Shortcut ¶
type Shortcut struct {
Name string
Description string
Steps []Step
Args []Arg
Builtin bool
Confirm bool // default true
}
Shortcut defines a named multi-step git workflow.
type Step ¶
type Step struct {
Op string // git operation name (e.g. "stage", "commit", "push")
Params map[string]string // operation parameters
OnFail string // "stop" | "continue" | "ask" (default "stop")
AIAssist bool // use AI assistance for this step (default true)
}
Step represents a single operation within a shortcut workflow.
Source Files