README
¶
Coding Agent Context CLI
A command-line interface for dynamically assembling context for AI coding agents.
This tool collects context from predefined rule files and a task-specific prompt, substitutes parameters, and prints a single, combined context to standard output. This is useful for feeding a large amount of relevant information into an AI model like Claude, Gemini, or OpenAI's GPT series.
Features
- Dynamic Context Assembly: Merges context from various source files.
- Task-Specific Prompts: Use different prompts for different tasks (e.g.,
feature,bugfix). - Rule-Based Context: Define reusable context snippets (rules) that can be included or excluded.
- Frontmatter Filtering: Select rules based on metadata using frontmatter selectors (matches top-level YAML fields only).
- Bootstrap Scripts: Run scripts to fetch or generate context dynamically.
- Parameter Substitution: Inject values into your task prompts.
- Token Estimation: Get an estimate of the total token count for the generated context.
Supported Coding Agents
This tool is compatible with configuration files from various AI coding agents and IDEs:
- Anthropic Claude:
CLAUDE.md,CLAUDE.local.md,.claude/CLAUDE.md - Codex:
AGENTS.md,.codex/AGENTS.md - Cursor:
.cursor/rules,.cursorrules - Augment:
.augment/rules,.augment/guidelines.md - Windsurf:
.windsurf/rules,.windsurfrules - OpenCode.ai:
.opencode/agent,.opencode/command,.opencode/rules - GitHub Copilot:
.github/copilot-instructions.md,.github/agents - Google Gemini:
GEMINI.md,.gemini/styleguide.md - Generic AI Agents:
AGENTS.md,.agents/rules,.agents/commands(tasks),.agents/tasks
The tool automatically discovers and includes rules from these locations in your project, parent directories, and user home directory (~).
Agentic Workflows
This tool plays a crucial role in the agentic workflow ecosystem by providing rich, contextual information to AI agents. It complements systems like GitHub Next's Agentic Workflows by:
- Context Preparation: Assembles rules, guidelines, and task-specific prompts before agent execution
- Workflow Integration: Can be invoked in GitHub Actions to provide context to autonomous agents
- Dynamic Context: Supports runtime parameters and bootstrap scripts for real-time information
- Multi-Stage Support: Different context assemblies for planning, implementation, and validation stages
For a comprehensive guide on using this tool with agentic workflows, see AGENTIC_WORKFLOWS.md.
Installation
You can install the CLI by downloading the latest release from the releases page or by building from source.
Linux
AMD64:
sudo curl -fsL -o /usr/local/bin/coding-context https://github.com/kitproj/coding-context-cli/releases/download/v0.0.16/coding-context_v0.0.16_linux_amd64
sudo chmod +x /usr/local/bin/coding-context
ARM64:
sudo curl -fsL -o /usr/local/bin/coding-context https://github.com/kitproj/coding-context-cli/releases/download/v0.0.16/coding-context_v0.0.16_linux_arm64
sudo chmod +x /usr/local/bin/coding-context
MacOS
Intel (AMD64):
sudo curl -fsL -o /usr/local/bin/coding-context https://github.com/kitproj/coding-context-cli/releases/download/v0.0.16/coding-context_v0.0.16_darwin_amd64
sudo chmod +x /usr/local/bin/coding-context
Apple Silicon (ARM64):
sudo curl -fsL -o /usr/local/bin/coding-context https://github.com/kitproj/coding-context-cli/releases/download/v0.0.16/coding-context_v0.0.16_darwin_arm64
sudo chmod +x /usr/local/bin/coding-context
Usage
Usage:
coding-context [options] <task-name>
Options:
-C string
Change to directory before doing anything. (default ".")
-d value
Remote directory containing rules and tasks. Can be specified multiple times. Supports various protocols via go-getter (http://, https://, git::, s3::, etc.).
-p value
Parameter to substitute in the prompt. Can be specified multiple times as key=value.
-r Resume mode: skip outputting rules and select task with 'resume: true' in frontmatter.
-s value
Include rules with matching frontmatter. Can be specified multiple times as key=value.
Note: Only matches top-level YAML fields in frontmatter.
-a value
Target agent to use (excludes rules from other agents). Supported agents: cursor, opencode, copilot, claude, gemini, augment, windsurf, codex.
Examples
Basic usage with local files:
coding-context -p jira_issue_key=PROJ-1234 fix-bug | llm -m gemini-pro
This command will:
- Find a task file with
task_name: fix-bugin its frontmatter. - Find all rule files in the search paths.
- Filter the rules based on selectors.
- Execute any associated bootstrap scripts.
- Substitute
${jira_issue_key}withPROJ-1234in the task prompt. - Print the combined context (rules + task) to
stdout. - Pipe the output to another program (in this case,
llm).
Using remote directories:
coding-context \
-d git::https://github.com/company/shared-rules.git \
-d s3::https://s3.amazonaws.com/my-bucket/coding-standards \
fix-bug | llm -m gemini-pro
This command will:
- Download remote directories using go-getter
- Search for rules and tasks in the downloaded directories
- Combine them with local rules and tasks
- Apply the same processing as with local files
The -d flag supports various protocols via go-getter:
http://andhttps://- HTTP/HTTPS URLsgit::- Git repositoriess3::- S3 bucketsfile://- Local file paths- And more (see go-getter documentation)
Example Tasks
The <task-name> is the value of the task_name field in the frontmatter of task files. Here are some common examples:
triage-bugreview-pull-requestfix-broken-buildmigrate-java-versionenhance-docsremove-feature-flagspeed-up-build
Each of these would have a corresponding .md file with task_name in the frontmatter (e.g., a file with task_name: triage-bug).
How It Works
The tool assembles the context in the following order:
- Rule Files: It searches a list of predefined locations for rule files (
.mdor.mdc). These locations include the current directory, ancestor directories, user's home directory, and system-wide directories. - Rule Bootstrap Scripts: For each rule file found (e.g.,
my-rule.md), it looks for an executable script namedmy-rule-bootstrap. If found, it runs the script before processing the rule file. These scripts are meant for bootstrapping the environment (e.g., installing tools) and their output is sent tostderr, not into the main context. - Filtering: If
-s(include) flag is used, it parses the YAML frontmatter of each rule file to decide whether to include it. Note that selectors can only match top-level YAML fields (e.g.,language: go), not nested fields. - Task Prompt: It searches for a task file with
task_name: <task-name>in its frontmatter. The filename doesn't matter. If selectors are provided with-s, they are used to filter between multiple task files with the sametask_name. - Task Bootstrap Script: For the task file found (e.g.,
fix-bug.md), it looks for an executable script namedfix-bug-bootstrap. If found, it runs the script before processing the task file. This allows task-specific environment setup or data preparation. - Parameter Expansion: It substitutes variables in the task prompt using the
-pflags. - Output: It prints the content of all included rule files, followed by the expanded task prompt, to standard output.
- Token Count: A running total of estimated tokens is printed to standard error.
File Search Paths
The tool looks for task and rule files in the following locations, in order of precedence:
Tasks:
./.agents/tasks/*.md(any.mdfile with matchingtask_namein frontmatter)./.agents/commands/*.md./.cursor/commands/*.md./.opencode/command/*.md~/.agents/tasks/*.md
Rules: The tool searches for a variety of files and directories, including:
CLAUDE.local.md.agents/rules,.cursor/rules,.augment/rules,.windsurf/rules,.opencode/agent,.opencode/command.github/copilot-instructions.md,.gemini/styleguide.mdAGENTS.md,CLAUDE.md,GEMINI.md(and in parent directories)- User-specific rules in
~/.agents/rules,~/.claude/CLAUDE.md,~/.opencode/rules, etc.
Remote File System Support
The tool supports loading rules and tasks from remote locations via HTTP/HTTPS URLs. This enables:
- Shared team guidelines: Host coding standards on a central server
- Organization-wide rules: Distribute common rules across multiple projects
- Version-controlled context: Serve rules from Git repositories
- Dynamic rules: Update shared rules without modifying individual repositories
Usage:
# Clone a Git repository containing rules
coding-context -d git::https://github.com/company/shared-rules.git fix-bug
# Use multiple remote sources
coding-context \
-d git::https://github.com/company/shared-rules.git \
-d https://cdn.company.com/coding-standards \
deploy
# Mix local and remote directories
coding-context \
-d git::https://github.com/company/shared-rules.git \
-s language=Go \
implement-feature
Supported protocols (via go-getter):
http://andhttps://- HTTP/HTTPS URLs (downloads tar.gz, zip, or directories)git::- Git repositories (e.g.,git::https://github.com/user/repo.git)s3::- S3 buckets (e.g.,s3::https://s3.amazonaws.com/bucket/path)file://- Local file paths- And more - see go-getter documentation
Important notes:
- Remote directories are downloaded to a temporary location
- Bootstrap scripts work in downloaded directories
- Downloaded directories are cleaned up after execution
- Supports all standard directory structures (
.agents/rules,.agents/tasks, etc.)
Example: Using a Git repository:
# Use a specific branch or tag
coding-context \
-d 'git::https://github.com/company/shared-rules.git?ref=v1.0' \
fix-bug
# Use a subdirectory within the repo
coding-context \
-d 'git::https://github.com/company/mono-repo.git//coding-standards' \
implement-feature
File Formats
Task Files
Task files are Markdown files with a required task_name field in the frontmatter. The filename itself doesn't matter - only the task_name value is used for selection. Task files can contain variables for substitution and can use selectors in frontmatter to provide different prompts for the same task.
Example (.agents/tasks/fix-bug.md):
---
task_name: fix-bug
---
# Task: Fix Bug in ${jira_issue_key}
Here is the context for the bug. Please analyze the following files and provide a fix.
Example with selectors for multiple prompts (.agents/tasks/deploy-staging.md):
---
task_name: deploy
environment: staging
---
# Deploy to Staging
Deploy the application to the staging environment with extra validation.
Example for production (.agents/tasks/deploy-prod.md):
---
task_name: deploy
environment: production
---
# Deploy to Production
Deploy the application to production with all safety checks.
You can then select the appropriate task using:
# Deploy to staging
coding-context -s environment=staging deploy
# Deploy to production
coding-context -s environment=production deploy
Task Frontmatter Selectors
Task files can include a selectors field in their frontmatter to automatically filter rules without requiring explicit -s flags on the command line. This is useful for tasks that always need specific rules.
Example (.agents/tasks/implement-go-feature.md):
---
task_name: implement-feature
selectors:
language: Go
stage: implementation
---
# Implement Feature
Implement the feature following Go best practices and implementation guidelines.
When you run this task, it automatically applies the selectors:
# This command automatically includes only rules with language=Go and stage=implementation
coding-context implement-feature
This is equivalent to:
coding-context -s language=Go -s stage=implementation implement-feature
Selectors support OR logic for the same key using arrays:
---
task_name: test-code
selectors:
language: [Go, Python]
stage: testing
---
This will include rules that match (language=Go OR language=Python) AND stage=testing.
Combining task selectors with command-line selectors:
Selectors from both the task frontmatter and command line are combined (additive):
# Task has: selectors.language = Go
# Command adds: -s priority=high
# Result: includes rules matching language=Go AND priority=high
coding-context -s priority=high implement-feature
Resume Mode
Resume mode is designed for continuing work on a task where you've already established context. When using the -r flag:
- Rules are skipped: All rule files are excluded from output, saving tokens and reducing context size
- Resume-specific task prompts are selected: Automatically adds
-s resume=trueselector to find task files withresume: truein their frontmatter
This is particularly useful in agentic workflows where an AI agent has already been primed with rules and is continuing work from a previous session.
The -r flag is shorthand for:
- Adding
-s resume=trueselector - Skipping all rules output
Example usage:
# Initial task invocation (includes all rules, uses task with resume: false)
coding-context -s resume=false fix-bug | ai-agent
# Resume the task (skips rules, uses task with resume: true)
coding-context -r fix-bug | ai-agent
Example task files for resume mode:
Initial task (.agents/tasks/fix-bug-initial.md):
---
task_name: fix-bug
resume: false
---
# Fix Bug
Analyze the issue and implement a fix.
Follow the coding standards and write tests.
Resume task (.agents/tasks/fix-bug-resume.md):
---
task_name: fix-bug
resume: true
---
# Fix Bug - Continue
Continue working on the bug fix.
Review your previous work and complete remaining tasks.
With this approach, you can have multiple task prompts for the same task name, differentiated by the resume frontmatter field. Use -s resume=false to select the initial task (with rules), or -r to select the resume task (without rules).
Rule Files
Rule files are Markdown (.md) or .mdc files, optionally with YAML frontmatter for filtering.
Example (.agents/rules/backend.md):
---
language: Go
---
# Backend Coding Standards
- All new code must be accompanied by unit tests.
- Use the standard logging library.
To include this rule only when working on Go code, you would use -s language=Go:
coding-context -s language=Go fix-bug
This will include all rules with language: Go in their frontmatter, excluding rules for other languages.
Example: Language-Specific Rules
You can create multiple language-specific rule files:
.agents/rules/python-standards.mdwithlanguage: Python.agents/rules/javascript-standards.mdwithlanguage: JavaScript.agents/rules/go-standards.mdwithlanguage: Go
Then select only the relevant rules:
# Work on Python code with Python-specific rules
coding-context -s language=Python fix-bug
# Work on JavaScript code with JavaScript-specific rules
coding-context -s language=JavaScript enhance-feature
Common Linguist Languages
When using language selectors, use the exact language names as defined by GitHub Linguist. Here are common languages with correct capitalization:
- C:
C - C#:
C# - C++:
C++ - CSS:
CSS - Dart:
Dart - Elixir:
Elixir - Go:
Go - Haskell:
Haskell - HTML:
HTML - Java:
Java - JavaScript:
JavaScript - Kotlin:
Kotlin - Lua:
Lua - Markdown:
Markdown - Objective-C:
Objective-C - PHP:
PHP - Python:
Python - Ruby:
Ruby - Rust:
Rust - Scala:
Scala - Shell:
Shell - Swift:
Swift - TypeScript:
TypeScript - YAML:
YAML
Note the capitalization - for example, use Go not go, JavaScript not javascript, and TypeScript not typescript.
Note: Frontmatter selectors can only match top-level YAML fields. For example:
- ✅ Works:
language: Gomatches-s language=Go - ❌ Doesn't work: Nested fields like
metadata.version: 1.0cannot be matched with-s metadata.version=1.0
If you need to filter on nested data, flatten your frontmatter structure to use top-level fields only.
Targeting a Specific Agent
When working with a specific AI coding agent, the agent itself will read its own configuration files. The -a flag lets you specify which agent you're using, automatically excluding that agent's specific rule paths while including rules from other agents and generic rules.
Supported agents:
cursor- Excludes.cursor/rules,.cursorrules; includes other agents and generic rulesopencode- Excludes.opencode/agent,.opencode/command; includes other agents and generic rulescopilot- Excludes.github/copilot-instructions.md,.github/agents; includes other agents and generic rulesclaude- Excludes.claude/,CLAUDE.md,CLAUDE.local.md; includes other agents and generic rulesgemini- Excludes.gemini/,GEMINI.md; includes other agents and generic rulesaugment- Excludes.augment/; includes other agents and generic ruleswindsurf- Excludes.windsurf/,.windsurfrules; includes other agents and generic rulescodex- Excludes.codex/,AGENTS.md; includes other agents and generic rules
Example: Using Cursor:
# When using Cursor, exclude .cursor/ and .cursorrules (Cursor reads those itself)
# But include rules from other agents and generic rules
coding-context -a cursor fix-bug
How it works:
- The
-aflag sets the target agent - The target agent's own paths are excluded (e.g.,
.cursor/for cursor) - Rules from other agents are included (e.g.,
.opencode/,.github/copilot-instructions.md) - Generic rules (from
.agents/rules) are always included - The agent name is automatically added as a selector, so generic rules can filter themselves with
agent: cursorin frontmatter
Example generic rule with agent filtering:
---
agent: cursor
---
# This rule only applies when using Cursor
Use Cursor-specific features...
Use cases:
- Avoid duplication: The agent reads its own config, so exclude it from the context
- Cross-agent rules: Include rules from other agents that might be relevant
- Generic rules: Always include generic rules, with optional agent-specific filtering
The exclusion happens before rule processing, so excluded paths are never loaded or counted toward token estimates.
Bootstrap Scripts
A bootstrap script is an executable file that has the same name as a rule or task file but with a -bootstrap suffix. These scripts are used to prepare the environment, for example by installing necessary tools. The output of these scripts is sent to stderr and is not part of the AI context.
Examples:
- Rule file:
.agents/rules/jira.md - Rule bootstrap script:
.agents/rules/jira-bootstrap - Task file:
.agents/tasks/fix-bug.md - Task bootstrap script:
.agents/tasks/fix-bug-bootstrap
Bootstrap scripts are executed in the following order:
- Rule bootstrap scripts run before their corresponding rule files are processed
- Task bootstrap scripts run after all rules are processed but before the task content is emitted
.agents/rules/jira-bootstrap:
#!/bin/bash
# This script installs the jira-cli if it's not already present.
if ! command -v jira-cli &> /dev/null
then
echo "Installing jira-cli..." >&2
# Add installation commands here
fi
.agents/tasks/fix-bug-bootstrap:
#!/bin/bash
# This script fetches the latest issue details before the task runs.
echo "Fetching issue information..." >&2
# Fetch and prepare issue data
Task Frontmatter
Task frontmatter is automatically included at the beginning of the output. This allows the AI agent or downstream tool to access metadata about the task being executed.
Example usage:
coding-context -p issue_number=123 fix-bug
Output format:
---
task_name: fix-bug
resume: false
---
# Fix Bug Task
Fix the bug in issue #123...
This can be useful for:
- Agent decision making: The AI can see metadata like priority, environment, or stage
- Workflow automation: Downstream tools can parse the frontmatter to make decisions
- Debugging: You can verify which task variant was selected and what selectors were applied
Example with selectors in frontmatter:
coding-context implement-feature
If the task has selectors in its frontmatter, they will be visible in the output:
---
task_name: implement-feature
selectors:
language: Go
stage: implementation
---
# Implementation Task
...
Documentation
¶
There is no documentation for this package.