Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,53 @@ This tool collects context from predefined rule files and a task-specific prompt
**📖 [View Full Documentation](https://kitproj.github.io/coding-context-cli/)**
**📊 [View Slide Deck](./SLIDES.md)** | [Download PDF](./SLIDES.pdf) | [How to Present](./SLIDES_README.md)

## Generated Context Structure

The tool assembles context into a structured prompt with the following components:

```
┌─────────────────────────────────────────────────────────────┐
│ Generated Coding Context Prompt │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ 1. Task Frontmatter (YAML) │ │
│ │ • Task metadata (selectors, agent, etc.) │ │
│ │ • Always included when task has frontmatter │ │
│ └───────────────────────────────────────────────────────┘ │
│ │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ 2. Skills Metadata (XML) - Optional │ │
│ │ • Available skills with names & descriptions │ │
│ │ • Progressive disclosure - full content on demand │ │
│ │ • Only included if skills are discovered │ │
│ └───────────────────────────────────────────────────────┘ │
│ │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ 3. Rules Content (Markdown) │ │
│ │ • Coding standards and guidelines │ │
│ │ • Team conventions and best practices │ │
│ │ • Filtered by selectors (-s flag) │ │
│ │ • Skipped in resume mode (-r flag) │ │
│ └───────────────────────────────────────────────────────┘ │
│ │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ 4. Task Content (Markdown) │ │
│ │ • Task-specific instructions │ │
│ │ • Parameter substitutions (${param}) │ │
│ │ • Command expansions (!`command`) │ │
│ │ • Path expansions (@file) │ │
│ └───────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```

**Key Points:**
- **Task Frontmatter**: Provides metadata for agent decision-making and workflow automation
- **Skills**: Enable progressive disclosure of specialized capabilities
- **Rules**: Reusable context that applies across multiple tasks
- **Task Content**: Specific instructions for the current task with dynamic content expansion

## Features

- **Dynamic Context Assembly**: Merges context from various source files.
Expand Down