Documentation
¶
Overview ¶
Package initialize implements the "ctx init" command for initializing a .context/ directory with template files.
The init command creates the foundation for persistent AI context by generating template files for constitution rules, tasks, decisions, learnings, conventions, and architecture documentation. It also sets up Claude Code integration with hooks and slash commands.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
root
Package root implements the ctx init command.
|
Package root implements the ctx init command. |
|
Package core provides helper functions for the initialize command.
|
Package core provides helper functions for the initialize command. |
|
backup
Package backup creates timestamped backups of files before overwriting them during initialization.
|
Package backup creates timestamped backups of files before overwriting them during initialization. |
|
claude
Package claude creates or merges CLAUDE.md with ctx project instructions and content markers.
|
Package claude creates or merges CLAUDE.md with ctx project instructions and content markers. |
|
entry
Package entry finds insertion points in existing Markdown files for ctx content during initialization.
|
Package entry finds insertion points in existing Markdown files for ctx content during initialization. |
|
merge
Package merge orchestrates create-or-merge operations with interactive confirmation and marker-based content updates.
|
Package merge orchestrates create-or-merge operations with interactive confirmation and marker-based content updates. |
|
plan
Package plan creates or merges IMPLEMENTATION_PLAN.md with project planning templates during initialization.
|
Package plan creates or merges IMPLEMENTATION_PLAN.md with project planning templates during initialization. |
|
plugin
Package plugin enables and checks the ctx plugin in Claude Code settings and installed plugins configuration.
|
Package plugin enables and checks the ctx plugin in Claude Code settings and installed plugins configuration. |
|
project
Package project defines project-root directories created during initialization, such as specs/ and ideas/.
|
Package project defines project-root directories created during initialization, such as specs/ and ideas/. |
|
prompt
Package prompt creates or merges PROMPT.md with ctx system prompt templates during initialization.
|
Package prompt creates or merges PROMPT.md with ctx system prompt templates during initialization. |
|
tpl
Package tpl deploys embedded templates to subdirectories during initialization, handling skip-or-overwrite logic for each file.
|
Package tpl deploys embedded templates to subdirectories during initialization, handling skip-or-overwrite logic for each file. |
|
validate
Package validate checks that the ctx binary is available in PATH before initialization proceeds.
|
Package validate checks that the ctx binary is available in PATH before initialization proceeds. |
Click to show internal directories.
Click to hide internal directories.