You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-m <path> Directory containing memories, or a single memory file (can be used multiple times)
88
+
Default: AGENTS.md
89
+
-t <path> Directory containing tasks, or a single task file (can be used multiple times)
87
90
-o <directory> Output directory for generated files (default: .)
88
91
-p <key=value> Template parameter for prompt substitution (can be used multiple times)
89
92
-s <key=value> Include memories with matching frontmatter (can be used multiple times)
90
93
-S <key=value> Exclude memories with matching frontmatter (can be used multiple times)
91
94
```
92
95
96
+
**Important:** The task file name **MUST** match the task name you provide on the command line. For example, if you run `coding-context my-task`, the tool will look for `my-task.md` in the task directories.
@@ -131,6 +154,8 @@ Memory files are included in every generated context. They contain reusable info
131
154
132
155
Prompt files define specific tasks. They can use template variables (like `${taskName}` or `$taskName`) that you provide via command-line parameters.
133
156
157
+
**IMPORTANT:** The file name **MUST** match the task name you'll use on the command line. For example, a file named `my-task.md` is invoked with `coding-context my-task`.
158
+
134
159
```markdown
135
160
# Task: ${taskName}
136
161
@@ -183,6 +208,10 @@ Each directory should contain:
183
208
184
209
Markdown files with YAML frontmatter and Go template support.
185
210
211
+
**CRITICAL:** The prompt file name (without the `.md` extension) **MUST** exactly match the task name you provide on the command line. For example:
212
+
- To run `coding-context add-feature`, you need a file named `add-feature.md`
213
+
- To run `coding-context my-custom-task`, you need a file named `my-custom-task.md`
This will look for `add-feature.md` in the task directories.
228
+
198
229
### Memory Files
199
230
200
231
Markdown files included in every generated context. Bootstrap scripts can be provided in separate files.
@@ -218,6 +249,36 @@ npm install
218
249
219
250
For each memory file `<name>.md`, you can optionally create a corresponding `<name>-bootstrap` file that will be executed during setup.
220
251
252
+
### Supported Memory File Formats
253
+
254
+
This tool can work with various memory file formats used by popular AI coding assistants. By default, it looks for `AGENTS.md` in the current directory. You can also specify additional memory files or directories using the `-m` flag.
255
+
256
+
#### Common Memory File Names
257
+
258
+
The following memory file formats are commonly used by AI coding assistants and can be used with this tool:
# Combine default AGENTS.md with additional memories
277
+
coding-context -m .instructions.md my-task
278
+
```
279
+
280
+
**Note:** All memory files should be in Markdown format (`.md` extension) or contain Markdown-compatible content. The tool will automatically process frontmatter in YAML format if present.
0 commit comments