CodeVetter · Repo Unpack · Behavior traces
spf13/cobra
Three concrete flows were followed through source: normal command execution, dynamic shell completion, and documentation persistence. Help and script generation provide additional branches through the same command tree. The traces describe source execution order rather than observed runtime results. Early returns and option-dependent branches materially change which callbacks run.
- Startup: Execute → ExecuteC supplies context, redirects to Root when necessary, invokes preExecHookFn, initializes help and completion commands, checks groups, then selects Find or Traverse.
- Primary action: cmd.execute initializes help/version flags → ParseFlags → preRun → deferred postRun → ValidateArgs → persistent/local pre-hooks → required/group validation → RunE or Run → local/persistent post-hooks.
- Execution exits early for parsing errors, help, version, or a non-runnable command; after execute returns ErrHelp, ExecuteC calls HelpFunc and returns nil error.
- Named help: the generated help command calls Root.Find → initializes the target's help/version flags → Help; an unknown topic prints a message and routes through Root.Usage and CheckErr.
- Dynamic completion starts when a generated Bash V2 function evaluates a request to __complete or __completeNoDesc; initCompleteCmd creates the hidden, flag-parsing-disabled command only for an actual completion invocation.
- Completion resolution runs getCompletions → Find/Traverse → checkIfFlagCompletion → ParseFlags → help/version suppression → annotation/static/callback selection; it does not call the target command's execute method.
- Script generation: completion bash dispatches its RunE to Root.GenBashCompletionV2 → genBashCompletion → genBashComp, buffers the script, and writes it to the configured output.
- Persistence: GenMarkdownTree → GenMarkdownTreeCustom recursively processes available descendants → os.Create → filePrepender → GenMarkdownCustom → printOptions → buffer.WriteTo, returning on the first encountered error.