Documentation
¶
Overview ¶
Package config provides configuration constants, regex patterns, and entry type definitions used across the ctx codebase.
It centralizes magic strings (file names, directory names, headings), file permissions, regex patterns for parsing Markdown context files, and template strings for generating output. All repeated literals are defined here to prevent drift across packages.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent defines budget, cooldown, and scoring constants for the ctx agent command.
|
Package agent defines budget, cooldown, and scoring constants for the ctx agent command. |
|
Package architecture defines constants for architecture map files and staleness checks.
|
Package architecture defines constants for architecture map files and staleness checks. |
|
Package archive defines constants for task archival, backups, and snapshot formatting.
|
Package archive defines constants for task archival, backups, and snapshot formatting. |
|
Package asset defines path constants for embedded asset directories and files.
|
Package asset defines path constants for embedded asset directories and files. |
|
Package bootstrap defines display and parsing constants for the ctx bootstrap command.
|
Package bootstrap defines display and parsing constants for the ctx bootstrap command. |
|
Package box defines box-drawing characters and layout constants for nudge display.
|
Package box defines box-drawing characters and layout constants for nudge display. |
|
Package ceremony defines configuration constants for end-of-session ceremony hooks.
|
Package ceremony defines configuration constants for end-of-session ceremony hooks. |
|
Package claude defines constants for Claude API content types, roles, and integration files.
|
Package claude defines constants for Claude API content types, roles, and integration files. |
|
Package cli defines CLI annotation keys, XML attribute names, and confirmation input constants.
|
Package cli defines CLI annotation keys, XML attribute names, and confirmation input constants. |
|
Package content defines constants for content detection and validation.
|
Package content defines constants for content detection and validation. |
|
Package crypto defines constants for encryption key sizes, nonce lengths, and key file names.
|
Package crypto defines constants for encryption key sizes, nonce lengths, and key file names. |
|
Package ctx defines the canonical context file read order and required file lists.
|
Package ctx defines the canonical context file read order and required file lists. |
|
Package dep defines the dependency detection map used by ctx sync.
|
Package dep defines the dependency detection map used by ctx sync. |
|
Package dir defines directory path constants used throughout the application.
|
Package dir defines directory path constants used throughout the application. |
|
Package doctor defines check names and category constants for ctx doctor results.
|
Package doctor defines check names and category constants for ctx doctor results. |
|
embed
|
|
|
cmd
Package cmd defines description key constants for CLI commands.
|
Package cmd defines description key constants for CLI commands. |
|
flag
Package flag defines description key constants for CLI flags.
|
Package flag defines description key constants for CLI flags. |
|
text
Package text defines description key constants for user-facing text.
|
Package text defines description key constants for user-facing text. |
|
Package entry defines entry type identifiers, field names, and file routing maps.
|
Package entry defines entry type identifiers, field names, and file routing maps. |
|
Package env defines environment variable names and toggle values for ctx configuration.
|
Package env defines environment variable names and toggle values for ctx configuration. |
|
Package event defines event log constants, display limits, and context-size event names.
|
Package event defines event log constants, display limits, and context-size event names. |
|
Package file defines file extension, filename, and profile constants used across ctx.
|
Package file defines file extension, filename, and profile constants used across ctx. |
|
Package flag defines CLI flag name constants for registration and error display.
|
Package flag defines CLI flag name constants for registration and error display. |
|
Package fmt defines output format identifiers for CLI commands.
|
Package fmt defines output format identifiers for CLI commands. |
|
Package format provides shared constants for number and unit formatting.
|
Package format provides shared constants for number and unit formatting. |
|
Package freshness defines constants for technology-dependent file staleness checks.
|
Package freshness defines constants for technology-dependent file staleness checks. |
|
Package fs defines file and directory permission constants.
|
Package fs defines file and directory permission constants. |
|
Package git provides constants for git binary invocation.
|
Package git provides constants for git binary invocation. |
|
Package heartbeat defines state file prefixes and filenames for the heartbeat subsystem.
|
Package heartbeat defines state file prefixes and filenames for the heartbeat subsystem. |
|
Package hook defines hook names, event lifecycle stages, decision values, and prefixes.
|
Package hook defines hook names, event lifecycle stages, decision values, and prefixes. |
|
Package journal defines constants for journal export, site generation, and display limits.
|
Package journal defines constants for journal export, site generation, and display limits. |
|
Package knowledge defines configuration constants for the knowledge hook.
|
Package knowledge defines configuration constants for the knowledge hook. |
|
Package load_gate defines constants for the context load gate and auto-prune subsystem.
|
Package load_gate defines constants for the context load gate and auto-prune subsystem. |
|
Package loop defines configuration constants for loop script generation.
|
Package loop defines configuration constants for loop script generation. |
|
Package marker defines HTML comment markers for parsing and generating embedded context blocks.
|
Package marker defines HTML comment markers for parsing and generating embedded context blocks. |
|
Package mcp defines constants for the MCP server protocol integration.
|
Package mcp defines constants for the MCP server protocol integration. |
|
cfg
Package cfg defines MCP server defaults and limits.
|
Package cfg defines MCP server defaults and limits. |
|
event
Package event defines session lifecycle event type values ("start", "end") used by the ctx_session_event tool.
|
Package event defines session lifecycle event type values ("start", "end") used by the ctx_session_event tool. |
|
field
Package field defines JSON property key names for MCP tool input schemas, matching the keys clients send in tool call arguments.
|
Package field defines JSON property key names for MCP tool input schemas, matching the keys clients send in tool call arguments. |
|
method
Package method defines JSON-RPC 2.0 method strings from the MCP specification, used for request routing in the server dispatch loop.
|
Package method defines JSON-RPC 2.0 method strings from the MCP specification, used for request routing in the server dispatch loop. |
|
mime
Package mime defines MIME types and content type identifiers for MCP responses.
|
Package mime defines MIME types and content type identifiers for MCP responses. |
|
notify
Package notify defines MCP notification method strings sent to clients when subscribed resources change.
|
Package notify defines MCP notification method strings sent to clients when subscribed resources change. |
|
prompt
Package prompt defines MCP prompt names that mirror ctx CLI skills as protocol-native equivalents for MCP clients.
|
Package prompt defines MCP prompt names that mirror ctx CLI skills as protocol-native equivalents for MCP clients. |
|
resource
Package resource defines MCP resource name constants used as URI suffixes and display names in resource listings.
|
Package resource defines MCP resource name constants used as URI suffixes and display names in resource listings. |
|
schema
Package schema defines JSON Schema type identifiers used in MCP tool input schema definitions.
|
Package schema defines JSON Schema type identifiers used in MCP tool input schema definitions. |
|
server
Package server defines MCP server identity constants (name, URI prefix, JSON-RPC version) reported during the `initialize` handshake.
|
Package server defines MCP server identity constants (name, URI prefix, JSON-RPC version) reported during the `initialize` handshake. |
|
tool
Package tool defines MCP tool names that map to ctx CLI subcommands exposed over the MCP protocol.
|
Package tool defines MCP tool names that map to ctx CLI subcommands exposed over the MCP protocol. |
|
Package memory defines constants for memory bridge files, publish budgets, and mirror paths.
|
Package memory defines constants for memory bridge files, publish budgets, and mirror paths. |
|
Package msg defines formatting constants for hook message table display.
|
Package msg defines formatting constants for hook message table display. |
|
Package nudge defines configuration constants for persistence and task-completion nudge hooks.
|
Package nudge defines configuration constants for persistence and task-completion nudge hooks. |
|
Package obsidian defines directory, file, and MOC page constants for Obsidian vault generation.
|
Package obsidian defines directory, file, and MOC page constants for Obsidian vault generation. |
|
Package pad defines constants for encrypted scratchpad blob storage and file management.
|
Package pad defines constants for encrypted scratchpad blob storage and file management. |
|
Package parser defines buffer sizes and directory constants for session parsing.
|
Package parser defines buffer sizes and directory constants for session parsing. |
|
Package project defines project-root file constants outside the .context/ directory.
|
Package project defines project-root file constants outside the .context/ directory. |
|
Package regex defines compiled regular expressions for parsing context files and CLI output.
|
Package regex defines compiled regular expressions for parsing context files and CLI output. |
|
Package reminder defines file constants for the session reminder subsystem.
|
Package reminder defines file constants for the session reminder subsystem. |
|
Package rss defines defaults and formatting constants for site feed generation.
|
Package rss defines defaults and formatting constants for site feed generation. |
|
Package runtime defines default values for runtime configuration options overridable via .ctxrc.
|
Package runtime defines default values for runtime configuration options overridable via .ctxrc. |
|
Package session defines session metadata constants and tool identifiers for parsers.
|
Package session defines session metadata constants and tool identifiers for parsers. |
|
Package stats defines constants for context size monitoring, health checks, and display formatting.
|
Package stats defines constants for context size monitoring, health checks, and display formatting. |
|
Package sync defines constants for the ctx sync command, including config file detection patterns.
|
Package sync defines constants for the ctx sync command, including config file detection patterns. |
|
Package time defines date and time format layouts and duration constants.
|
Package time defines date and time format layouts and duration constants. |
|
Package token defines string tokens, delimiters, and content detection constants.
|
Package token defines string tokens, delimiters, and content detection constants. |
|
Package version defines constants for version checking and the development build sentinel.
|
Package version defines constants for version checking and the development build sentinel. |
|
Package watch defines buffer size constants for the stream scanner.
|
Package watch defines buffer size constants for the stream scanner. |
|
Package wrap defines marker constants for end-of-session wrap-up detection.
|
Package wrap defines marker constants for end-of-session wrap-up detection. |
|
Package zensical defines site configuration constants for Zensical and MkDocs integration.
|
Package zensical defines site configuration constants for Zensical and MkDocs integration. |
Click to show internal directories.
Click to hide internal directories.