Documentation
¶
Overview ¶
Package initialize provides terminal output functions for the initialize command.
Index ¶
- func Backup(cmd *cobra.Command, path string)
- func Created(cmd *cobra.Command, path string)
- func CreatedDir(cmd *cobra.Command, dir string)
- func CreatedWith(cmd *cobra.Command, path, qualifier string)
- func CtxContentExists(cmd *cobra.Command, path string)
- func ErrCtxNotInPath(cmd *cobra.Command)
- func FileExistsNoCtx(cmd *cobra.Command, path string)
- func InfoAborted(cmd *cobra.Command)
- func InfoCreatingRootFiles(cmd *cobra.Command)
- func InfoExistsSkipped(cmd *cobra.Command, name string)
- func InfoFileCreated(cmd *cobra.Command, name string)
- func InfoGettingStartedSaved(cmd *cobra.Command, path string)
- func InfoGitignoreReview(cmd *cobra.Command)
- func InfoGitignoreUpdated(cmd *cobra.Command, count int)
- func InfoInitialized(cmd *cobra.Command, contextDir string)
- func InfoNextSteps(cmd *cobra.Command)
- func InfoOverwritePrompt(cmd *cobra.Command, contextDir string)
- func InfoScratchpadKeyCreated(cmd *cobra.Command, keyPath string)
- func InfoScratchpadNoKey(cmd *cobra.Command, keyPath string)
- func InfoScratchpadPlaintext(cmd *cobra.Command, path string)
- func InfoSettingUpPermissions(cmd *cobra.Command)
- func InfoWarnNonFatal(cmd *cobra.Command, label string, err error)
- func InfoWorkflowTips(cmd *cobra.Command)
- func MakefileAppended(cmd *cobra.Command, filename string)
- func MakefileCreated(cmd *cobra.Command)
- func MakefileIncludes(cmd *cobra.Command, filename string)
- func MergePrompt(cmd *cobra.Command, prompt string)
- func Merged(cmd *cobra.Command, path string)
- func NoChanges(cmd *cobra.Command, path string)
- func PermsAllow(cmd *cobra.Command, path string)
- func PermsAllowDeny(cmd *cobra.Command, path string)
- func PermsDeduped(cmd *cobra.Command, path string)
- func PermsDeny(cmd *cobra.Command, path string)
- func PermsMergedDeduped(cmd *cobra.Command, path string)
- func PlanMergePrompt(cmd *cobra.Command)
- func PluginAlreadyEnabled(cmd *cobra.Command)
- func PluginEnabled(cmd *cobra.Command, settingsPath string)
- func PluginSkipped(cmd *cobra.Command)
- func Skipped(cmd *cobra.Command, path string)
- func SkippedDir(cmd *cobra.Command, dir string)
- func SkippedPlain(cmd *cobra.Command, path string)
- func UpdatedSection(cmd *cobra.Command, path, textKey string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Backup ¶
Backup reports a backup file created.
Parameters:
- cmd: Cobra command for output
- path: backup file path
func Created ¶
Created reports a file created during init.
Parameters:
- cmd: Cobra command for output
- path: created file path
func CreatedDir ¶
CreatedDir reports a directory created during init.
Parameters:
- cmd: Cobra command for output
- dir: directory name
func CreatedWith ¶
CreatedWith reports a file created with a qualifier (e.g. " (ralph mode)").
Parameters:
- cmd: Cobra command for output
- path: created file path
- qualifier: additional info appended after the path
func CtxContentExists ¶
CtxContentExists reports a file skipped because ctx content exists.
Parameters:
- cmd: Cobra command for output
- path: skipped file path
func ErrCtxNotInPath ¶
ErrCtxNotInPath prints a multi-line diagnostic to stderr explaining that ctx is not in PATH, with installation instructions.
Parameters:
- cmd: Cobra command whose stderr stream receives the output. Nil is a no-op.
func FileExistsNoCtx ¶
FileExistsNoCtx reports a file exists without ctx content.
Parameters:
- cmd: Cobra command for output
- path: file path
func InfoAborted ¶
InfoAborted reports that the user cancelled the init operation.
Parameters:
- cmd: Cobra command for output
func InfoCreatingRootFiles ¶
InfoCreatingRootFiles prints the heading before root file creation.
Parameters:
- cmd: Cobra command for output
func InfoExistsSkipped ¶
InfoExistsSkipped reports a template file skipped because it exists.
Parameters:
- cmd: Cobra command for output
- name: the template filename that was skipped
func InfoFileCreated ¶
InfoFileCreated reports a template file that was created.
Parameters:
- cmd: Cobra command for output
- name: the template filename that was created
func InfoGettingStartedSaved ¶
InfoGettingStartedSaved reports that the quick-start reference file was written.
Parameters:
- cmd: Cobra command for output
- path: File path that was written
func InfoGitignoreReview ¶
InfoGitignoreReview hints how to review changes.
Parameters:
- cmd: Cobra command for output
func InfoGitignoreUpdated ¶
InfoGitignoreUpdated reports .gitignore entries were added.
Parameters:
- cmd: Cobra command for output
- count: number of entries added
func InfoInitialized ¶
InfoInitialized reports successful context directory initialization.
Parameters:
- cmd: Cobra command for output
- contextDir: the path to the initialized .context/ directory
func InfoNextSteps ¶
InfoNextSteps prints the post-init guidance block.
Parameters:
- cmd: Cobra command for output
func InfoOverwritePrompt ¶
InfoOverwritePrompt prints the overwrite confirmation prompt.
Parameters:
- cmd: Cobra command for output
- contextDir: path to the existing .context/ directory
func InfoScratchpadKeyCreated ¶
InfoScratchpadKeyCreated reports a scratchpad key was generated.
Parameters:
- cmd: Cobra command for output
- keyPath: the path where the key was saved
func InfoScratchpadNoKey ¶
InfoScratchpadNoKey warns about a missing key for an encrypted scratchpad.
Parameters:
- cmd: Cobra command for output
- keyPath: the expected key path
func InfoScratchpadPlaintext ¶
InfoScratchpadPlaintext reports a plaintext scratchpad was created.
Parameters:
- cmd: Cobra command for output
- path: the scratchpad file path
func InfoSettingUpPermissions ¶
InfoSettingUpPermissions prints the heading before permissions setup.
Parameters:
- cmd: Cobra command for output
func InfoWarnNonFatal ¶
InfoWarnNonFatal reports a non-fatal warning during init.
Parameters:
- cmd: Cobra command for output
- label: short description of what failed (e.g. "CLAUDE.md")
- err: the non-fatal error
func InfoWorkflowTips ¶
InfoWorkflowTips prints the workflow tips block showing key skills and the ceremony loop.
Parameters:
- cmd: Cobra command for output
func MakefileAppended ¶
MakefileAppended reports an include appended to Makefile.
Parameters:
- cmd: Cobra command for output
- filename: included filename
func MakefileCreated ¶
MakefileCreated reports a new Makefile created with ctx include.
Parameters:
- cmd: Cobra command for output
func MakefileIncludes ¶
MakefileIncludes reports Makefile already includes the directive.
Parameters:
- cmd: Cobra command for output
- filename: included filename
func MergePrompt ¶
MergePrompt prints a merge confirmation prompt with y/N suffix.
Parameters:
- cmd: Cobra command for output. Nil is a no-op.
- prompt: The confirmation prompt text.
func Merged ¶
Merged reports a file merged during init.
Parameters:
- cmd: Cobra command for output
- path: merged file path
func NoChanges ¶
NoChanges reports a settings file with no changes needed.
Parameters:
- cmd: Cobra command for output
- path: settings file path
func PermsAllow ¶
PermsAllow reports ctx permissions added.
Parameters:
- cmd: Cobra command for output
- path: settings file path
func PermsAllowDeny ¶
PermsAllowDeny reports allow+deny permissions added.
Parameters:
- cmd: Cobra command for output
- path: settings file path
func PermsDeduped ¶
PermsDeduped reports duplicate permissions removed.
Parameters:
- cmd: Cobra command for output
- path: settings file path
func PermsDeny ¶
PermsDeny reports deny permissions added.
Parameters:
- cmd: Cobra command for output
- path: settings file path
func PermsMergedDeduped ¶
PermsMergedDeduped reports permissions merged and deduped.
Parameters:
- cmd: Cobra command for output
- path: settings file path
func PlanMergePrompt ¶
PlanMergePrompt prints the interactive merge confirmation prompt.
Parameters:
- cmd: Cobra command for output
func PluginAlreadyEnabled ¶
PluginAlreadyEnabled reports plugin is already enabled globally.
Parameters:
- cmd: Cobra command for output
func PluginEnabled ¶
PluginEnabled reports plugin enabled globally.
Parameters:
- cmd: Cobra command for output
- settingsPath: path to the settings file
func PluginSkipped ¶
PluginSkipped reports plugin enablement was skipped.
Parameters:
- cmd: Cobra command for output
func Skipped ¶
Skipped reports a file skipped because it already exists.
Parameters:
- cmd: Cobra command for output
- path: skipped file path
func SkippedDir ¶
SkippedDir reports a directory skipped because it exists.
Parameters:
- cmd: Cobra command for output
- dir: directory name
func SkippedPlain ¶
SkippedPlain reports a file skipped without detail.
Parameters:
- cmd: Cobra command for output
- path: skipped file path
func UpdatedSection ¶
UpdatedSection reports a file whose marked section was updated.
Parameters:
- cmd: Cobra command for output
- path: updated file path
- textKey: text descriptor key for the update message
Types ¶
This section is empty.
Source Files